Skip to main content
Schema2020-08-27object

account_capability_requirements

Source
openapi/spec3.json
Commit
d70de345383d
Active snapshot
da69df7e6e11

AccountCapabilityRequirements

object
alternatives array
optionalnullable

Fields that are due and can be satisfied by providing the corresponding alternative fields instead.

current_deadline integer (unix-time)
optionalnullable

Date by which the fields in `currently_due` must be collected to keep the capability enabled for the account. These fields may disable the capability sooner if the next threshold is reached before they are collected.

currently_due array
required

Fields that need to be collected to keep the capability enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the capability is disabled.

disabled_reason string
optionalnullable

If the capability is disabled, this string describes why. Can be `requirements.past_due`, `requirements.pending_verification`, `listed`, `platform_paused`, `rejected.fraud`, `rejected.listed`, `rejected.terms_of_service`, `rejected.other`, `under_review`, or `other`. `rejected.unsupported_business` means that the account's business is not supported by the capability. For example, payment methods may restrict the businesses they support in their terms of service: - [Afterpay Clearpay's terms of service](/a…

errors array
required

Fields that are `currently_due` and need to be collected again because validation or verification failed.

eventually_due array
required

Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set.

past_due array
required

Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the capability on the account.

pending_verification array
required

Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`.