Attributes
- idstring
The identifier for the capability.
- accountstringExpandable
The account for which the capability enables functionality.
- requestedboolean
Whether the capability has been requested.
- requirementsobject
Information about the requirements for the capability, including what information needs to be collected, and by when.
- requirements.
alternativesnullable array of objects Fields that are due and can be satisfied by providing the corresponding alternative fields instead.
- requirements.
alternatives. alternative_ fields_ duearray of strings Fields that can be provided to satisfy all fields in
original_
.fields_ due - requirements.
alternatives. original_ fields_ duearray of strings Fields that are due and can be satisfied by providing all fields in
alternative_
.fields_ due
- requirements.
current_ deadlinenullable timestamp The date by which all required account information must be both submitted and verified. This includes fields listed in
currently_
as well as those indue pending_
. If any required information is missing or unverified by this date, the account may be disabled. Note thatverification current_
may change if additionaldeadline currently_
requirements are requested.due - requirements.
currently_ duearray of strings Fields that need to be collected to keep the capability enabled. If not collected by
current_
, these fields appear indeadline past_
as well, and the capability is disabled.due - requirements.
disabled_ reasonnullable enum Description of why the capability is disabled. Learn more about handling verification issues.
Possible enum valuesother
The capability has been disabled for another reason. Visit Accounts to review to learn more.
paused.
inactivity The capability has been paused for inactivity.
pending.
onboarding The capability is pending onboarding.
pending.
review The capability is pending review.
platform_
disabled The capability has been disabled by the platform.
platform_
paused The capability has been paused by the platform.
rejected.
inactivity The capability has been rejected for inactivity. This disabled reason currently only applies to the Issuing capability. See Issuing: Managing Inactive Connects for more details.
rejected.
other The capability has been rejected for another reason. Visit Accounts to review to learn more.
rejected.
unsupported_ business 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, such as in Afterpay Clearpay’s terms of service. If you believe that a rejection is in error, please contact support for assistance.
requirements.
fields_ needed The capability requires more information.
- requirements.
errorsarray of objects Fields that are
currently_
and need to be collected again because validation or verification failed.due - requirements.
errors. codeenum The code for the type of error.
Possible enum valuesinformation_
missing The requirement associated with this error is missing critical information. The associated error reason provides more details.
invalid_
address_ city_ state_ postal_ code The combination of the city, state, and postal code in the provided address could not be validated.
invalid_
address_ highway_ contract_ box Invalid address. Your business address must be a valid physical address from which you conduct business and cannot be a Highway Contract Box.
invalid_
address_ private_ mailbox Invalid address. Your business address must be a valid physical address from which you conduct business and cannot be a private mailbox.
invalid_
business_ profile_ name Business profile names must consist of recognizable words.
invalid_
business_ profile_ name_ denylisted Generic or well-known business names aren’t supported.
invalid_
company_ name_ denylisted Generic or well-known business names aren’t supported.
invalid_
dob_ age_ over_ maximum Date of birth must be within the past 120 years.
invalid_
dob_ age_ under_ 18 Underage. Age must be at least 18.
invalid_
dob_ age_ under_ minimum Person must be at least 13 years old.
Show 84 more - requirements.
errors. reasonstring An informative message that indicates the error type and provides additional details about the error.
- requirements.
errors. requirementstring The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
- requirements.
eventually_ duearray of strings Fields you must collect when all thresholds are reached. As they become required, they appear in
currently_
as well, anddue current_
becomes set.deadline - requirements.
past_ duearray of strings Fields that weren’t collected by
current_
. These fields need to be collected to enable the capability on the account.deadline - requirements.
pending_ verificationarray of strings Fields that might become required depending on the results of verification or review. It’s an empty array unless an asynchronous verification is pending. If verification fails, these fields move to
eventually_
,due currently_
, ordue past_
. Fields might appear indue eventually_
,due currently_
, ordue past_
and indue pending_
if verification fails but another verification is still pending.verification
- statusenum
The status of the capability.
Possible enum valuesactive
The capability is active.
inactive
The capability is inactive.
pending
The capability is inactive with requirements pending verification.
unrequested
The capability is unrequested.
More attributes
- objectstring
String representing the object’s type. Objects of the same type share the same value.
- future_
requirementsobject Information about the upcoming new requirements for the capability, including what information needs to be collected, and by when.
- future_requirements.
alternativesnullable array of objects Fields that are due and can be satisfied by providing the corresponding alternative fields instead.
- future_requirements.
alternatives. alternative_ fields_ duearray of strings Fields that can be provided to satisfy all fields in
original_
.fields_ due - future_requirements.
alternatives. original_ fields_ duearray of strings Fields that are due and can be satisfied by providing all fields in
alternative_
.fields_ due
- future_requirements.
current_ deadlinenullable timestamp Date on which
future_
becomes the mainrequirements requirements
hash andfuture_
becomes empty. After the transition,requirements currently_
requirements may immediately becomedue past_
, but the account may also be given a grace period depending on the capability’s enablement state prior to transitioning.due - future_requirements.
currently_ duearray of strings Fields that need to be collected to keep the capability enabled. If not collected by
future_
, these fields will transition to the mainrequirements[current_ deadline] requirements
hash. - future_requirements.
disabled_ reasonnullable enum This is typed as an enum for consistency with
requirements.
, but it safe to assumedisabled_ reason future_
is null because fields inrequirements. disabled_ reason future_
will never disable the account.requirements Possible enum valuesother
The capability has been disabled for another reason. Visit Accounts to review to learn more.
paused.
inactivity The capability has been paused for inactivity.
pending.
onboarding The capability is pending onboarding.
pending.
review The capability is pending review.
platform_
disabled The capability has been disabled by the platform.
platform_
paused The capability has been paused by the platform.
rejected.
inactivity The capability has been rejected for inactivity. This disabled reason currently only applies to the Issuing capability. See Issuing: Managing Inactive Connects for more details.
rejected.
other The capability has been rejected for another reason. Visit Accounts to review to learn more.
rejected.
unsupported_ business 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, such as in Afterpay Clearpay’s terms of service. If you believe that a rejection is in error, please contact support for assistance.
requirements.
fields_ needed The capability requires more information.
- future_requirements.
errorsarray of objects Fields that are
currently_
and need to be collected again because validation or verification failed.due - future_requirements.
errors. codeenum The code for the type of error.
Possible enum valuesinformation_
missing The requirement associated with this error is missing critical information. The associated error reason provides more details.
invalid_
address_ city_ state_ postal_ code The combination of the city, state, and postal code in the provided address could not be validated.
invalid_
address_ highway_ contract_ box Invalid address. Your business address must be a valid physical address from which you conduct business and cannot be a Highway Contract Box.
invalid_
address_ private_ mailbox Invalid address. Your business address must be a valid physical address from which you conduct business and cannot be a private mailbox.
invalid_
business_ profile_ name Business profile names must consist of recognizable words.
invalid_
business_ profile_ name_ denylisted Generic or well-known business names aren’t supported.
invalid_
company_ name_ denylisted Generic or well-known business names aren’t supported.
invalid_
dob_ age_ over_ maximum Date of birth must be within the past 120 years.
invalid_
dob_ age_ under_ 18 Underage. Age must be at least 18.
invalid_
dob_ age_ under_ minimum Person must be at least 13 years old.
Show 84 more - future_requirements.
errors. reasonstring An informative message that indicates the error type and provides additional details about the error.
- future_requirements.
errors. requirementstring The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
- future_requirements.
eventually_ duearray of strings Fields you must collect when all thresholds are reached. As they become required, they appear in
currently_
as well.due - future_requirements.
past_ duearray of strings Fields that weren’t collected by
requirements.
. These fields need to be collected to enable the capability on the account. New fields will never appear here;current_ deadline future_
will always be a subset ofrequirements. past_ due requirements.
.past_ due - future_requirements.
pending_ verificationarray of strings Fields that might become required depending on the results of verification or review. It’s an empty array unless an asynchronous verification is pending. If verification fails, these fields move to
eventually_
ordue currently_
. Fields might appear indue eventually_
ordue currently_
and indue pending_
if verification fails but another verification is still pending.verification
- requested_
atnullable timestamp Time at which the capability was requested. Measured in seconds since the Unix epoch.
{ "id": "card_payments", "object": "capability", "account": "acct_1032D82eZvKYlo2C", "future_requirements": { "alternatives": [], "current_deadline": null, "currently_due": [], "disabled_reason": null, "errors": [], "eventually_due": [], "past_due": [], "pending_verification": [] }, "requested": true, "requested_at": 1688491010, "requirements": { "alternatives": [], "current_deadline": null, "currently_due": [], "disabled_reason": null, "errors": [], "eventually_due": [], "past_due": [], "pending_verification": [] }, "status": "inactive"}