GuidesRecipesAPI ReferenceChangelog
API Reference

Create Deposit Bank Account

Creates a deposit bank account.

State

StateDescription
storingThe Platform is storing the deposit bank account details in our private store
createdThe Platform has created the deposit bank account

Required scope: deposit_bank_accounts:execute

Body Params
string
enum
required

The account type. To generate deposit bank accounts with their own unique account number set this to "main". To generate deposit bank accounts with the same account number as the parent deposit bank account set this to "sub_account". This setting will only generate a unique identifier for the deposit bank and will not result in a unique account number being generated. "sub_account" is only available for customer-level deposit bank accounts.

Allowed:
string
required
length between 32 and 32

The fiat or reserve account guid.

string | null

The unique identifier for the customer.

string | null

The unique identifier for the bank-level deposit bank account. This is only required for sub-accounts. Required when type is sub_account.

labels
array of strings | null

The labels associated with the bank account.

labels
Responses

Language
Credentials
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json