Freeplays

Introduction

Freeplays can be granted by operators as an incentive or marketing measure. The hizi.io RGS will take care of assigning / revoking and reporting to the operator.

Prerequisites

The game has to support the getGameConfiguration call to enable the operator to query available stakes.

Note: Freeplays are only supported in Real money mode!

Implementation notes

When freeplays are activated and granted to a player, the game will receive additional information as response to the connect call made by the game to the hizi.io RGS.

        "freePlayInfo": {
                "used": 0,
                "granted": 5,
                "won": 0,
                "isLast": false
        }

The section “freePlayInfo” contains information about any “active” freeplay package giving information about used spins, originally granted spins, total win so far and a flag isLast if that package is finished (i.e. all free spins are used)

        "freePlaysAvailable": [{
                "currency": "EUR",
                "stake": 100,
                "count": 5
        }]

The section freePlaysAvailable contains information about any “available” packages grouped by stake in case multiple packages were granted to the player by the operator

This information is also sent back with every APIV2 request made like startGameRound or collectWin endpoint.

Using a freeplay

When free spins are available for the stake used in the game an additional flag in the startGameRound has to be set to tell the hizi.io RGS to use a freespin available. (see the example with the additional parameters highlighted in red)

                "debitInformation": {
                        "debitAmount": "100",
                        "currency": "EUR",
                        "useTicketInfo": {
                                "useTicket": true
                        }
                }

On return of this call you will receive updated freePlayInfo and freePlaysAvailable information.

Note: In case the free spins are not available or already used an error will be sent back.

Testing of freeplays

In the staging backoffice the “Free plays” section allows this.

Just select a player, number of tickets (=spins) added, currency and stake and submit the package.