Deposits & balances

Read detected on-chain deposits and your collectable balance. Deposits move pending → final once they reach finality; only final deposits count toward your balance.

List deposits#

Browse detected deposits, newest first. Filter by status, chain, or user — a common pattern is polling status=final as a fallback to webhooks.

GET/v1/deposits

List deposits, newest first. All filters are optional.

Query
FieldTypeRequiredDescription
statusstringnoOne of pending, final, reorged.
chainstringnoChain code, e.g. ETH.
user_idstringnoFilter to a single Hbridge user id.
limitnumbernoPage size, 1–200, default 50.
cursorstringnoPass the previous response's next_cursor to fetch the next page.
Request
GET /v1/deposits?status=final&chain=ETH&limit=50
200 Response
{
  "deposits": [
    {
      "id": "6b12...",
      "chain": "ETH",
      "token": "USDC",
      "amount": "2",
      "sender": "0x...",
      "txid": "0x3646...98f9a",
      "status": "final",
      "confirmations": 12,
      "settlement_id": null,
      "created_at": "2026-07-02T10:05:00.000Z"
    }
  ],
  "next_cursor": "6b12...",
  "has_more": true
}

Get deposit#

GET/v1/deposits/:id

Fetch a single deposit. Includes settlement — the payout this deposit was collected into (nulluntil it's paid out).

Path
FieldTypeRequiredDescription
idstringyesThe deposit id.
200 Response
{
  "id": "6b12...",
  "chain": "ETH",
  "token": "USDC",
  "amount": "2",
  "sender": "0x...",
  "txid": "0x3646...98f9a",
  "status": "final",
  "confirmations": 12,
  "finalised_at": "2026-07-02T10:07:00.000Z",
  "settlement": {
    "id": "6c98...",
    "status": "completed",
    "payout_txid": "0x98acc127..."
  }
}

Balances#

Your spendable balance, rolled up per (chain, token). This is the single source of truth for "how much can I pay out right now".

GET/v1/balances

Your collectable balance per (chain, token): the sum of final, not-yet-settled deposits, with the Hbridge fee applied to show net. This is what you can pay out.

200 Response
{
  "fee_bps": 50,
  "balances": [
    {
      "chain": "ETH",
      "token": "USDC",
      "gross": "2",
      "fee": "0.01",
      "net": "1.99",
      "depositCount": 1
    }
  ]
}