The Capability object 

Connect
Capabilities
The Capability object

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_due as well as those in pending_verification. If any required information is missing or unverified by this date, the account may be disabled. Note that current_deadline may change if additional currently_due requirements are requested.

    • requirements.currently_duearray of strings

      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.

    • requirements.disabled_reasonnullable enum

      Description of why the capability is disabled. Learn more about handling verification issues.

      Possible enum values
      other

      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_due and need to be collected again because validation or verification failed.

      • requirements.errors.codeenum

        The code for the type of error.

        Possible enum values
        information_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_due as well, and current_deadline becomes set.

    • requirements.past_duearray of strings

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

    • 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_due, or past_due. Fields might appear in eventually_due, currently_due, or past_due and in pending_verification if verification fails but another verification is still pending.

  • statusenum

    The status of the capability.

    Possible enum values
    active

    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_requirements becomes the main requirements hash and future_requirements becomes empty. After the transition, currently_due requirements may immediately become past_due, but the account may also be given a grace period depending on the capability’s enablement state prior to transitioning.

    • future_requirements.currently_duearray of strings

      Fields that need to be collected to keep the capability enabled. If not collected by future_requirements[current_deadline], these fields will transition to the main requirements hash.

    • future_requirements.disabled_reasonnullable enum

      This is typed as an enum for consistency with requirements.disabled_reason, but it safe to assume future_requirements.disabled_reason is null because fields in future_requirements will never disable the account.

      Possible enum values
      other

      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_due and need to be collected again because validation or verification failed.

      • future_requirements.errors.codeenum

        The code for the type of error.

        Possible enum values
        information_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_due as well.

    • future_requirements.past_duearray of strings

      Fields that weren’t collected by requirements.current_deadline. These fields need to be collected to enable the capability on the account. New fields will never appear here; future_requirements.past_due will always be a subset of 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_due or currently_due. Fields might appear in eventually_due or currently_due and in pending_verification if verification fails but another verification is still pending.

  • requested_atnullable timestamp

    Time at which the capability was requested. Measured in seconds since the Unix epoch.

The Capability object
{
"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"
}