Skip to content

Stripe: List all Financial Accounts

Stripe treasury.getTreasuryFinancialAccounts: arguments, response, policy and SDK examples.

← Treasury operations · Get started

Operation stripe.gettreasuryfinancialaccounts

Provider route: GET /v1/treasury/financial_accounts. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/stripe with npm, or alter-sdk-stripe with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { StripeIntegration } from "@alter-ai/stripe";
async function execute(input: Parameters<StripeIntegration["treasury"]["getTreasuryFinancialAccounts"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new StripeIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.treasury.getTreasuryFinancialAccounts(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_stripe import StripeIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = StripeIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.treasury.get_treasury_financial_accounts(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.createdJSONOptional
query.created (anyOf 1)objectAlternative
query.created (anyOf 1).gtintegerOptional
query.created (anyOf 1).gteintegerOptional
query.created (anyOf 1).ltintegerOptional
query.created (anyOf 1).lteintegerOptional
query.created (anyOf 2)integerAlternative
query.ending_beforestringOptionalMaximum length: 5000
query.expandarrayOptional
query.expand[]stringEach itemMaximum length: 5000
query.limitintegerOptional
query.starting_afterstringOptionalMaximum length: 5000
query.statusstringOptionalOne of: closed, open

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Close a Financial Account — response body
has_morebooleanRequired within parentTrue if this list has another page of items after this one that can be fetched.
objectstringRequired within parentString representing the object’s type. Objects of the same type share the same value. Always has the value `list`.
Known values: list
urlstringRequired within parentThe URL where this list can be accessed.
Maximum length: 5000
Pattern: ^/v1/treasury/financial_accounts

Referenced models: Close a Financial Account — response body

12 more schemas are linked from the tables above, on the schema pages.

Close a Financial Account — response body
FieldTypePresenceDescription and constraints
$objectRootStripe Treasury for Platforms provides users with a container for money called a FinancialAccount that is separate from their Payments balance.
FinancialAccounts serve as the source and destination of Treasury for Platform’s money movement APIs.
active_featuresarrayOptionalThe array of paths to active Features in the Features hash.
active_features[]stringEach itemKnown values: card_issuing, deposit_insurance, financial_addresses.aba, financial_addresses.aba.forwarding, inbound_transfers.ach, intra_stripe_flows, outbound_payments.ach, outbound_payments.us_domestic_wire, outbound_transfers.ach, outbound_transfers.us_domestic_wire, remote_deposit_capture
balanceModelRequired within parentExpand Close a Financial Account — response body — balance
countrystringRequired within parentTwo-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
Maximum length: 5000
createdJSONRequired within parent
created (anyOf 1)integerAlternativeTime at which the object was created. Measured in seconds since the Unix epoch.
Format: unix-time
created (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
featuresModelOptionalExpand Update Financial Account Features — response body
financial_addressesarrayRequired within parentThe set of credentials that resolve to a FinancialAccount.
financial_addresses[]ModelEach itemExpand Close a Financial Account — response body — financial addresses item
idstringRequired within parentUnique identifier for the object.
Maximum length: 5000
is_defaultbooleanOptional
livemodebooleanRequired within parentIf the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
metadataJSONOptional
metadata (anyOf 1)objectAlternativeSet of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
Additional keys: see wildcard field
metadata (anyOf 1).*stringAdditional keysMaximum length: 500
metadata (anyOf 2)nullAlternative
nicknameJSONOptional
nickname (anyOf 1)stringAlternativeThe nickname for the FinancialAccount.
Maximum length: 5000
nickname (anyOf 2)nullAlternative
objectstringRequired within parentString representing the object's type. Objects of the same type share the same value.
Known values: treasury.financial_account
pending_featuresarrayOptionalThe array of paths to pending Features in the Features hash.
pending_features[]stringEach itemKnown values: card_issuing, deposit_insurance, financial_addresses.aba, financial_addresses.aba.forwarding, inbound_transfers.ach, intra_stripe_flows, outbound_payments.ach, outbound_payments.us_domestic_wire, outbound_transfers.ach, outbound_transfers.us_domestic_wire, remote_deposit_capture
platform_restrictionsJSONOptional
platform_restrictions (anyOf 1)JSONAlternativeThe set of functionalities that the platform can restrict on the FinancialAccount.
platform_restrictions (anyOf 1) (anyOf 1)ModelAlternativeExpand Close a Financial Account — response body — platform restrictions value inbound flows, outbound flows
platform_restrictions (anyOf 2)nullAlternative
restricted_featuresarrayOptionalThe array of paths to restricted Features in the Features hash.
restricted_features[]stringEach itemKnown values: card_issuing, deposit_insurance, financial_addresses.aba, financial_addresses.aba.forwarding, inbound_transfers.ach, intra_stripe_flows, outbound_payments.ach, outbound_payments.us_domestic_wire, outbound_transfers.ach, outbound_transfers.us_domestic_wire, remote_deposit_capture
statusstringRequired within parentStatus of this FinancialAccount.
Known values: closed, open
status_detailsModelRequired within parentExpand Close a Financial Account — response body — status details
supported_currenciesarrayRequired within parentThe currencies the FinancialAccount can hold a balance in. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
supported_currencies[]stringEach item

Referenced models: Update Financial Account Features — response body, Close a Financial Account — response body — balance, Close a Financial Account — response body — financial addresses item, Close a Financial Account — response body — platform restrictions value inbound flows, outbound flows, Close a Financial Account — response body — status details

Update Financial Account Features — response body
FieldTypePresenceDescription and constraints
$objectRootEncodes whether a FinancialAccount has access to a particular Feature, with a `status` enum and associated `status_details`.
Stripe or the platform can control Features via the requested field.
card_issuingModelOptionalExpand Update Financial Account Features — response body — card issuing
deposit_insuranceModelOptionalExpand Update Financial Account Features — response body — card issuing
financial_addressesModelOptionalExpand Update Financial Account Features — response body — financial addresses
inbound_transfersModelOptionalExpand Update Financial Account Features — response body — inbound transfers
intra_stripe_flowsModelOptionalExpand Update Financial Account Features — response body — card issuing
objectstringRequired within parentString representing the object's type. Objects of the same type share the same value.
Known values: treasury.financial_account_features
outbound_paymentsModelOptionalExpand Update Financial Account Features — response body — outbound payments
outbound_transfersModelOptionalExpand Update Financial Account Features — response body — outbound transfers

Referenced models: Update Financial Account Features — response body — financial addresses, Update Financial Account Features — response body — inbound transfers, Update Financial Account Features — response body — outbound payments, Update Financial Account Features — response body — outbound transfers, Update Financial Account Features — response body — card issuing

Close a Financial Account — response body — balance
FieldTypePresenceDescription and constraints
$objectRootBalance information for the FinancialAccount
cashobjectRequired within parentFunds the user can spend right now.
Additional keys: see wildcard field
cash.*JSONAdditional keys
cash.* (anyOf 1)integerAlternative
cash.* (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
inbound_pendingobjectRequired within parentFunds not spendable yet, but will become available at a later time.
Additional keys: see wildcard field
inbound_pending.*JSONAdditional keys
inbound_pending.* (anyOf 1)integerAlternative
inbound_pending.* (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
outbound_pendingobjectRequired within parentFunds in the account, but not spendable because they are being held for pending outbound flows.
Additional keys: see wildcard field
outbound_pending.*JSONAdditional keys
outbound_pending.* (anyOf 1)integerAlternative
outbound_pending.* (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Close a Financial Account — response body — financial addresses item
FieldTypePresenceDescription and constraints
$objectRootFinancialAddresses contain identifying information that resolves to a FinancialAccount.
abaModelOptionalExpand Close a Financial Account — response body — financial addresses item aba
supported_networksarrayOptionalThe list of networks that the address supports
supported_networks[]stringEach itemKnown values: ach, rtp, us_domestic_wire
typestringRequired within parentThe type of financial address
Known values: aba

Referenced models: Close a Financial Account — response body — financial addresses item aba

Close a Financial Account — response body — status details closed value reasons
FieldTypePresenceDescription and constraints
$objectRoot
reasonsarrayRequired within parentThe array that contains reasons for a FinancialAccount closure.
reasons[]stringEach itemKnown values: account_rejected, closed_by_platform, other

SDK function policy ID: stripe.gettreasuryfinancialaccounts. Catalog operation: GetTreasuryFinancialAccounts. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"Stripe-Version": "2026-09-30.endive"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.