Stripe: Create an external account — accounts post Accounts Account Bank Accounts
Stripe accounts.postAccountsAccountBankAccounts: arguments, response, policy and SDK examples.
← Accounts operations · Get started
Operation stripe.postaccountsaccountbankaccounts
Provider route: POST /v1/accounts/{account}/bank_accounts. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “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["accounts"]["postAccountsAccountBankAccounts"]>[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.accounts.postAccountsAccountBankAccounts(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom 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.accounts.post_accounts_account_bank_accounts(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.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 | Model | Optional | Expand Create an external account — accounts post Accounts Account Bank Accounts — request body — body |
Referenced models: Create an external account — accounts post Accounts Account Bank Accounts — request body — body
Response
Section titled “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 Update a bank account — external Accounts post External Accounts Id — response body |
Referenced models: Update a bank account — external Accounts post External Accounts Id — response body
Schemas
Section titled “Schemas”702 more schemas are linked from the tables above, on the schema pages.
Update a bank account — external Accounts post External Accounts Id — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | Model | Alternative | Expand Retrieve a bank account — response body |
$ (anyOf 2) | Model | Alternative | Expand Retrieve a card — customers get Customers Customer Cards Id — response body |
Referenced models: Retrieve a bank account — response body, Retrieve a card — customers get Customers Customer Cards Id — response body
Create an external account — accounts post Accounts Account Bank Accounts — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
bank_account | JSON | Optional | Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. |
bank_account (anyOf 1) | Model | Alternative | Expand Create an account — request body — body / bank_account / account_holder_type: company, individual, account type: checking, futsu, savings, toza, object: bank account |
bank_account (anyOf 2) | string | Alternative | Maximum length: 5000 |
default_for_currency | boolean | Optional | When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency. |
expand | array | Optional | Specifies which fields in the response should be expanded. |
expand[] | string | Each item | Maximum length: 5000 |
external_account | string | Optional | A token, like the ones returned by [Stripe.js](https://docs.stripe.com/js) or a dictionary containing a user's external account details (with the options shown below). Please refer to full [documentation](https://stripe.com/docs/api/external_accounts) instead. Maximum length: 5000 |
metadata | object | Optional | 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. Additional keys: see wildcard field |
metadata.* | string | Additional keys |
Referenced models: Create an account — request body — body / bank_account / account_holder_type: company, individual, account type: checking, futsu, savings, toza, object: bank account
Create an account — request body — body / bank_account / account_holder_type: company, individual, account type: checking, futsu, savings, toza, object: bank account
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account_holder_name | string | Optional | Maximum length: 5000 |
account_holder_type | string | Optional | One of: company, individual Maximum length: 5000 |
account_number | string | Required within parent | Maximum length: 5000 |
account_type | string | Optional | One of: checking, futsu, savings, toza Maximum length: 5000 |
country | string | Required within parent | Maximum length: 5000 |
currency | string | Optional | Format: currency |
documents | object | Optional | |
documents.bank_account_ownership_verification | object | Optional | |
documents.bank_account_ownership_verification.files | array | Optional | |
documents.bank_account_ownership_verification.files[] | string | Each item | Maximum length: 500 |
object | string | Optional | One of: bank_account Maximum length: 5000 |
routing_number | string | Optional | Maximum length: 5000 |
Delete a customer — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
deleted | boolean | Required within parent | Always true for a deleted object Known values: True |
id | string | Required within parent | Unique identifier for the object. Maximum length: 5000 |
object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Known values: customer |
Retrieve a bank account — response body — requirements value currently due, errors, past due, pending verification
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
currently_due | JSON | Optional | |
currently_due (anyOf 1) | array | Alternative | Fields that need to be resolved to keep the external account enabled. If not resolved by `current_deadline`, these fields will appear in `past_due` as well, and the account is disabled. |
currently_due (anyOf 1)[] | string | Each item | Maximum length: 5000 |
currently_due (anyOf 2) | null | Alternative | |
errors | JSON | Optional | |
errors (anyOf 1) | array | Alternative | Fields that are `currently_due` and need to be collected again because validation or verification failed. |
errors (anyOf 1)[] | Model | Each item | Expand Update an Account Capability — response body — requirements errors item |
errors (anyOf 2) | null | Alternative | |
past_due | JSON | Optional | |
past_due (anyOf 1) | array | Alternative | Fields that haven't been resolved by `current_deadline`. These fields need to be resolved to enable the external account. |
past_due (anyOf 1)[] | string | Each item | Maximum length: 5000 |
past_due (anyOf 2) | null | Alternative | |
pending_verification | JSON | Optional | |
pending_verification (anyOf 1) | array | Alternative | Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending. |
pending_verification (anyOf 1)[] | string | Each item | Maximum length: 5000 |
pending_verification (anyOf 2) | null | Alternative |
Referenced models: Update an Account Capability — response body — requirements errors item
Retrieve a card — customers get Customers Customer Cards Id — response body — networks
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
preferred | JSON | Optional | |
preferred (anyOf 1) | string | Alternative | The preferred network for co-branded cards. Can be `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if requested network is not valid for the card. Maximum length: 5000 |
preferred (anyOf 2) | null | Alternative |
Create an account — response body — groups The groups associated with the account payments pricing
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
payments_pricing | JSON | Optional | |
payments_pricing (anyOf 1) | string | Alternative | The group the account is in to determine their payments pricing, and null if the account is on customized pricing. [See the Platform pricing tool documentation](https://docs.stripe.com/connect/platform-pricing-tools) for details. Maximum length: 5000 |
payments_pricing (anyOf 2) | null | Alternative |
Create an account — response body — tos acceptance
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
date | JSON | Optional | |
date (anyOf 1) | JSON | Alternative | |
date (anyOf 1) (anyOf 1) | integer | Alternative | The Unix timestamp marking when the account representative accepted their service agreement Format: unix-time |
date (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
date (anyOf 2) | null | Alternative | |
ip | JSON | Optional | |
ip (anyOf 1) | string | Alternative | The IP address from which the account representative accepted their service agreement Maximum length: 5000 |
ip (anyOf 2) | null | Alternative | |
service_agreement | string | Optional | The user's service agreement type Maximum length: 5000 |
user_agent | JSON | Optional | |
user_agent (anyOf 1) | string | Alternative | The user agent of the browser from which the account representative accepted their service agreement Maximum length: 5000 |
user_agent (anyOf 2) | null | Alternative |
Create an account — response body — business profile Business information about the account annual revenue, estimated worker count, mcc, minority owned business designation, monthly estimated revenue, name, product description, specified commercial transactions act url, support address, support email, support phone, support url, url monthly estimated revenue
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | JSON | Required within parent | |
amount (anyOf 1) | integer | Alternative | A non-negative integer representing how much to charge in the [smallest currency unit](/currencies#zero-decimal). |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
currency | string | Required within parent | Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Format: currency |
Create an account — response body — controller losses
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
payments | string | Required within parent | A value indicating who is liable when this account can't pay back negative balances from payments. Known values: application, stripe |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: stripe.postaccountsaccountbankaccounts. Catalog operation: PostAccountsAccountBankAccounts. 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"}