Balance

Retrieves the merchant's total balance (sum of all terminal balances).

Endpoint

GET /v1/balance

Request Example

curl -X GET https://api.bopay.io/v1/balance \
  -H "X-Identity: your-api-key" \
  -H "X-Signature: your-signature"

Response

{
  "balance": 5000.50,
  "balance_frozen": 150.00,
  "currency": "USDT"
}

Response Fields

Field	Type	Description
balance	number	Total available balance across all terminals (USDT)
balance_frozen	number	Total frozen balance (USDT)
currency	string	Currency (USDT)

tip

To view individual terminal balances, use GET /v1/terminals.