Close a FinancialAccount

Changed on

Closes a FinancialAccount. A FinancialAccount can only be closed if it has a zero balance, has no pending InboundTransfers, and has canceled all attached Issuing cards.

post/v1/treasury/financial_accounts/{financial_account}/close

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/treasury/financial_accounts/{financial_account}/close
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Path parameters

financial_accountstring required

Request body application/x-www-form-urlencoded

expandstring[]

Specifies which fields in the response should be expanded.

Response

Successful response.

active_featuresstring[]

The array of paths to active Features in the Features hash.

countrystring required

Two-letter country code (ISO 3166-1 alpha-2).

createdinteger required

Time at which the object was created. Measured in seconds since the Unix epoch.

idstring required

Unique identifier for the object.

is_defaultboolean
livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

metadataobject nullable

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.

nicknamestring nullable

The nickname for the FinancialAccount.

object'treasury.financial_account' required

String representing the object's type. Objects of the same type share the same value.

pending_featuresstring[]

The array of paths to pending Features in the Features hash.

restricted_featuresstring[]

The array of paths to restricted Features in the Features hash.

status'closed' | 'open' required

Status of this FinancialAccount.

supported_currenciesstring[] required

The currencies the FinancialAccount can hold a balance in. Three-letter ISO currency code, in lowercase.

Changes

  • c113b1939b8fRevision changes
    • info

      added the optional property ////// to the response with the status

  • 7b8f614372caRevision changes
    • info

      added the optional property ////////// to the response with the status

Some revisions have not been checked yet.