Skip to main content
GET
/
balances
Get balances (per-user when ``external_ref`` set; else tenant aggregate)
curl --request GET \
  --url https://api.zopay.cash/connect/v1/balances \
  --header 'Authorization: Bearer <token>'
{
  "external_ref": "<string>",
  "valued_at": "2023-11-07T05:31:56Z",
  "balances": [
    {
      "asset": "<string>",
      "amount": "<string>"
    }
  ],
  "totals": {}
}

Authorizations

​
Authorization
string
header
required

Paste your Connect API key (sk_live_… for production, sk_test_… for sandbox) without the Bearer prefix. Mint and rotate keys from the admin panel.

Headers

​
authorization
string | null

Query Parameters

​
external_ref
string | null

The partner's user identifier. Omit to query the tenant-wide aggregate.

Response

Successful Response

Per-user balance response (external_ref was supplied).

​
external_ref
string
required

The partner's user identifier, echoed back.

​
valued_at
string<date-time>
required

Server timestamp when the spot prices were fetched. Partners use this to decide whether to refresh.

​
balances
ConnectBalanceLine · object[]

One row per enabled (asset, network) pair. Empty list when the user has no holdings, including the just-minted case where the external_ref was new to us.

​
totals
Totals · object

Sum of line amount_<fiat> values per enabled fiat currency. Keys are lowercase ISO codes (usd, pen). Values are decimal strings; absent currencies indicate the per-line valuation was unavailable for at least one line (fail-closed total).