Retrieve underwriting details
To use this endpoint from the browser, you’ll need to specify the
/accounts/{accountID}/profile.read scope when generating a token.
GET
/accounts/{accountID}/underwriting
Underwriting details successfully retrieved
Describes underwriting values (in USD) used for card payment acceptance
{
"averageMonthlyTransactionVolume": 250000,
"averageTransactionSize": 10000,
"cardVolumeDistribution": {
"cardPresentPercentagePercentage": 20,
"debtRepaymentPercentage": 20,
"ecommercePercentage": 20,
"mailOrPhonePercentage": 20
},
"fulfillment": {
"hasPhysicalGoods": true,
"isShippingProduct": true,
"returnPolicy": "none",
"shipmentDurationDays": 7
},
"maxTransactionSize": 50000,
"status": "approved",
"volumeByCustomerType": {
"businessToBusinessPercentage": 20,
"consumerToBusinessPercentage": 20
}
}Empty response for unauthorized or any other returned http status code.
Path parameters
accountID
string
<uuid>
required
ID of the account.
Response
application/json
averageMonthlyTransactionVolume
integer<int64>
averageTransactionSize
integer<int64>
cardVolumeDistribution
object
Show child attributes
cardPresentPercentagePercentage
integer<int64>
debtRepaymentPercentage
integer<int64>
ecommercePercentage
integer<int64>
mailOrPhonePercentage
integer<int64>
fulfillment
object
Show child attributes
hasPhysicalGoods
boolean
isShippingProduct
boolean
returnPolicy
string<enum>
Describes the return policy.
Possible values:
none,
exchangeOnly,
withinThirtyDays,
other
shipmentDurationDays
integer<int64>
maxTransactionSize
integer<int64>
status
string<enum>
deprecated
This field is deprecated and will be removed in a future release.
Possible values:
approved,
rejected,
pendingReview,
pending,
notRequested
volumeByCustomerType
object
Show child attributes
businessToBusinessPercentage
integer<int64>
consumerToBusinessPercentage
integer<int64>