API Reference
Vaults
A vault is a separate custody account inside your company's RoxCustody workspace. Your API key belongs to one vault, and every request only sees that vault's data.
Vault types (vaultType): api_segregated (each client gets their own wallets), api_consolidated (client balances are tracked separately but funds are held together), internal, escrow, payment (crypto payment orders), fiat_segregated and fiat_payment (fiat clients and fiat payment orders). The type decides which endpoints you can use: for example payment orders need a payment vault, and fiat endpoints need a fiat vault.
Approvers: outgoing transactions may need approval by vault admins, according to the vault's payment policy. Get Vault Approvals lists these admins and Get Vault Payment Policy shows the rules.
This section also covers webhooks, which push events to your server (see the Webhooks guide).
Endpoints
GETGet Vault DetailsReturns the vault your API key belongs to: name, type, category (CRYPTO or FIAT), allowed origins, webhook and fiat currency.GETGet Vault ApprovalsLists the admins who approve this vault's outgoing transactions.GETGet Vault AssetsLists the assets (coins and tokens) enabled in this vault. Use the asset id in transactions, wallet lookups and payment orders.GETGet Vault NetworksLists the blockchain networks enabled in this vault.GETGet Vault Payment PolicyReturns the vault's payment policy: the amount ranges that decide how many approvals an outgoing transaction needs, and from whom.GETGet Master WalletLists the vault's own (MASTER) wallets, one per enabled asset.POSTVerify WebhookRegisters your webhook endpoint for this vault. RoxCustody immediately sends a test POST with an empty JSON body to the URL, signed with your secret; your server must answer with a 2xx status within 10 seconds, otherwise the call fails. Next, choose events with Create Webhook Events. A vault has one webhook.POSTCreate Webhook EventsChooses which events are sent to your webhook, and the default retry settings. Call it once after Verify Webhook; use Update Webhook Events for later changes. To subscribe to every event available to your vault type, send "events": [-1].PATCHUpdate Webhook EventsReplaces the list of events you are subscribed to. Send the full list you want: events not listed are unsubscribed. Send [-1] to subscribe to all events, or omit events (or send []) to unsubscribe from all. Per-event retry settings are kept.
Was this page helpful?