Bank Accounts
These bank accounts are payment methods on Customer objects.
On the other hand External Accounts are transfer destinations on Account objects for accounts where controller.requirement_collection is application, which includes Custom accounts. They can be bank accounts or debit cards as well, and are documented in the links above.
Related guide: Bank debits and transfers
The Bank Account object
Attributes
- idstring
Unique identifier for the object.
- 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
individualorcompany. - 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.
- 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.
- 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.
More attributes
- objectstring
- accountnullable stringExpandable
- account_
typenullable string - available_
payout_ methodsnullable array of enums - statusstring
Create a bank account
When you create a new bank account, you must specify a Customer object on which to create it.
Parameters
- sourceobject | 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).
- 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.
Returns
Returns the bank account object.
Update a bank account
Updates the account_holder_name, account_holder_type, and metadata of a bank account belonging to a customer. Other bank account details are not editable, by design.
Parameters
- 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
individualorcompany. - 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.
Returns
Returns the bank account object.
Retrieve a bank account
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.
Parameters
No parameters.
Returns
Returns the bank account object.