Skip to main content

Get balance

Request

URI: /getBalance?{parameters}

Example usage: https://{callback_url}/getBalance?{parameters}

The request is executed using the GET method.

This method is used to retrieve data on the user's balance.
A player may have multiple balances if a bonus is activated.
In this case, the player will have a total, real, and bonus balance.

Request parameters

NameTypeRequiredDescription
tokenstringYesAuthorization code of the user's session
Restrictions: 1..250
userIdstringYesThe unique identifier of the user

Response parameters

NameTypeRequiredDescription
statusbooleanYesResponse status code for Callback API
Accepted values: true, false
balancedecimalYesPlayer's latest balance at the time of request completion
balance is the sum of realBalance and bonusBalance parameters
Decimal format required
Player's balance is rounded to the smallest currency unit
Maximum possible value:
  • Fiat currencies - 999999999999999999.99
  • Cryptocurrencies - 999999999999.99999999
  • realBalancedecimalYesPlayer's real balance at the time of request completion
    Decimal format required
    Maximum possible value:
  • Fiat currencies - 999999999999999999.99
  • Cryptocurrencies - 999999999999.99999999
  • bonusBalancedecimalYesPlayer's bonus balance at the time of request completion
    Decimal format required
    Maximum possible value:
  • Fiat currencies - 999999999999999999.99
  • Cryptocurrencies - 999999999999.99999999
  • errorsobjectNoDescription of errors in case status = false
    errors.codenumberNoError code
    errors.errorstringNoError description

    Example of a successful response

    Response: /getBalance?{parameters}
    {
    "status": true,
    "balance": 124999.99,
    "realBalance": 124999.09,
    "bonusBalance": 0.90,
    }

    Example of an unsuccessful response

    Response: /getBalance?{parameters}
    {
    "status": false,
    "errors": {
    "code": 400,
    "error": "Description"
    }
    }