Updates the metadata, account holder name, account holder type of a bank account belonging to a connected account and optionally sets it as the default for its currency. Other bank account details are not editable by design.
You can only update bank accounts when account.controller.requirement_collection is application
, which includes Custom accounts.
You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.
Parameters
- default_
for_ currencyboolean When set to true, this becomes the default external account for its currency.
- 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
.
More 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
individual
orcompany
. - account_
typestring The bank account type. This can only be
checking
orsavings
in most countries. In Japan, this can only befutsu
ortoza
. - documentsobject
Documents that may be submitted to satisfy various informational requests.
- documents.
bank_ account_ ownership_ verificationobject One or more documents that support the Bank account ownership verification requirement. Must be a document associated with the bank account that displays the last 4 digits of the account number, either a statement or a check.
- documents.
bank_account_ownership_verification. filesarray of strings One or more document ids returned by a file upload with a
purpose
value ofaccount_
.requirement
Returns
Returns the bank account object.
{ "id": "ba_1NAiwl2eZvKYlo2CRdCLZSxO", "object": "bank_account", "account_holder_name": "Jane Austen", "account_holder_type": "company", "account_type": null, "bank_name": "STRIPE TEST BANK", "country": "US", "currency": "usd", "fingerprint": "1JWtPxqbdX5Gamtc", "last4": "6789", "metadata": { "order_id": "6735" }, "routing_number": "110000000", "status": "new"}