List Accounts

GET / v1 / financial_connections / accounts

Returns a list of Financial Connections Account objects.

Parameters

• account _ holder object If present, only return accounts that belong to the specified account holder. account_holder[customer] and account_holder[account] are mutually exclusive.
• session string If present, only return accounts that were collected as part of the given session.

More parameters

• ending _ before string
• limit integer
• starting _ after string

Returns

A dictionary with a data property that contains an array of up to limit Account objects, starting after account starting_after. 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_holder[account], account_holder[customer], or session is specified.

Response

Disconnect an Account

POST / v1 / financial_connections / accounts /:id / disconnect

Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).

Parameters

No parameters.

Returns

Returns an Account object if a valid identifier was provided, and raises an error otherwise.

Response

{ "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": "disconnected", "subcategory": "checking", "subscriptions": [], "supported_payment_method_types": [ "us_bank_account" ], "transaction_refresh": null}

Refresh Account data

POST / v1 / financial_connections / accounts /:id / refresh

Refreshes the data associated with a Financial Connections Account.

Parameters

• features array of enums Required The list of account features that you would like to refresh. Possible enum values balance Balance data from the account ownership Ownership data from the account transactions Transactions data from the account

Returns

Returns an Account object if a valid identifier was provided and if you have sufficient permissions to that account. Raises an error otherwise.

Response

{ "id": "fca_1MwVK82eZvKYlo2Cjw8FMxXf", "object": "financial_connections.account", "account_holder": { "customer": "cus_9s6XI9OFIdpjIg", "type": "customer" }, "balance": null, "balance_refresh": { "status": "pending", "last_attempted_at": 1681422295 }, "category": "cash", "created": 1681412208, "display_name": "Sample Checking Account", "institution_name": "StripeBank", "last4": "6789", "livemode": false, "ownership": null, "ownership_refresh": null, "permissions": [], "status": "pending", "subcategory": "checking", "subscriptions": [], "supported_payment_method_types": [ "us_bank_account" ], "transaction_refresh": null}