Skip to content

Latest commit

 

History

History
134 lines (93 loc) · 8.29 KB

README.md

File metadata and controls

134 lines (93 loc) · 8.29 KB

Underwriting

(underwriting)

Overview

Available Operations

  • get - Retrieve underwriting associated with a given Moov account.

Read our underwriting guide to learn more.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/profile.read scope.

  • upsert - Create or update the account's underwriting.

Read our underwriting guide to learn more.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/profile.write scope.

get

Retrieve underwriting associated with a given Moov account.

Read our underwriting guide to learn more.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/profile.read scope.

Example Usage

from moovio_sdk import Moov
from moovio_sdk.models import components


with Moov(
    security=components.Security(
        username="",
        password="",
    ),
) as moov:

    res = moov.underwriting.get(account_id="32ccafba-5d99-40e5-a8af-d05cc5d73a4e")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
account_id str ✔️ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.GetUnderwritingResponse

Errors

Error Type Status Code Content Type
errors.APIError 4XX, 5XX */*

upsert

Create or update the account's underwriting.

Read our underwriting guide to learn more.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/profile.write scope.

Example Usage

from moovio_sdk import Moov
from moovio_sdk.models import components


with Moov(
    security=components.Security(
        username="",
        password="",
    ),
) as moov:

    res = moov.underwriting.upsert(account_id="695bbe92-af8d-4cce-802f-ca871830906f", average_transaction_size=543422, max_transaction_size=470183, average_monthly_transaction_volume=390496, volume_by_customer_type={
        "business_to_business_percentage": 478438,
        "consumer_to_business_percentage": 232067,
    }, card_volume_distribution={
        "ecommerce_percentage": 766938,
        "card_present_percentage": 138671,
        "mail_or_phone_percentage": 146928,
        "debt_repayment_percentage": 114639,
    }, fulfillment={
        "has_physical_goods": False,
        "is_shipping_product": False,
        "shipment_duration_days": 5009,
        "return_policy": components.ReturnPolicyType.WITHIN_THIRTY_DAYS,
    })

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
account_id str ✔️ N/A
average_transaction_size int ✔️ N/A
max_transaction_size int ✔️ N/A
average_monthly_transaction_volume int ✔️ N/A
volume_by_customer_type components.VolumeByCustomerType ✔️ N/A
card_volume_distribution components.CardVolumeDistribution ✔️ N/A
fulfillment components.FulfillmentDetails ✔️ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.UpsertUnderwritingResponse

Errors

Error Type Status Code Content Type
errors.GenericError 400, 409 application/json
errors.UpdateUnderwritingError 422 application/json
errors.APIError 4XX, 5XX */*