DocsStart free
English
API docsBalances

API docsAccount

Balances

Scope balances:read.

Address balances#

GETHTTP
/balances/wallets
Authorization: Bearer cv2_<mode>_<prefix>_<secret>
JSON
{
  "slots": [
    {
      "slotId": "slot-uuid",
      "chainId": "1",
      "address": "0xabc...",
      "state": "available",
      "balances": [
        {
          "assetId": "asset-uuid",
          "assetKey": "native",
          "symbol": "ETH",
          "name": "Ethereum",
          "balance": "1000000000000000000",
          "lastUpdatedAt": "2026-01-01T00:00:00.000Z"
        }
      ],
      "totalBalance": "1000000000000000000"
    }
  ],
  "totals": [
    { "chainId": "1", "assetKey": "native", "symbol": "ETH", "balance": "1000000000000000000" }
  ],
  "totalBalance": "1000000000000000000",
  "count": 1
}

These are the payments Unheld credited to each of your pool addresses (customer deposit addresses and per-invoice Bitcoin addresses are not listed), in base units, for your current mode only. They are refreshed from the chain only when a balance sync is run from the dashboard, so they can lag what an address holds; for what it holds right now, open Wallets in the dashboard or ask the chain.

⚠️ Read totals[] (one figure per network and asset) or each slot's balances[]. Both totalBalance fields add the base units of different assets together and are kept only for compatibility.

Credit balance#

Your prepaid balance with Unheld — what pays our fees, not your customers' money:

GETHTTP
/balances/credits
Authorization: Bearer cv2_<mode>_<prefix>_<secret>
JSON
{ "balance_cents": 5000, "currency": "USD", "updated_at": "2026-01-01T00:00:00.000Z" }

An account that has never topped up reads balance_cents: 0.