Customers
get/v1/customers/{customer}/bank_accounts

List all bank accounts

You can see a list of the bank accounts belonging to a Customer. Note that the 10 most recent sources are always available by default on the Customer. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional bank accounts.

Path parameters

NameDescription
customer*

Query parameters

NameDescription
ending_beforeA cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
expandSpecifies which fields in the response should be expanded.
limitA limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_afterA cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Request body

object (no properties in spec)

Response

FieldTypeDescription
data*array<bank_account>

Details about each object.

array item fields
FieldTypeDescription
accountstring | account

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.

account_holder_namestring

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

account_holder_typestring

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

account_typestring

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_methodsarray<string>

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.

bank_namestring

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

country*string

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

currency*string (currency)

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

customerstring | customer | deleted_customer

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

default_for_currencyboolean

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

fingerprintstring

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

future_requirementsexternal_account_requirements

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

id*string

Unique identifier for the object.

last4*string

The last four digits of the bank account number.

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.

object*string

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

requirementsexternal_account_requirements

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

routing_numberstring

The routing transit number for the bank account.

status*string

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.

has_more*boolean

True if this list has another page of items after this one that can be fetched.

object*string

String representing the object's type. Objects of the same type share the same value. Always has the value list.

url*string

The URL where this list can be accessed.