Properties
| Name | Type | Description |
|---|---|---|
| allowPayout | boolean | Indicates whether payouts are allowed. This field is the overarching payout status, and is the aggregate of multiple conditions (e.g., KYC status, disabled flag, etc). If this field is false, no payou |
| disableReason | string | The reason why payouts (to all of the account holder's accounts) have been disabled (by the platform). If the `disabled` field is true, this field can be used to explain why. |
| disabled | boolean | Indicates whether payouts have been disabled (by the platform) for all of the account holder's accounts. A platform may enable and disable this field at their discretion. If this field is true, `allow |
| notAllowedReason | string | The reason why payouts (to all of the account holder's accounts) have been disabled (by Adyen). If payouts have been disabled by Adyen, this field will explain why. If this field is blank, payouts hav |
| payoutLimit | object | The maximum amount that payouts are limited to. Only applies if payouts are allowed but limited. |
| tierNumber | integer | The payout tier that the account holder occupies. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/AccountPayoutState",
"title": "AccountPayoutState",
"properties": {
"allowPayout": {
"description": "Indicates whether payouts are allowed. This field is the overarching payout status, and is the aggregate of multiple conditions (e.g., KYC status, disabled flag, etc). If this field is false, no payouts will be permitted for any of the account holder's accounts. If this field is true, payouts will be permitted for any of the account holder's accounts.",
"type": "boolean"
},
"disableReason": {
"description": "The reason why payouts (to all of the account holder's accounts) have been disabled (by the platform). If the `disabled` field is true, this field can be used to explain why.",
"type": "string"
},
"disabled": {
"description": "Indicates whether payouts have been disabled (by the platform) for all of the account holder's accounts. A platform may enable and disable this field at their discretion. If this field is true, `allowPayout` will be false and no payouts will be permitted for any of the account holder's accounts. If this field is false, `allowPayout` may or may not be enabled, depending on other factors.",
"type": "boolean"
},
"notAllowedReason": {
"x-addedInVersion": "5",
"description": "The reason why payouts (to all of the account holder's accounts) have been disabled (by Adyen). If payouts have been disabled by Adyen, this field will explain why. If this field is blank, payouts have not been disabled by Adyen.",
"type": "string"
},
"payoutLimit": {
"description": "The maximum amount that payouts are limited to. Only applies if payouts are allowed but limited.",
"$ref": "#/components/schemas/Amount"
},
"tierNumber": {
"x-addedInVersion": "3",
"description": "The payout tier that the account holder occupies.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
}