Skip to content

API

On this page

Get

Retrieve available token balances, read amounts by coin rather than source network, and use the result before creating a withdrawal.

GET/v1/balances

API key: Payout

Returns the merchant's available balance as a single total per coin, summed across every network — one entry per stablecoin. A balance isn't tied to a network; you choose the network only when you create a withdrawal. Balances that net to zero are omitted. The key's environment selects the dataset: a sandbox key returns sandbox balances, a live key returns live ones.

Response (200 OK)

[
  { "currency": "USDT", "available": "1750.50" },
  { "currency": "USDC", "available": "500.00" }
]

Response fields

The response is an array with one entry per coin — the total across every network.

Field Type Description
currency string Token symbol — e.g. USDT, USDC, DAI
available string Available balance in the token's own units, totalled across all networks, as a decimal string (dot separator)

Errors

Balances require a Payout (rk_) key — a Payment key is rejected with 403 payout_key_required. See Error Codes for the full catalogue. The type URI in every error response deep-links to the matching row.

Simulate Withdrawal Completion Webhooks