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.

Request

Header Params

X-Counterparty-Id

string

required

The public identifier of the subject provided during the onboarding process.

Example:

933a215f-a9e6-4f88-9d91-52a87cd50499

X-Timestamp

number

required

13 digits Unix epoch timestamp. Request generation time. All requests longer than 30 seconds will be considered expired.

Example:

1719766120806

X-Request-Id

string

required

A random sequence of 32 hexadecimal digits (Nonce) representing a unique request identifier.

Example:

5a0679b6e5fa48f6892c777b0fa92392

X-Sign

string

required

HMAC.SHA256 message signature.

Example:

c4d62f77cdfaadb6690b3bcbe5a0ca9ef1e5bf41d746d361a1269558eeb7ccd1

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

application/json

Body

currency

string

optional

Currency code according to ISO 4217.

balance

number

optional

User balance.

_responseCode

integer

required

Response code.

Example

{
    "currency": "EUR",
    "balance": 750.5,
    "_responseCode": 1
}

Overview#

Security and Authentication#

Path Parameters#

Request

Request samples

Responses

Overview

Security and Authentication

Path Parameters