Get balance

---

GET /api/distributor/balance/check

This GET method enables to retrieve the current available balance of the authenticated client in the Keepz system.

Authentication

This endpoint requires an OAuth 2.0 Bearer Token. Pass the access_token obtained from the authentication flow in the Authorization header:

Authorization: Bearer <access_token>

Request details

Query parameters

Parameter	Type	Required	Description	Possible Values	Note
currency	string	❌	Currency for which balance should be checked.	GEL, USD, EUR	If omitted, the response may return default account balance.

Response details

✅ Success Response

If the request is valid, the API returns next payload:

{
  "value": {
    "amount": 2500.2
  }
}

Inside value object, the following parameters are available:

Parameter	Type	Description
amount	number	Current balance available for the client.

❌ Error Response

If an error occurs, the API returns next payload:

{
  "message": "Client balance not found with given client id",
  "statusCode": 5015
}

Parameter	Type	Description
message	string	Error message. Details are provided in the dedicated section below.
statusCode	number	Error status code. Details are provided in the dedicated section below.

⚠️ Important: Make sure to include the Bearer token in the Authorization header for all requests. The balance information is real-time and may change frequently.

Details can be found at Error Code Description.