Skip to main content
The register endpoint starts a bonus campaign for a specific player. You specify whether it’s a Free Spin Bonus (predefined free spins) or a Regular Bonus Call (a guaranteed winning amount). Only one active bonus call can run per player at a time. Once the bonus completes in one of the configured games, it will not be triggered again for any other game in the same registration.

​
Request

Endpoint: POST /v1/bonus-call/register Headers

​
Request body

​
string
required
Your own unique identifier for this bonus request.
​
number
required
The numeric ID of the game provider under which the bonus will be active.
​
number
required
Specifies which games can trigger the bonus event.
​
string
required
The player’s unique identifier in your system.
​
number
required
The type of bonus to register.
  • 1 — Free Spin Bonus. The player receives a set number of free spins; callAmount acts as the maximum win cap. Available for Pragmatic Play only.
  • 2 — Regular Bonus Call. The player is guaranteed to win the callAmount by the end of the campaign. This Regular Bonus is not active at the moment. Only Free Spin Bonus is available at the moment.
​
number
required
The monetary value associated with the bonus.
  • For bonusType = 1: the maximum amount the player can win across all free spins.
  • For bonusType = 2: the player will win exactly this amount.
​
string
required
The timestamp at which the bonus expires, in YYYY-MM-DD HH:mm:ss format (e.g., "2026-12-01 23:59:59").
​
object
Additional configuration for the bonus. Required when bonusType = 1.

​
Example request

For a Regular Bonus Call (bonusType = 2), you can omit metaData entirely. For a Free Spin Bonus (bonusType = 1), both metaData.spinAmount and metaData.baseBetAmount are required.

​
Response

On success, the API returns the issueId you should store to track or cancel the bonus later.
​
bool
true when the API call was processed without errors.
​
string
A short confirmation string, typically "OK".
​
object
The result payload.

​
Example response