Balance

Overview

The Balance endpoint is used to retrieve the current financial status of a user’s account. This includes key details such as the currency type, the current balance, and a response code indicating the outcome of the request. This endpoint is critical for verifying that previous betting transactions (such as bets placed or payouts) have been accurately reflected in the user’s account.

The main objectives of the Balance method are:

Account Verification: It allows to fetch the user’s current account balance and verify that recent transactions (bet placements, payouts, or refunds) have been correctly recorded.

User Experience Consistency: By retrieving accurate balance information, the user interface can display up-to-date account status to the user, which is essential for managing wagers and planning further bets.

Transaction Reconciliation: It supports back-end reconciliation processes, ensuring that the financial state of the user's account remains consistent across all transactions.

Security and Authentication

The Balance endpoint, like other API requests within this integration, requires strict authentication to ensure that only authorized parties can interact with it. This is achieved through the use of mandatory HTTP headers. Please see the required headers below in the Header Params section.

📌

Signature of the request shall be calculated using HMAC-SHA256 algorithm and sent in "X-Sign" header of the request.
Please see How to calculate the X-Sign value.

Path Parameters

Parameter	Type	Required	Description
sessionId	string	Yes	User session ID.

curl --location -g --request GET '/v1/sessions/{{sessionId}}/balance' \ --header 'X-Counterparty-Id: 933a215f-a9e6-4f88-9d91-52a87cd50499' \ --header 'X-Timestamp: 1719766120806' \ --header 'X-Request-Id: 5a0679b6e5fa48f6892c777b0fa92392' \ --header 'X-Sign: c4d62f77cdfaadb6690b3bcbe5a0ca9ef1e5bf41d746d361a1269558eeb7ccd1'

Overview#

Security and Authentication#

Path Parameters#

Request

Responses

Overview

Security and Authentication

Path Parameters