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 valuesclosedThe FinancialAccount is closed and cannot be used anymore.
openThe FinancialAccount is open and available for use.
pendingThe FinancialAccount was created and is in the process of being opened.
Returns
Response attributes
- dataarray of objects
Financial Accounts retrieved.
- data.
idstring Unique identifier for the object.
- data.
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.
- data.
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.
- data.
balance. availablemap Balance that can be used for money movement.
- data.
balance. inbound_ pendingmap Balance of inbound funds that will later transition to the
availablebalance. - data.
balance. outbound_ pendingmap Balance of funds that are being used for a pending outbound money movement.
- data.
countryenum Two-letter country code that represents the country where the LegalEntity associated with the FinancialAccount is based in.
- data.
createdtimestamp Time at which the object was created.
- data.
display_ namenullable string A descriptive name for the FinancialAccount, up to 50 characters long. This name will be used in the Stripe Dashboard and embedded components.
- data.
livemodeboolean Has the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode. - data.
metadatanullable map Metadata associated with the FinancialAccount.
- data.
othernullable object If this is a
otherFinancialAccount, this hash indicates what the actual type is. Upgrade your API version to see it reflected intype.- data.
other. typestring The type of the FinancialAccount, represented as a string. Upgrade your API version to see the type reflected in
financial_.account. type
- data.
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 valuesclosedThe FinancialAccount is closed and cannot be used anymore.
openThe FinancialAccount is open and available for use.
pendingThe FinancialAccount was created and is in the process of being opened.
- data.
status_ detailsnullable objectPreview feature - data.
status_details. closednullable object - data.
status_details. closed. forwarding_ settingsnullable object - data.
status_details. closed. forwarding_settings. payment_ methodnullable string The address to send forwarded payments to.
- data.
status_details. closed. forwarding_settings. payout_ methodnullable string The address to send forwarded payouts to.
- data.
status_details. closed. reasonenum Possible enum valuesaccount_closed The FinancialAccount is closed by stripe
closed_by_ platform The FinancialAccount is closed by platform
- data.
storagenullable object If this is a
storageFinancialAccount, this hash includes details specific tostorageFinancialAccounts.- data.
storage. holds_ currenciesarray of enums The currencies that this FinancialAccount can hold.
- data.
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 valuesotherThe API version used does not support the FinancialAccount’s type.
storageUsed for the long term storage of funds and sending those funds to others.
- 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", "display_name": "Sample FinancialAccount", "livemode": true, "metadata": null, "status": "open", "storage": { "holds_currencies": [ "usd" ] }, "type": "storage" } ], "next_page_url": null, "previous_page_url": null}- Need help? Contact Support.
- Check out our changelog.
- Questions? Contact Sales.
- LLM? Read llms.txt.
- Powered by Markdoc