Update a FinancialAccount
POST / v1 / treasury / financial_accounts /:id
Updates the details of a FinancialAccount.
Parameters
- features object Encodes whether a FinancialAccount has access to a particular feature, with a status enum and associated
status_details. Stripe or the platform may control features via the requested field. - forwarding _ settings object A different bank account where funds can be deposited/debited in order to get the closing FA’s balance to $0
- metadata map 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. - nickname string The nickname for the FinancialAccount.
- platform _ restrictions object The set of functionalities that the platform can restrict on the FinancialAccount.
Returns
Returns a FinancialAccount object.
Response
{ "id": "fa_1MtZmL2eZvKYlo2Cer6cdwEC", "object": "treasury.financial_account", "active_features": [ "financial_addresses.aba", "outbound_payments.ach", "outbound_payments.us_domestic_wire" ], "balance": { "cash": { "usd": 0 }, "inbound_pending": { "usd": 0 }, "outbound_pending": { "usd": 0 } }, "country": "US", "created": 1680714349, "financial_addresses": [ { "aba": { "account_holder_name": "Jenny Rosen", "account_number_last4": "7890", "bank_name": "STRIPE TEST BANK", "routing_number": "0000000001" }, "supported_networks": [ "ach", "us_domestic_wire" ], "type": "aba" } ], "livemode": true, "metadata": { "order_id": "6735" }, "pending_features": [], "restricted_features": [], "status": "open", "status_details": { "closed": null }, "supported_currencies": [ "usd" ], "features": {}}
Retrieve a FinancialAccount
GET / v1 / treasury / financial_accounts /:id
Retrieves the details of a FinancialAccount.
Parameters
No parameters.
Returns
Return a FinancialAccount object.
Response
{ "id": "fa_1MtZmL2eZvKYlo2Cer6cdwEC", "object": "treasury.financial_account", "active_features": [ "financial_addresses.aba", "outbound_payments.ach", "outbound_payments.us_domestic_wire" ], "balance": { "cash": { "usd": 0 }, "inbound_pending": { "usd": 0 }, "outbound_pending": { "usd": 0 } }, "country": "US", "created": 1680714349, "financial_addresses": [ { "aba": { "account_holder_name": "Jenny Rosen", "account_number_last4": "7890", "bank_name": "STRIPE TEST BANK", "routing_number": "0000000001" }, "supported_networks": [ "ach", "us_domestic_wire" ], "type": "aba" } ], "livemode": true, "metadata": null, "pending_features": [], "restricted_features": [], "status": "open", "status_details": { "closed": null }, "supported_currencies": [ "usd" ], "features": {}}
List all FinancialAccounts
GET / v1 / treasury / financial_accounts
Returns a list of FinancialAccounts.
Parameters
- created object Only return FinancialAccounts that were created during the given date interval.
More parameters
- ending _ before string
- limit integer
- starting _ after string
- status enum
Returns
A dictionary with a data property that contains an array of up to limit FinancialAccounts, starting after FinancialAccount starting_after. Each entry in the array is a separate FinancialAccount object. If no more FinancialAccounts are available, the resulting array is empty.
Response