Stripe: Close a Financial Account

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

Operation stripe.posttreasuryfinancialaccountsfinancialaccountclose

Provider route: POST /v1/treasury/financial_accounts/{financial_account}/close. Alter supplies the connection’s credentials and routing.

Call through Alter

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"]["postTreasuryFinancialAccountsFinancialAccountClose"]>[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.postTreasuryFinancialAccountsFinancialAccountClose(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.post_treasury_financial_accounts_financial_account_close(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`path`	object	Required within parent	Additional keys: not allowed
`path.financial_account`	string	Required within parent	Maximum length: 5000
`headers`	object	Optional	Additional keys: not allowed
`headers.Idempotency-Key`	string	Optional	Minimum length: 1 Maximum length: 255
`body`	object	Optional	Additional keys: not allowed
`body.expand`	array	Optional	Specifies which fields in the response should be expanded.
`body.expand[]`	string	Each item	Maximum length: 5000
`body.forwarding_settings`	object	Optional	A different bank account where funds can be deposited/debited in order to get the closing FA’s balance to $0
`body.forwarding_settings.financial_account`	string	Optional
`body.forwarding_settings.payment_method`	string	Optional	Maximum length: 5000
`body.forwarding_settings.type`	string	Required within parent	One of: financial_account, payment_method

Response

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

Field	Type	Presence	Description and constraints
`$`	Model	Root	Expand Close a Financial Account — response body

Referenced models: Close a Financial Account — response body

Schemas

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

Close a Financial Account — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Stripe 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_features`	array	Optional	The array of paths to active Features in the Features hash.
`active_features[]`	string	Each item	Known 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
`balance`	Model	Required within parent	Expand Close a Financial Account — response body — balance
`country`	string	Required within parent	Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). Maximum length: 5000
`created`	JSON	Required within parent
`created (anyOf 1)`	integer	Alternative	Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time
`created (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`features`	Model	Optional	Expand Update Financial Account Features — response body
`financial_addresses`	array	Required within parent	The set of credentials that resolve to a FinancialAccount.
`financial_addresses[]`	Model	Each item	Expand Close a Financial Account — response body — financial addresses item
`id`	string	Required within parent	Unique identifier for the object. Maximum length: 5000
`is_default`	boolean	Optional
`livemode`	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
`metadata`	JSON	Optional
`metadata (anyOf 1)`	object	Alternative	Set 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).*`	string	Additional keys	Maximum length: 500
`metadata (anyOf 2)`	null	Alternative
`nickname`	JSON	Optional
`nickname (anyOf 1)`	string	Alternative	The nickname for the FinancialAccount. Maximum length: 5000
`nickname (anyOf 2)`	null	Alternative
`object`	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: treasury.financial_account
`pending_features`	array	Optional	The array of paths to pending Features in the Features hash.
`pending_features[]`	string	Each item	Known 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_restrictions`	JSON	Optional
`platform_restrictions (anyOf 1)`	JSON	Alternative	The set of functionalities that the platform can restrict on the FinancialAccount.
`platform_restrictions (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Close a Financial Account — response body — platform restrictions value inbound flows, outbound flows
`platform_restrictions (anyOf 2)`	null	Alternative
`restricted_features`	array	Optional	The array of paths to restricted Features in the Features hash.
`restricted_features[]`	string	Each item	Known 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
`status`	string	Required within parent	Status of this FinancialAccount. Known values: closed, open
`status_details`	Model	Required within parent	Expand Close a Financial Account — response body — status details
`supported_currencies`	array	Required within parent	The 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[]`	string	Each 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

Field	Type	Presence	Description and constraints
`$`	object	Root	Encodes 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_issuing`	Model	Optional	Expand Update Financial Account Features — response body — card issuing
`deposit_insurance`	Model	Optional	Expand Update Financial Account Features — response body — card issuing
`financial_addresses`	Model	Optional	Expand Update Financial Account Features — response body — financial addresses
`inbound_transfers`	Model	Optional	Expand Update Financial Account Features — response body — inbound transfers
`intra_stripe_flows`	Model	Optional	Expand Update Financial Account Features — response body — card issuing
`object`	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: treasury.financial_account_features
`outbound_payments`	Model	Optional	Expand Update Financial Account Features — response body — outbound payments
`outbound_transfers`	Model	Optional	Expand 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

Field	Type	Presence	Description and constraints
`$`	object	Root	Balance information for the FinancialAccount
`cash`	object	Required within parent	Funds the user can spend right now. Additional keys: see wildcard field
`cash.*`	JSON	Additional keys
`cash.* (anyOf 1)`	integer	Alternative
`cash.* (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`inbound_pending`	object	Required within parent	Funds not spendable yet, but will become available at a later time. Additional keys: see wildcard field
`inbound_pending.*`	JSON	Additional keys
`inbound_pending.* (anyOf 1)`	integer	Alternative
`inbound_pending.* (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`outbound_pending`	object	Required within parent	Funds in the account, but not spendable because they are being held for pending outbound flows. Additional keys: see wildcard field
`outbound_pending.*`	JSON	Additional keys
`outbound_pending.* (anyOf 1)`	integer	Alternative
`outbound_pending.* (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Close a Financial Account — response body — financial addresses item

Field	Type	Presence	Description and constraints
`$`	object	Root	FinancialAddresses contain identifying information that resolves to a FinancialAccount.
`aba`	Model	Optional	Expand Close a Financial Account — response body — financial addresses item aba
`supported_networks`	array	Optional	The list of networks that the address supports
`supported_networks[]`	string	Each item	Known values: ach, rtp, us_domestic_wire
`type`	string	Required within parent	The 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

Field	Type	Presence	Description and constraints
`$`	object	Root
`reasons`	array	Required within parent	The array that contains reasons for a FinancialAccount closure.
`reasons[]`	string	Each item	Known values: account_rejected, closed_by_platform, other

Policy, approvals and errors

SDK function policy ID: stripe.posttreasuryfinancialaccountsfinancialaccountclose. Catalog operation: PostTreasuryFinancialAccountsFinancialAccountClose. 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