Balance - Retrieve Player Balance

Retrieves the current player balance, including any free game offer instances available for this game.

POST /v1/balance

Headers: X-HMAC-Signature, Authorization, X-Request-ID

Request

Request Parameters

Field	Required/Optional	Data Type	Description
playerId	Required	string	Unique identifier for the player.
provider	Required	string	Identifier for the game provider.
game	Required	string	Identifier for the game being launched.

Request Example

JSON

{
  "playerId": "44-12345-67890",
  "provider": "gameprovider",
  "game": "fantasyquest"
}

Response

Response Parameters

Field	Required/Optional	Data Type	Description
balance	Required	decimal	Current balance of the player, in player’s currency.
freeGameInfo	Optional	array	List of free game offers available to the player for this game.

Response Example

JSON

{
  "balance": 1500.50,
  "freeGameInfo": [
    {
      "instanceId": 1,
      "offerId": 99,
      "offerName": "Sample Free Spins",
      "instanceInfo": {
        "canBeRejected": false,
        "nearestCostPerBet": 5,
        "numberOfRoundsRemaining": 3,
        "numberOfRoundsAwarded": 10,
        "instanceStartDateUtc": "2025-05-23T11:54:37Z",
        "instanceEndDateUtc": "2025-05-25T13:34:37Z"
      }
    }
  ]
}