Gift Spins

Gift Spins (free rounds) let the casino grant a player a number of rounds on a given game. Only games with has_freespins: 1 in the Gamelist support them.

Rounds played from a Gift Spin session are reported through the normal bet and win callbacks, carrying the freespins_id you supplied here, and freespins_finished on the last one.

Create Gift Spin

Request


[POST] {PROVIDER_URL}/v1/create-freespins

Parameter	Type	Required	Description
casino_id	integer	yes	provided by the game provider
user_id	integer	yes	user’s ID at the casino
username	string	yes	user’s username
currency	string(3)	yes	currency code in ISO 4217 format
game_id	integer	yes	unique game id
freespins_id	string	yes	your unique Gift Spin ID, echoed back in the bet and win callbacks
start_at	string	no	start date of the Gift Spin, format `Y-m-d H:i:s`
valid_until	string	yes	expiry date of the Gift Spin, format `Y-m-d H:i:s`
count	integer	yes	number of rounds granted
bet	integer	no	fixed bet in cents per payline, defaults to the game’s minimum bet
line	integer	no	fixed number of paylines for the session

Request body:


{
    "casino_id": 1,
    "user_id": 10000,
    "username": "user123",
    "currency": "USD",
    "game_id": 19773,
    "freespins_id": "gs-2024-0001",
    "start_at": "2024-09-23 10:00:00",
    "valid_until": "2024-09-30 23:59:59",
    "count": 20,
    "bet": 25,
    "line": 10
}

bet is an integer in cents, unlike the amount of the bet and win callbacks, which is a decimal in the major currency unit. bet: 25 means 0.25 USD.

Response

Successful response will be returned as a json object.


{
    "code": 200,
    "message": "Freespins created successfully"
}

A Gift Spin that is no longer valid is rejected with error 1011.

Cancel Gift Spin

Cancels a Gift Spin that has been created but not yet played out.

Request


[POST] {PROVIDER_URL}/v1/cancel-freespins

Parameter	Type	Required	Description
casino_id	integer	yes	provided by the game provider
game_id	integer	yes	unique game id
freespins_id	string	yes	the Gift Spin ID used at creation
user_id	integer	yes	user’s ID at the casino
username	string	yes	user’s username
currency	string(3)	yes	currency code in ISO 4217 format

Request body:


{
    "casino_id": 1,
    "game_id": 19773,
    "freespins_id": "gs-2024-0001",
    "user_id": 10000,
    "username": "user123",
    "currency": "USD"
}

Response

Successful response will be returned as a json object.


{
    "code": 200,
    "message": "Freespins [ID] cancelled successfully"
}