Retrieve a bank account

Changed on

By default, you can see the 10 most recent sources stored on a Customer directly on the object, but you can also retrieve details about a specific bank account stored on the Stripe account.

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

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/customers/{customer}/bank_accounts/{id}
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Path parameters

customerstring required
idstring required

Query parameters

expandstring[]

Specifies which fields in the response should be expanded.

Request body application/x-www-form-urlencoded

object required

Response

Successful response.

account_holder_namestring nullable

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

account_holder_typestring nullable

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

account_typestring nullable

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_methodsstring[] nullable

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 nullable

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

countrystring required

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

currencystring currency required

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

default_for_currencyboolean nullable

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

fingerprintstring nullable

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

idstring required

Unique identifier for the object.

last4string required

The last four digits of the bank account number.

metadataobject nullable

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'bank_account' required

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

routing_numberstring nullable

The routing transit number for the bank account.

statusstring required

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.

Changes

  • 585b581504aeRevision changes
    • warning

      added the new final_payment_failure enum value to the //////// response property for the response status

    • warning

      added the new first_payment_failure enum value to the //////// response property for the response status

  • 7537419124b6Revision changes
    • info

      added the optional property ///// to the response with the status

Some revisions have not been checked yet.