Free Bets APIs are disabled by default. To enable this feature, please contact your account manager.
betAmount is debited from the player's balance. You will receive value of zero in webhook requests.winAmount in /result webhook is credited to player's wallet balance, same behavior of a normal bet.freeBetAmount which is equal to the minimum bet amount.promotionId and consumption is restricted to specific gameId and currency.promotionId.expiresAt property defined on Free Bets issuance. Player can no longer consume Free Bets expired under specific promotionId.playerId until depletion as long as they are not removed nor expired.FreeBetSource. Explained in the table below.BetRequestItem
| Key | Value Type | Required | Description |
|---|---|---|---|
betAmount |
number | Yes | Will always be zero for Free Bets. Nothing to withdraw from your player's wallet balance. |
extraData |
object | No | Optional extra meta data if applicable. In this case it's used to communicate Free Bet properties. |
extraData.isFreeBet |
boolean | No | Indicates if this bet is a Free Bet. |
extraData.promotionId |
string | No | Unique identifier for the promotion associated with the Free Bet. |
extraData.freeBetSource |
string | No | Indicates the source of the Free Bet. |
extraData.freeBetAmount |
number | No | Indicates the bet amount of the Free Bet. In bet currency BetRequestItem.currecy. |
ResultRequestItem
| Key | Value Type | Required | Description |
|---|---|---|---|
extraData |
object | No | Optional extra meta data if applicable. In this case it's used to communicate Free Bet properties. |
extraData.isFreeBet |
boolean | No | Indicates if this bet is a Free Bet. |
extraData.promotionId |
string | No | Unique identifier for the promotion associated with the Free Bet. |
extraData.freeBetSource |
string | No | Indicates the source of the Free Bet. |
extraData.freeBetAmount |
number | No | Indicates the bet amount of the Free Bet. In bet currency ResultRequestItem.currecy. |
RollbackRequestItem
| Key | Value Type | Required | Description |
|---|---|---|---|
betAmount |
number | Yes | Will always be zero for Free Bets. Nothing to refund to your player's wallet balance on rollback. |
extraData |
object | No | Optional extra meta data if applicable. In this case it's used to communicate Free Bet properties. |
extraData.isFreeBet |
boolean | No | Indicates if this bet is a Free Bet. |
extraData.promotionId |
string | No | Unique identifier for the promotion associated with the Free Bet. |
extraData.freeBetSource |
string | No | Indicates the source of the Free Bet. |
extraData.freeBetAmount |
number | No | Indicates the bet amount of the Free Bet. |
| Value | Description |
|---|---|
PROVIDER |
The Provider issued Free Bet to the player via Backoffice. |
OPERATOR |
The Operator issued Free Bet to the player via Add Free Bets Provider API Endpoint. |
SPIN_TO_WIN |
In-game promotion Spin-to-Win issued Free Bet to the player. |