Balances¶

Returns balance data for the merchant context.

Use this endpoint to retrieve wallet-level and gate-level balances grouped by currency.

Endpoint¶

GET /api/v1/balances

GET /api/v1/balances HTTP/1.1
X-Api-Key-Id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
X-Signature: <generated-signature>
X-Timestamp: 1234567
Accept: application/json

[
  {
    "currency": "USD",
    "wallet_balance": 0,
    "gate_balances": [
      {
        "merchant_gate_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "available_balance": 0,
        "hold_balance": 0,
        "rolling_balance": 0,
        "total_balance": 0
      }
    ]
  }
]

X-Api-Key-Id string · uuid required

API key identifier issued for the merchant integration.

X-Signature string required

Request signature generated from the HTTP method, request path without query string, raw request body, and timestamp.

X-Timestamp integer · int64 required

Unix epoch timestamp in seconds used in the signature base string.

Request signature

This endpoint requires the X-Signature header. This GET request has no request body, so the signature base string uses an empty request body value. For signature generation rules, see Request Signature Authentication.

Responses

200 OK. Balances returned successfully. application/json

Returns an array of balance objects. Each object contains balance information for one currency in the merchant context.

Items array<object>

Balance object for one currency.

currency string · enum

Currency for which the wallet and gate balances are returned.

Possible values:

USDEURUAHKZTUSDT_TRON

wallet_balance number

Wallet-level balance amount for the currency in the merchant context.

gate_balances array<object>

List of gate-level balance objects for the currency.

merchant_gate_id string · uuid

Identifier of the merchant gate for which the gate-level balance values are returned.

available_balance number

Gate balance amount available for new operations.

hold_balance number

Gate balance amount currently held or reserved and not available for new operations.

rolling_balance number

Gate balance amount kept as rolling reserve.

total_balance number

Total gate balance amount returned for the merchant gate.

Balances¶

Endpoint¶

Headers

Responses