Create a bank account 

When you create a new bank account, you must specify a connected account to create it on. You can only specify connected accounts where account.controller.requirement_collection is application (includes Custom accounts).

If the bank account’s owner has no other external account in the bank account’s currency, the new bank account will become the default for that currency. However, if the owner already has a bank account for that currency, the new account will become the default only if the default_for_currency parameter is set to true.

Parameters

• external_accountobject | stringRequired

  Either a token, like the ones returned by Stripe.js, or a dictionary containing a user’s bank account details (with the options shown below).

  Hide child parameters

  • external_account.account_numberstringRequired

    The account number for the bank account, in string form. Must be a checking account.

  • external_account.countrystringRequired

    The country in which the bank account is located.

  • external_account.currencystringRequired

    The currency the bank account is in. This must be a country/currency pairing that Stripe supports.

  • external_account.objectstringRequired

    The type of external account. Should be bank_account

  • external_account.account_holder_namestring

    The name of the person or business that owns the bank account. This field is required when attaching the bank account to a Customer object.

  • external_account.account_holder_typeenum

    The type of entity that holds the account. This field is required when attaching the bank account to a Customer object.

    Possible enum values

    company

    individual

  • external_account.documentsobject

    Documents that may be submitted to satisfy various informational requests.

    Hide child parameters

    • external_account.documents.bank_account_ownership_verificationobject

      One or more documents that support the Bank account ownership verification requirement. Must be a document associated with the bank account that displays the last 4 digits of the account number, either a statement or a voided check.

      Hide child parameters

      • external_account.documents.bank_account_ownership_verification.filesarray of strings

        One or more document ids returned by a file upload with a purpose value of account_requirement.

  • external_account.routing_numberstring

    The routing number, sort code, or other country-appropriate institution number for the bank account. For US bank accounts, this is required and should be the ACH routing number, not the wire routing number. If you are providing an IBAN for account_number, this field is not required.

• 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.

More parameters

Collapse all

• default_for_currencyboolean

  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.