Update underwriting details
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.
PUT
/accounts/{accountID}/underwriting
|
|
|
|
|
|
|
|
|
|
The request completed successfully.
{
"description": "Describes underwriting values (in USD) used for card payment acceptance.",
"properties": {
"averageMonthlyTransactionVolume": {
"format": "int64",
"type": "integer"
},
"averageTransactionSize": {
"format": "int64",
"type": "integer"
},
"cardVolumeDistribution": {
"properties": {
"cardPresentPercentage": {
"format": "int32",
"type": "integer"
},
"debtRepaymentPercentage": {
"format": "int32",
"type": "integer"
},
"ecommercePercentage": {
"format": "int32",
"type": "integer"
},
"mailOrPhonePercentage": {
"format": "int32",
"type": "integer"
}
},
"required": [
"ecommercePercentage",
"cardPresentPercentage",
"mailOrPhonePercentage",
"debtRepaymentPercentage"
],
"type": "object"
},
"fulfillment": {
"properties": {
"hasPhysicalGoods": {
"type": "boolean"
},
"isShippingProduct": {
"type": "boolean"
},
"returnPolicy": {
"enum": [
"none",
"exchangeOnly",
"withinThirtyDays",
"other"
],
"type": "string"
},
"shipmentDurationDays": {
"format": "int64",
"type": "integer"
}
},
"required": [
"hasPhysicalGoods",
"isShippingProduct",
"shipmentDurationDays",
"returnPolicy"
],
"type": "object"
},
"maxTransactionSize": {
"format": "int64",
"type": "integer"
},
"status": {
"deprecated": true,
"enum": [
"approved",
"rejected",
"pendingReview",
"pending",
"notRequested"
],
"type": "string"
},
"volumeByCustomerType": {
"properties": {
"businessToBusinessPercentage": {
"format": "int32",
"type": "integer"
},
"consumerToBusinessPercentage": {
"format": "int32",
"type": "integer"
}
},
"required": [
"businessToBusinessPercentage",
"consumerToBusinessPercentage"
],
"type": "object"
}
},
"required": [
"averageTransactionSize",
"maxTransactionSize",
"averageMonthlyTransactionVolume",
"status",
"volumeByCustomerType",
"cardVolumeDistribution",
"fulfillment"
],
"type": "object"
}
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
The server could not understand the request due to invalid syntax.
{
"properties": {
"error": {
"type": "string"
}
},
"required": [
"error"
],
"type": "object"
}
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
The request contained missing or expired authentication.
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
The user is not authorized to make the request.
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
The requested resource was not found.
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
The request conflicted with the current state of the target resource.
{
"properties": {
"error": {
"type": "string"
}
},
"required": [
"error"
],
"type": "object"
}
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
The request was well-formed, but the contents failed validation. Check the request for missing or invalid fields.
{
"properties": {
"error": {
"properties": {
"averageMonthlyTransactionVolume": {
"type": "string"
},
"averageTransactionSize": {
"type": "string"
},
"cardVolumeDistribution": {
"properties": {
"cardPresentPercentage": {
"type": "string"
},
"debtRepaymentPercentage": {
"type": "string"
},
"ecommercePercentage": {
"type": "string"
},
"mailOrPhonePercentage": {
"type": "string"
}
},
"type": "object"
},
"fulfillment": {
"properties": {
"returnPolicy": {
"type": "string"
},
"shipmentDurationDays": {
"type": "string"
}
},
"type": "object"
},
"maxTransactionSize": {
"type": "string"
},
"volumeByCustomerType": {
"properties": {
"businessToBusinessPercentage": {
"type": "string"
},
"consumerToBusinessPercentage": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"error"
],
"type": "object"
}
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
Request was refused due to rate limiting.
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
The request failed due to an unexpected error.
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
The request failed because a downstream service failed to respond.
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
Headers
x-moov-version
string
API version
Specify an API version.
API versioning follows the format vYYYY.QQ.BB
, where
YYYY
is the yearQQ
is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)BB
is the build number, starting at.01
, for subsequent builds in the same quarter.- For example,
v2024.01.00
is the initial release of the first quarter of 2024.
- For example,
The latest
version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
Default:
v2024.01.00
Path parameters
accountID
string
<uuid>
required
Body
application/json
averageMonthlyTransactionVolume
integer<int64>
required
averageTransactionSize
integer<int64>
required
cardVolumeDistribution
object
required
Show child attributes
cardPresentPercentage
integer<int32>
required
debtRepaymentPercentage
integer<int32>
required
ecommercePercentage
integer<int32>
required
mailOrPhonePercentage
integer<int32>
required
fulfillment
object
required
Show child attributes
hasPhysicalGoods
boolean
required
isShippingProduct
boolean
required
returnPolicy
string<enum>
required
Possible values:
none
,
exchangeOnly
,
withinThirtyDays
,
other
shipmentDurationDays
integer<int64>
required
maxTransactionSize
integer<int64>
required
volumeByCustomerType
object
required
Show child attributes
businessToBusinessPercentage
integer<int32>
required
consumerToBusinessPercentage
integer<int32>
required
Response
application/json
averageMonthlyTransactionVolume
integer<int64>
required
averageTransactionSize
integer<int64>
required
cardVolumeDistribution
object
required
Show child attributes
cardPresentPercentage
integer<int32>
required
debtRepaymentPercentage
integer<int32>
required
ecommercePercentage
integer<int32>
required
mailOrPhonePercentage
integer<int32>
required
fulfillment
object
required
Show child attributes
hasPhysicalGoods
boolean
required
isShippingProduct
boolean
required
returnPolicy
string<enum>
required
Possible values:
none
,
exchangeOnly
,
withinThirtyDays
,
other
shipmentDurationDays
integer<int64>
required
maxTransactionSize
integer<int64>
required
status
string<enum>
required
deprecated
Possible values:
approved
,
rejected
,
pendingReview
,
pending
,
notRequested
volumeByCustomerType
object
required
Show child attributes
businessToBusinessPercentage
integer<int32>
required
consumerToBusinessPercentage
integer<int32>
required