Add bank accounts for an entity

Adds bank accounts to an entity using two different methods:

Plaid Integration: Use a Plaid public token obtained from the Plaid Link interface

  • Parameters: entityId + publicToken
  • Automatically imports bank accounts from the connected financial institution

External Account Creation: Manually create bank accounts without Plaid integration

  • Parameters: entityId + connectionType=EXTERNAL
  • Requires account details in the request body

Headers

AuthorizationstringRequired

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

Query parameters

entityIdstringRequired
The ID of the entity to add bank accounts for
publicTokenstringOptional

The public token obtained from Plaid Link (required for Plaid integration)

connectionTypeenumOptional
Set to "EXTERNAL" to create external accounts without Plaid integration
Allowed values:

Request

This endpoint expects an object.
accountTypeenumRequired
The type of bank account
accountNamestringRequired
The name of the bank account
accountSubtypestringOptional
The subtype of the account
accountMaskstringOptional
The last 4 digits of the account number
currencystringOptionalDefaults to USD
The currency code for the account
currentBalancedoubleOptional
The current balance of the account
availableBalancedoubleOptional
The available balance of the account
statusenumOptionalDefaults to ACTIVE
The status of the account
Allowed values:
metadataobjectOptional
Additional metadata for the account

Response

Bank accounts added successfully (Plaid integration)
createdAccountslist of objects or null
messagestring or null

Errors