API Reference
Wallets
A wallet is one blockchain address holding one asset. RoxCustody creates them for you; you never handle keys.
Wallet types (the "type" field): MASTER (the vault's own wallets), CLIENT (one per client and asset), GAS_STATION (pays network fees on behalf of other wallets), ORDER (receives one payment order) and SYSTEM_FEES.
Balances are strings in the asset's normal unit (for example "1.5" ETH), so very large or precise amounts are never rounded. pendingBalance is the part reserved by transactions that are not completed yet.
List endpoints use cursor pagination: read meta.nextCursor and pass it as the cursor query parameter.
Endpoints
GETGet All Clients' WalletsLists client wallets in this vault, for all clients or, with clientId, for one client.GETGet Vault Gas Station WalletsLists the gas station wallets that pay network fees for this vault. Keep them funded with the network's coin, otherwise token transactions fail with insufficient gas.GETGet Wallet by IDReturns one wallet of this vault, with its current balance and pending balance.GETGet Client Native Coin Wallet by NetworkReturns a client's wallet for the native coin of a network (for example ETH on Ethereum). clientId here is the RoxCustody client ID (a number), not your externalId.GETGet Client Wallet by AssetReturns a client's wallet for one asset, and creates it if it does not exist yet (for example after a new token was added to the vault). clientId here is the RoxCustody client ID (a number).GETGet Wallet NFTsLists the individual NFTs held by a wallet of this vault (one entry per token ID), across all collections.
Was this page helpful?