The Financial Account is the container that allows for the configuration of money movement.
Attributes
- idstring
Unique identifier for the object.
- objectstring, value is "v2.money_management.financial_account"
String representing the object’s type. Objects of the same type share the same value of the object field.
- balanceobject
Multi-currency balance of this FinancialAccount, split by availability state. Each balance is represented as a hash where the key is the three-letter ISO currency code, in lowercase, and the value is the amount for that currency.
- countryenum
Two-letter country code that represents the country where the LegalEntity associated with the FinancialAccount is based in.
- createdtimestamp
Time at which the object was created.
- livemodeboolean
Has the value
true
if the object exists in live mode or the valuefalse
if the object exists in test mode. - metadatanullable map
Metadata associated with the FinancialAccount
- othernullable object
If this is a
other
FinancialAccount, this hash indicates what the actual type is. Upgrade your API version to see it reflected intype
. - statusenum
An enum representing the status of the FinancialAccount. This indicates whether or not the FinancialAccount can be used for any money movement flows.
Possible enum valuesclosed
The FinancialAccount is closed and cannot be used anymore.
open
The FinancialAccount is open and available for use.
pending
The FinancialAccount was created and is in the process of being opened.
- status_
detailsnullable objectPreview feature - storagenullable object
If this is a
storage
FinancialAccount, this hash includes details specific tostorage
FinancialAccounts. - typeenum
Type of the FinancialAccount. An additional hash is included on the FinancialAccount with a name matching this value. It contains additional information specific to the FinancialAccount type.
Possible enum valuesother
The API version used does not support the FinancialAccount’s type.
storage
Used for the long term storage of funds and sending those funds to others.
{ "id": "fa_65NvTFNdpXXUx1kx1rB16NoTesLDSQ1IgNPigisRKq09iq", "object": "v2.money_management.financial_account", "balance": { "available": { "usd": { "value": 0, "currency": "usd" } }, "inbound_pending": { "usd": { "value": 0, "currency": "usd" } }, "outbound_pending": { "usd": { "value": 0, "currency": "usd" } } }, "country": "US", "created": "2023-02-24T22:48:56.363Z", "description": "This is a sample Financial Account.", "status": "open", "storage": { "holds_currencies": [ "usd" ] }, "type": "storage"}
Creates a new FinancialAccount.
Learn more about calling API v2 endpoints.Parameters
- typeenumRequired
The type of FinancialAccount to create.
Possible enum valuesstorage
Used for the long term storage of funds and sending those funds to others.
- metadatamap
Metadata associated with the FinancialAccount.
- storageobject
Parameters specific to creating
storage
type FinancialAccounts.
Returns
Response attributes
- idstring
Unique identifier for the object.
- objectstring, value is "v2.money_management.financial_account"
String representing the object’s type. Objects of the same type share the same value of the object field.
- balanceobject
Multi-currency balance of this FinancialAccount, split by availability state. Each balance is represented as a hash where the key is the three-letter ISO currency code, in lowercase, and the value is the amount for that currency.
- countryenum
Two-letter country code that represents the country where the LegalEntity associated with the FinancialAccount is based in.
- createdtimestamp
Time at which the object was created.
- livemodeboolean
Has the value
true
if the object exists in live mode or the valuefalse
if the object exists in test mode. - metadatanullable map
Metadata associated with the FinancialAccount
- othernullable object
If this is a
other
FinancialAccount, this hash indicates what the actual type is. Upgrade your API version to see it reflected intype
. - statusenum
An enum representing the status of the FinancialAccount. This indicates whether or not the FinancialAccount can be used for any money movement flows.
Possible enum valuesclosed
The FinancialAccount is closed and cannot be used anymore.
open
The FinancialAccount is open and available for use.
pending
The FinancialAccount was created and is in the process of being opened.
- status_
detailsnullable objectPreview feature - storagenullable object
If this is a
storage
FinancialAccount, this hash includes details specific tostorage
FinancialAccounts. - typeenum
Type of the FinancialAccount. An additional hash is included on the FinancialAccount with a name matching this value. It contains additional information specific to the FinancialAccount type.
Possible enum valuesother
The API version used does not support the FinancialAccount’s type.
storage
Used for the long term storage of funds and sending those funds to others.
The resource already exists.
The compartment has reached its limit on open FinancialAccounts.
The required storer capabilities are missing.
The required storer capabilities are not active.
The currency is not supported for Financial Accounts.
An idempotent retry occurred with different request parameters.
{ "id": "fa_65So897Og7nsSRgcz1L16SmeOD0tE9TfqsMPW2uZH3IEky", "object": "v2.money_management.financial_account", "balance": { "available": { "usd": { "value": 0, "currency": "usd" } }, "inbound_pending": { "usd": { "value": 0, "currency": "usd" } }, "outbound_pending": { "usd": { "value": 0, "currency": "usd" } } }, "country": "US", "created": "2025-06-27T21:52:05.197Z", "metadata": { "nickname": "My Financial Account" }, "other": null, "status": "pending", "storage": { "holds_currencies": [ "usd" ] }, "type": "storage", "livemode": true}
Retrieves the details of an existing FinancialAccount.
Learn more about calling API v2 endpoints.Parameters
- idstringRequired
ID of the FinancialAccount to be fetched.
Returns
Response attributes
- idstring
Unique identifier for the object.
- objectstring, value is "v2.money_management.financial_account"
String representing the object’s type. Objects of the same type share the same value of the object field.
- balanceobject
Multi-currency balance of this FinancialAccount, split by availability state. Each balance is represented as a hash where the key is the three-letter ISO currency code, in lowercase, and the value is the amount for that currency.
- countryenum
Two-letter country code that represents the country where the LegalEntity associated with the FinancialAccount is based in.
- createdtimestamp
Time at which the object was created.
- livemodeboolean
Has the value
true
if the object exists in live mode or the valuefalse
if the object exists in test mode. - metadatanullable map
Metadata associated with the FinancialAccount
- othernullable object
If this is a
other
FinancialAccount, this hash indicates what the actual type is. Upgrade your API version to see it reflected intype
. - statusenum
An enum representing the status of the FinancialAccount. This indicates whether or not the FinancialAccount can be used for any money movement flows.
Possible enum valuesclosed
The FinancialAccount is closed and cannot be used anymore.
open
The FinancialAccount is open and available for use.
pending
The FinancialAccount was created and is in the process of being opened.
- status_
detailsnullable objectPreview feature - storagenullable object
If this is a
storage
FinancialAccount, this hash includes details specific tostorage
FinancialAccounts. - typeenum
Type of the FinancialAccount. An additional hash is included on the FinancialAccount with a name matching this value. It contains additional information specific to the FinancialAccount type.
Possible enum valuesother
The API version used does not support the FinancialAccount’s type.
storage
Used for the long term storage of funds and sending those funds to others.
The resource wasn’t found.
{ "id": "fa_65NvTFNdpXXUx1kx1rB16NoTesLDSQ1IgNPigisRKq09iq", "object": "v2.money_management.financial_account", "balance": { "available": { "usd": { "value": 0, "currency": "usd" } }, "inbound_pending": { "usd": { "value": 0, "currency": "usd" } }, "outbound_pending": { "usd": { "value": 0, "currency": "usd" } } }, "country": "US", "created": "2023-02-24T22:48:56.363Z", "status": "open", "storage": { "holds_currencies": [ "usd" ] }, "type": "storage", "livemode": true}
Lists FinancialAccounts in this compartment.
Learn more about calling API v2 endpoints.Parameters
- limitinteger
The page limit.
- pagestring
The page token.
- statusenumPreview feature
The status of the FinancialAccount to filter by. By default, closed FinancialAccounts are not returned.
Possible enum valuesclosed
The FinancialAccount is closed and cannot be used anymore.
open
The FinancialAccount is open and available for use.
pending
The FinancialAccount was created and is in the process of being opened.
Returns
Response attributes
- dataarray of objects
Financial Accounts retrieved.
- next_
page_ urlnullable string The next page URL.
- previous_
page_ urlnullable string The previous page URL.
{ "data": [ { "id": "fa_65NvTFNdpXXUx1kx1rB16NoTesLDSQ1IgNPigisRKq09iq", "object": "v2.money_management.financial_account", "balance": { "available": { "usd": { "value": 0, "currency": "usd" } }, "inbound_pending": { "usd": { "value": 0, "currency": "usd" } }, "outbound_pending": { "usd": { "value": 0, "currency": "usd" } } }, "country": "US", "created": "2023-02-24T22:48:56.363Z", "status": "open", "storage": { "holds_currencies": [ "usd" ] }, "type": "storage", "livemode": true } ], "next_page_url": null, "previous_page_url": null}