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}

Subscribe to data refreshes for an Account

POST / v1 / financial_connections / accounts /:id / subscribe

Subscribes to periodic refreshes of data associated with a Financial Connections Account. When the account status is active, data is typically refreshed once a day.

Parameters

• features array of enums Required The list of account features to which you would like to subscribe. Possible enum values 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_1NQay62eZvKYlo2C8dflHjWB", "object": "financial_connections.account", "account_holder": { "customer": "cus_9s6XKzkNRiz8i3", "type": "customer" }, "balance": null, "balance_refresh": null, "category": "cash", "created": 1688583746, "display_name": "Sample Checking Account", "institution_name": "StripeBank", "last4": "6789", "livemode": false, "ownership": null, "ownership_refresh": null, "permissions": [], "status": "active", "subcategory": "checking", "subscriptions": [ "transactions" ], "supported_payment_method_types": [ "us_bank_account" ], "transaction_refresh": { "id": "fctxnref_OD10iHSd7eaheDkeabbQfnJ7", "status": "pending", "last_attempted_at": 1625337296 }}