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

Expand all

• objectstring

• account_holder_namenullable string

• account_holder_typenullable string

• account_typenullable string

• available_payout_methodsnullable array of enums

• customernullable stringExpandable

• fingerprintnullable string

• future_requirementsnullable object

• requirementsnullable object

When you create a new bank account, you must specify a connected account to create it on. You can only specify connected accounts where account.controller.requirement_collection is application (includes Custom accounts).

If the bank account’s owner has no other external account in the bank account’s currency, the new bank account will become the default for that currency. However, if the owner already has a bank account for that currency, the new account will become the default only if the default_for_currency parameter is set to true.

Parameters

• external_accountobject | stringRequired

  Either a token, like the ones returned by Stripe.js, or a dictionary containing a user’s bank account details (with the options shown below).

  Show child parameters

• metadataobject

  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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

More parameters

Expand all

• default_for_currencyboolean

Updates the metadata, account holder name, account holder type of a bank account belonging to a connected account and optionally sets it as the default for its currency. Other bank account details are not editable by design.

You can only update bank accounts when account.controller.requirement_collection is application, which includes Custom accounts.

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

Parameters

• default_for_currencyboolean

  When set to true, this becomes the default external account for its currency.

• metadataobject

  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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

More parameters

Expand all

• account_holder_namestring

• account_holder_typestring

• account_typestring

• documentsobject

By default, you can see the 10 most recent external accounts stored on a connected account directly on the object. You can also retrieve details about a specific bank account stored on the account.

Parameters

No parameters.