Skip to main content
A vault is an account that holds assets. There are two types:
  • Multi-currency accounts: one vault per currency, identified by its asset field. For example, an NGN vault has asset: "NGN".
  • Self-custody vaults: hold on-chain assets in blockchain wallets you control. Addresses are listed in wallets, and asset is null.
To fund a vault, call the deposit instructions API (GET /api/external/vaults/{vaultId}/deposit_instructions/) to get the details for sending funds into it. Use the other APIs below to list, retrieve, and create vaults and to check balances.
Lifecycle: A new vault needs your API user’s approval. See Approvals. For blockchain wallets, creation can return before wallet addresses are generated. Treat walletsGenerated as the readiness signal; do not infer readiness from HTTP 201 alone.

List vaults

GET /api/external/vaults/

Retrieve a vault

GET /api/external/vaults/{vaultId}/

Create a vault

POST /api/external/vaults/

Read balances

GET /api/external/vaults/{vaultId}/detailed_balances/

Get deposit instructions

GET /api/external/vaults/{vaultId}/deposit_instructions/