Skip to navigation

Create a new Business Bank Account

Adds an external bank account to a business. Send plaid_account_id together with either plaid_access_token or plaid_processor_token. The account is created with account_type external. If the business already has an external account with the same account and routing numbers, that account is returned instead of a new one. Requires the api:write scope on a partner token.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

business_external_idstringRequired

The id of the business.

Request

This endpoint expects an object.
routing_numberstringRequired
account_numberstringRequired
bank_namestringRequired
account_namestringRequired
plaid_account_idstringRequired
plaid_access_tokenstringOptional

Plaid access token of the linked item. Required unless plaid_processor_token is sent.

plaid_processor_tokenstringOptional

Plaid processor token for the account. Required unless plaid_access_token is sent.

Response

idstringformat: "uuid"
account_namestring<=128 characters
account_typeenum
balancestringformat: "decimal"
Available balance of the account, with two decimal places.
is_activeboolean
consumer_idstringOptionalRead-only

The id of the business that owns the account.

bank_namestring or nullOptional<=128 characters
account_routing_numberstringOptionalRead-only
account_numberstringOptionalRead-only
currencyenumOptional

ISO 4217 code of the account’s currency. Defaults to USD.

Allowed values:
statusenumOptional
Allowed values:

Errors

400
Bad Request Error
404
Not Found Error