Activate Free Spin Bonus

Request​

URI: /activateFsb

Example usage: https://{base_url}/activateFsb

The request is executed using the POST method.

This endpoint is used to activate free spin bonus for a player. It should be called once the player is validated and ready to receive a Free Spin Bonus.

note

The bonus is valid for up to 1 month after activation, and the bonusExpired date must not exceed 30 days from the bonusStart date; any expiration period longer than 1 month will be rejected

Request parameters

Name	Type	Required	Description
userId	string	Yes	Unique identifier of the player in the operator’s system
country	string	Yes	Player’s country code in ISO 3166-1 format (e.g., UA, DE, BR)
token	string	Yes	Player token used to validate communication between the platform and the aggregator service. Acts like a changing password that ensures the player session is authenticated
gameId	string	Yes	Identifier of the game for which the bonus is being applied
bonus	object	Yes	Object containing the Free Spin bonus details, including the bonus name, number of spins, bet amount per spin, start and expiration date and time
bonus.bonusName	string	Yes	Unique name or identifier for the bonus campaign
bonus.bonusRounds	string	Yes	Total number of granted free spins
bonus.bonusBet	string	Yes	Bet amount applied per free spin
bonus.bonusExpired	string	Yes	Bonus expiration time in ISO 8601 format Represents the exact time the bonus will expire
bonus.bonusStart	string	Yes	Bonus start time in ISO 8601 format Represents the exact time the bonus will start

Example of a request

Request: /activateFsb

{
    "userId":"1015720",
    "country":"UA",
    "token":"kP1Rkyjj52i7up91",
    "gameId":"1037566",
    "bonus":{
        "bonusName":"test1604291",
        "bonusRounds":"2",
        "bonusBet":"20",
        "bonusExpired":"11-06-2025 15:00:15", 
        "bonusStart":"09-06-2025 12:00:10"
    }
}

Response parameters

Name	Type	Required	Description
status	boolean	Yes	Indicates whether the request was successfully processed true: Bonus was successfully activated false: Bonus activation failed
code	integer	Yes	Error code For a complete list of possible error responses, please refer to link
error	string	Yes	Type of error
details	array	Yes	Additional information about the error

Example of a successful response

Response: /activateFsb

{
  "status": true
}

Example of an unsuccessful response

Response: /activateFsb

{
  "code": 2007,
  "error": "Free spin exceeds30 days",
  "status": false,
  "details": [
    "Bonus expiration date is more than 30 days from the start date."
  ]
}