The FinancialAccount object

Attributes

id string Unique identifier for the object.
object string, value is "treasury.financial_account" String representing the object’s type. Objects of the same type share the same value.
active _ features array of enums The array of paths to active Features in the Features hash.
balance object The single multi-currency balance of the FinancialAccount. Positive values represent money that belongs to the user while negative values represent funds the user owes. Currently, FinancialAccounts can only carry balances in USD.
country string Two-letter country code ( ISO 3166-1 alpha-2).
created timestamp Time at which the object was created. Measured in seconds since the Unix epoch.
features nullable object Includable The features and their statuses for this FinancialAccount.
financial _ addresses array of objects The set of credentials that resolve to a FinancialAccount.
livemode boolean If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
metadata nullable 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.
nickname nullable string Preview feature The nickname for the FinancialAccount.
pending _ features array of enums The array of paths to pending Features in the Features hash.
platform _ restrictions nullable object The set of functionalities that the platform can restrict on the FinancialAccount.
restricted _ features array of enums The array of paths to restricted Features in the Features hash.
status enum Status of this FinancialAccount. Possible enum values closed The FinancialAccount is closed. open The FinancialAccount is open.
status _ details object Details related to the status of this FinancialAccount.
supported _ currencies array of enums The currencies the FinancialAccount can hold a balance in. Three-letter ISO currency code, in lowercase.

{ "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": {}}

Create a FinancialAccount

POST / v1 / treasury / financial_accounts

Creates a new FinancialAccount. Each connected account can have up to three FinancialAccounts by default.

Parameters

supported _ currencies array of strings Required The currencies the FinancialAccount can hold a balance in.
features object Encodes whether a FinancialAccount has access to a particular feature. Stripe or the platform can control features via the requested field.
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": null, "pending_features": [], "restricted_features": [], "status": "open", "status_details": { "closed": null }, "supported_currencies": [ "usd" ], "features": {}}

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": {}}