4. Balance

GET /api/v1/balance

Returns the balance of the selected EPT VND shop.

Request

Headers

Parameter	Type	Required	Description
X-API-Key	string	Yes	API key.
X-Timestamp	string	Yes	Request time in ISO-8601 UTC format.
X-Signature	string	Yes	HMAC-SHA256 of timestamp + raw_request_body. The body is empty for GET requests.

Query

Parameter	Type	Required	Description
shop_code	string	No	Shop code. If omitted, the merchant's default active shop is used.
currency	string	No	Use VND for an EPT VND shop. If omitted, the API defaults to RUB.

Example request

GET /api/v1/balance?shop_code=your_ept_vnd_shop&currency=VND

Response

Monetary values are decimal strings normalized for the requested currency.

Field	Description
currency	Requested currency (VND).
shop	Selected shop ID and code.
as_of	Balance snapshot time.
balance	Alias of available kept for this endpoint.
available	Spendable merchant funds in the selected shop.
pending	Total funds held for pending PayIn and PayOut operations.
held_payin_pending	Portion of pending held for PayIn operations.
payout_reserved	Portion of pending reserved for PayOut operations.
frozen	Funds unavailable for spending.
credit	Spendable credit bucket for PayOut operations.
total	Sum of all balance buckets.
on_hold	Alias of payout_reserved.
buckets	Full bucket map.
pending_breakdown	Pending PayIn and PayOut amounts by bucket.

{
  "currency": "VND",
  "shop": {
    "id": 42,
    "code": "your_ept_vnd_shop"
  },
  "as_of": "2026-09-21T10:00:00+00:00",
  "balance": "98500000",
  "available": "98500000",
  "pending": "1500000",
  "held_payin_pending": "500000",
  "payout_reserved": "1000000",
  "frozen": "0",
  "credit": "5000000",
  "total": "105000000",
  "on_hold": "1000000",
  "buckets": {
    "available": "98500000",
    "pending": "1500000",
    "frozen": "0",
    "credit": "5000000"
  },
  "pending_breakdown": {
    "payin_hold": "500000",
    "payout_reserved": "1000000"
  }
}

See API Errors for common error responses.