Returns a list of Financial Connections Account
objects.
Parameters
- account_
holderobject If present, only return accounts that belong to the specified account holder.
account_
andholder[customer] account_
are mutually exclusive.holder[account] - account_holder.
accountstring The ID of the Stripe account whose accounts will be retrieved.
- account_holder.
customerstring The ID of the Stripe customer whose accounts will be retrieved.
- sessionstring
If present, only return accounts that were collected as part of the given session.
More parameters
- ending_
beforestring A cursor for use in pagination.
ending_
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withbefore obj_
, your subsequent call can includebar ending_
in order to fetch the previous page of the list.before=obj_ bar - limitinteger
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_
afterstring A cursor for use in pagination.
starting_
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withafter obj_
, your subsequent call can includefoo starting_
in order to fetch the next page of the list.after=obj_ foo
Returns
A dictionary with a data
property that contains an array of up to limit
Account
objects, starting after account starting_
. Each entry in the array is a separate Account
object. If no more accounts are available, the resulting array will be empty. This request will raise an error if more than one of account_
, account_
, or session
is specified.
{ "object": "list", "url": "/v1/financial_connections/accounts", "has_more": false, "data": [ { "id": "fca_1MwVK82eZvKYlo2Cjw8FMxXf", "object": "financial_connections.account", "account_holder": { "customer": "cus_9s6XI9OFIdpjIg", "type": "customer" }, "balance": null, "balance_refresh": null, "category": "cash", "created": 1681412208, "display_name": "Sample Checking Account", "institution_name": "StripeBank", "last4": "6789", "livemode": false, "ownership": null, "ownership_refresh": null, "permissions": [], "status": "active", "subcategory": "checking", "subscriptions": [], "supported_payment_method_types": [ "us_bank_account" ], "transaction_refresh": null } ]}