Attributes
- idstring
Unique identifier for the object.
- accountnullable stringExpandableAvailable conditionally
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
. - 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_
, orfailed errored
. A bank account that hasn’t had any activity or validation performed isnew
. If Stripe can determine that the bank account exists, its status will bevalidated
. 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 beverified
. If the verification failed for any reason, such as microdeposit failure, the status will beverification_
. If a payout sent to this bank account fails, we’ll set the status tofailed errored
and will not continue to send scheduled payouts until the bank details are updated.For external accounts, possible values are
new
,errored
andverification_
. If a payout fails, the status is set tofailed 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 toverification_
. Other validations aren’t run against external accounts because they’re only used for payouts. This means the other statuses don’t apply.failed
More attributes
- 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
orcompany
. - account_
typenullable string The bank account type. This can only be
checking
orsavings
in most countries. In Japan, this can only befutsu
ortoza
. - 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 valuesinstant
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.
- future_requirements.
currently_ duenullable array of strings Fields that need to be collected to keep the external account enabled. If not collected by
current_
, these fields appear indeadline past_
as well, and the account is disabled.due - future_requirements.
errorsnullable array of objects Fields that are
currently_
and need to be collected again because validation or verification failed.due - future_requirements.
errors. codeenum The code for the type of error.
Possible enum valuesinformation_
missing The requirement associated with this error is missing critical information. The associated error reason provides more details.
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.
Show 84 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_
. These fields need to be collected to enable the external account.deadline - 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_
, ordue past_
. Fields might appear indue eventually_
,due currently_
, ordue past_
and indue pending_
if verification fails but another verification is still pending.verification
- requirementsnullable object
Information about the requirements for the bank account, including what information needs to be collected.
- requirements.
currently_ duenullable array of strings Fields that need to be collected to keep the external account enabled. If not collected by
current_
, these fields appear indeadline past_
as well, and the account is disabled.due - requirements.
errorsnullable array of objects Fields that are
currently_
and need to be collected again because validation or verification failed.due - requirements.
errors. codeenum The code for the type of error.
Possible enum valuesinformation_
missing The requirement associated with this error is missing critical information. The associated error reason provides more details.
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.
Show 84 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_
. These fields need to be collected to enable the external account.deadline - 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_
, ordue past_
. Fields might appear indue eventually_
,due currently_
, ordue past_
and indue pending_
if verification fails but another verification is still pending.verification
{ "id": "ba_1N9DrD2eZvKYlo2C58f4DaIa", "object": "bank_account", "account": "acct_1032D82eZvKYlo2C", "account_holder_name": "Jane Austen", "account_holder_type": "individual", "account_type": null, "available_payout_methods": [ "standard" ], "bank_name": "STRIPE TEST BANK", "country": "US", "currency": "usd", "fingerprint": "1JWtPxqbdX5Gamtz", "last4": "6789", "metadata": {}, "routing_number": "110000000", "status": "new"}