/v1/accounts/{account}/bank_accountsCreate an external account
Creates an external account (bank account or debit card) for a given account. Supply either a token from Stripe.js or a dictionary containing bank account details. The created account can be set as the default for its currency.
- IdempotentThe SDK sends
Idempotency-Key, so a retried request is only applied once.
The unique identifier of the account to add the external account to.
External account details. Supply either a token or a dictionary with bank account information.
Either a token, like the ones returned by Stripe.js, or a dictionary containing a user's bank account details.
When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency.
Specifies which fields in the response should be expanded.
A token, like the ones returned by Stripe.js or a dictionary containing a user's external account details (with the options shown below). Please refer to full documentation instead.
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.
The account this bank account belongs to. Only applicable on Accounts (not customers or recipients) This property is only available when returned as an External Account where controller.is_controller is true.
The name of the person or business that owns the bank account.
The type of entity that holds the account. This can be either individual or company.
The bank account type. This can only be checking or savings in most countries. In Japan, this can only be futsu or toza.
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.
Name of the bank associated with the routing number (e.g., WELLS FARGO).
Two-letter ISO code representing the country the bank account is located in.
Three-letter ISO code for the currency paid out to the bank account.
The ID of the customer that the bank account is associated with.
Whether this bank account is the default external account for its currency.
Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
Information about the upcoming new requirements for the bank account, including what information needs to be collected, and by when.
Unique identifier for the object.
The last four digits of the bank account number.
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.
String representing the object's type. Objects of the same type share the same value.
Information about the requirements for the bank account, including what information needs to be collected.
The routing transit number for the bank account.
For bank accounts, possible values are new, validated, verified, verification_failed, tokenized_account_number_deactivated 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 the status is tokenized_account_number_deactivated, the account utilizes a tokenized account number which has been deactivated due to expiration or revocation. This account will need to be reverified to continue using it for money movement. 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, verification_failed, and tokenized_account_number_deactivated. 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.
account must identify an existing connected account. When providing bank_account as a dictionary, account_number and country are required. bank_account and external_account are mutually exclusive — supply only one.