GET
/v1/customers/{customer}/bank_accountsDeprecatedList customer bank accounts
Lists the bank accounts belonging to a customer. Use limit with starting_after or ending_before to page through accounts beyond the 10 most recent sources shown directly on the customer.
- RetriesRetries up to 2×, 500ms backoff, 30s timeout.
customerstringrequired
The unique identifier of the customer whose bank accounts to list; the value must be no longer than 5,000 characters.
ending_beforestringoptional
An object ID cursor that returns the page of results before the specified bank account.
expandarray<string>optional
Specifies response fields to expand; each expansion value must be no longer than 5,000 characters.
limitintegeroptional
The number of bank accounts to return, from 1 to 100. Defaults to 10 when omitted.
starting_afterstringoptional
An object ID cursor that returns the page of results after the specified bank account.
200Returns a list object containing bank accounts in `data`, a `has_more` pagination flag, the `list` object type, and the list `url`.
dataarray<BankAccount>required
Details about each object.
has_morebooleanrequired
True if this list has another page of items after this one that can be fetched.
objectstringrequired
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
urlstringrequired
The URL where this list can be accessed.
defaultReturned when the API cannot process the request and provides an error object.
errorobjectrequired
Error handling
customer must identify the customer whose bank accounts you want to list. limit must be between 1 and 100, and use an account object ID with starting_after or ending_before for cursor pagination.