Update a FinancialAccount

Updates the details of a FinancialAccount.

Parameters

featuresobject
Encodes whether a FinancialAccount has access to a particular feature, with a status enum and associated status_details. Stripe or the platform may control features via the requested field.

forwarding_settingsobject
A different bank account where funds can be deposited/debited in order to get the closing FA’s balance to $0

metadataobject
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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

nicknamestring
The nickname for the FinancialAccount.

platform_restrictionsobject
The set of functionalities that the platform can restrict on the FinancialAccount.

Returns

Returns a FinancialAccount object.

POST /v1/treasury/financial_accounts/:id

Server-side language

curl https://api.stripe.com/v1/treasury/financial_accounts/fa_1MtZmL2eZvKYlo2Cer6cdwEC \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d "metadata[order_id]"=6735

Response

{
  "id": "fa_1MtZmL2eZvKYlo2Cer6cdwEC",
  "object": "treasury.financial_account",
  "active_features": [
    "financial_addresses.aba",
    "outbound_payments.ach",
    "outbound_payments.us_domestic_wire"
  ],
  "balance": {
    "cash": {
      "usd": 0
    },
    "inbound_pending": {
      "usd": 0
    },
    "outbound_pending": {
      "usd": 0
    }
  },
  "country": "US",
  "created": 1680714349,
  "financial_addresses": [
    {
      "aba": {
        "account_holder_name": "Jenny Rosen",
        "account_number_last4": "7890",
        "bank_name": "STRIPE TEST BANK",
        "routing_number": "0000000001"
      },
      "supported_networks": [
        "ach",
        "us_domestic_wire"
      ],
      "type": "aba"
    }
  ],
  "livemode": true,
  "metadata": {
    "order_id": "6735"
  },
  "pending_features": [],
  "restricted_features": [],
  "status": "open",
  "status_details": {
    "closed": null
  },
  "supported_currencies": [
    "usd"
  ],
  "features": {}
}

Retrieve a FinancialAccount

Retrieves the details of a FinancialAccount.

Parameters

No parameters.

Returns

Return a FinancialAccount object.

GET /v1/treasury/financial_accounts/:id

Server-side language

curl https://api.stripe.com/v1/treasury/financial_accounts/fa_1MtZmL2eZvKYlo2Cer6cdwEC \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:"

Response

{
  "id": "fa_1MtZmL2eZvKYlo2Cer6cdwEC",
  "object": "treasury.financial_account",
  "active_features": [
    "financial_addresses.aba",
    "outbound_payments.ach",
    "outbound_payments.us_domestic_wire"
  ],
  "balance": {
    "cash": {
      "usd": 0
    },
    "inbound_pending": {
      "usd": 0
    },
    "outbound_pending": {
      "usd": 0
    }
  },
  "country": "US",
  "created": 1680714349,
  "financial_addresses": [
    {
      "aba": {
        "account_holder_name": "Jenny Rosen",
        "account_number_last4": "7890",
        "bank_name": "STRIPE TEST BANK",
        "routing_number": "0000000001"
      },
      "supported_networks": [
        "ach",
        "us_domestic_wire"
      ],
      "type": "aba"
    }
  ],
  "livemode": true,
  "metadata": null,
  "pending_features": [],
  "restricted_features": [],
  "status": "open",
  "status_details": {
    "closed": null
  },
  "supported_currencies": [
    "usd"
  ],
  "features": {}
}

List all FinancialAccounts

Returns a list of FinancialAccounts.

Parameters

createdobject
Only return FinancialAccounts that were created during the given date interval.

More parameters

ending_beforestring

limitinteger

starting_afterstring

statusenum

Returns

A dictionary with a data property that contains an array of up to limit FinancialAccounts, starting after FinancialAccount starting_after. Each entry in the array is a separate FinancialAccount object. If no more FinancialAccounts are available, the resulting array is empty.

GET /v1/treasury/financial_accounts

Server-side language

curl -G https://api.stripe.com/v1/treasury/financial_accounts \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d limit=3

Response

{
  "object": "list",
  "url": "/v1/treasury/financial_accounts",
  "has_more": false,
  "data": [
    {
      "id": "fa_1MtZmL2eZvKYlo2Cer6cdwEC",
      "object": "treasury.financial_account",
      "active_features": [
        "financial_addresses.aba",
        "outbound_payments.ach",
        "outbound_payments.us_domestic_wire"
      ],
      "balance": {
        "cash": {
          "usd": 0
        },
        "inbound_pending": {
          "usd": 0
        },
        "outbound_pending": {
          "usd": 0
        }
      },
      "country": "US",
      "created": 1680714349,
      "financial_addresses": [
        {
          "aba": {
            "account_holder_name": "Jenny Rosen",
            "account_number_last4": "7890",
            "bank_name": "STRIPE TEST BANK",
            "routing_number": "0000000001"
          },
          "supported_networks": [
            "ach",
            "us_domestic_wire"
          ],
          "type": "aba"
        }
      ],
      "livemode": true,
      "metadata": null,
      "pending_features": [],
      "restricted_features": [],
      "status": "open",
      "status_details": {
        "closed": null
      },
      "supported_currencies": [
        "usd"
      ],
      "features": {}
    }
  ]
}

Financial Account Features

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.

Endpoints

POST/v1/treasury/financial_accounts/:id/features

GET/v1/treasury/financial_accounts/:id/features