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
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Query parameters
entityId
The ID of the entity to add bank accounts for
publicToken
The public token obtained from Plaid Link (required for Plaid integration)
connectionType
Set to "EXTERNAL" to create external accounts without Plaid integration
Allowed values:
Request
This endpoint expects an object.
accountType
The type of bank account
accountName
The name of the bank account
accountSubtype
The subtype of the account
accountMask
The last 4 digits of the account number
currency
The currency code for the account
currentBalance
The current balance of the account
availableBalance
The available balance of the account
status
The status of the account
Allowed values:
metadata
Additional metadata for the account
Response
Bank accounts added successfully (Plaid integration)
createdAccounts
message