The External Bank Account object 

Attributes

• idstring

  Unique identifier for the object.

• accountnullable stringExpandable

  The ID of the account that the bank account is associated with.

• bank_namenullable string

  Name of the bank associated with the routing number (e.g., WELLS FARGO).

• countrystring

  Two-letter ISO code representing the country the bank account is located in.

• currencyenum

  Three-letter ISO code for the currency paid out to the bank account.

• default_for_currencynullable boolean

  Whether this bank account is the default external account for its currency.

• last4string

  The last four digits of the bank account number.

• metadatanullable object

  Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

• routing_numbernullable string

  The routing transit number for the bank account.

• statusstring

  For bank accounts, possible values are new, validated, verified, verification_failed, or errored. A bank account that hasn’t had any activity or validation performed is new. If Stripe can determine that the bank account exists, its status will be validated. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be verified. If the verification failed for any reason, such as microdeposit failure, the status will be verification_failed. If a payout sent to this bank account fails, we’ll set the status to errored and will not continue to send scheduled payouts until the bank details are updated.

  For external accounts, possible values are new, errored and verification_failed. If a payout fails, the status is set to errored and scheduled payouts are stopped until account details are updated. In the US and India, if we can’t verify the owner of the bank account, we’ll set the status to verification_failed. Other validations aren’t run against external accounts because they’re only used for payouts. This means the other statuses don’t apply.

More attributes

Collapse all

• objectstring

  String representing the object’s type. Objects of the same type share the same value.

• account_holder_namenullable string

  The name of the person or business that owns the bank account.

• account_holder_typenullable string

  The type of entity that holds the account. This can be either individual or company.

• account_typenullable string

  The bank account type. This can only be checking or savings in most countries. In Japan, this can only be futsu or toza.

• available_payout_methodsnullable array of enums

  A set of available payout methods for this bank account. Only values from this set should be passed as the method when creating a payout.

  Possible enum values

  instant

  standard

• customernullable stringExpandable

  The ID of the customer that the bank account is associated with.

• fingerprintnullable string

  Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.

• future_requirementsnullable object

  Information about the upcoming new requirements for the bank account, including what information needs to be collected, and by when.

  Hide child attributes

  • future_requirements.currently_duenullable array of strings

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

  • future_requirements.errorsnullable array of objects

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

    Hide child attributes

    • future_requirements.errors.codeenum

      The code for the type of error.

      Possible enum values

      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.

      invalid_product_description_length Your product description must be at least 10 characters.

      Show 79 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.past_duenullable array of strings

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

  • future_requirements.pending_verificationnullable array 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.

• requirementsnullable object

  Information about the requirements for the bank account, including what information needs to be collected.

  Hide child attributes

  • requirements.currently_duenullable array of strings

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

  • requirements.errorsnullable array of objects

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

    Hide child attributes

    • requirements.errors.codeenum

      The code for the type of error.

      Possible enum values

      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.

      invalid_product_description_length Your product description must be at least 10 characters.

      Show 79 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.past_duenullable array of strings

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

  • requirements.pending_verificationnullable array 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.