Skip to content
Reference / API reference
Reference
On this page

API reference

Generated from the OpenAPI document, version 1.0.0+2026-11-07. The same document is available to download.

Getting started

GET

/v1/ping

Verify signing and clock

Signed
Response 200 · Ping
FieldTypeRequiredDescription
operator_codestringyes
key_idstringyes
server_timestring (date-time)yes
POST

/v1/debug/signature

Sandbox only: check a signature step by step (not signed)

Not signed
Request body · object
FieldTypeRequiredDescription
key_idstringyesThe X-Agg-Key-Id you sent
timestampstringyesThe X-Agg-Timestamp you sent, Unix seconds
signaturestringyesThe X-Agg-Signature you sent
methodstringyesGET, POST, PUT or DELETE
pathstringyesPath and query exactly as sent
bodystring | nullnoThe raw body; null or absent for a request without one
Response 200 · object
FieldTypeRequiredDescription
validbooleanno
diagnosisstringnoOne sentence: what is wrong, or that nothing is
keyobjectno
timestampobjectno
payloadobjectno
canonical_stringstringnotimestamp + "." + payload, exactly what is signed
signatureobjectno
hintsstring[]no
404Not a sandbox installation422VALIDATION_FAILED429RATE_LIMITED500UPSTREAM_UNAVAILABLE

Catalogue

GET

/v1/games

Games you may offer, paged by cursor

Signed
Parameters
FieldTypeRequiredDescription
type (query)GameTypeno
provider_code (query)stringnoOne provider, as GET /v1/providers names it
studio_code (query)stringnoDeprecated Deprecated: the same filter as provider_code under its older name; wins when both are sent.
country (query)stringnoISO 3166-1 alpha-2. Leaves out games that cannot be played in that country.
cursor (query)stringnonext_cursor of the previous page
limit (query)integerno1..200, default 50. Above 200 is cut to 200; below 1 is VALIDATION_FAILED.
Response 200 · GamesPage
FieldTypeRequiredDescription
gamesGame[]yes
next_cursorstring | nullyesPass back as cursor; null on the last page
GET

/v1/providers

Providers behind the games, whole list

Signed
Response 200 · object
FieldTypeRequiredDescription
providersProvider[]yes
GET

/v1/images/{id}

An image by id (not signed)

Not signed
Parameters
FieldTypeRequiredDescription
id (path)stringnoImage id from an images URL
404No such image
GET

/v1/rates

Your revenue-share percent per provider and band

Signed
Response 200 · Rates
FieldTypeRequiredDescription
revenue_baseggr | ngrno
marketrest_of_world | asiano
regulatedbooleanno
tier_modewhole | progressiveno
providersobject[]no
GET

/v1/invoices/estimate

What your invoice would say if it were drawn now

Signed
Parameters
FieldTypeRequiredDescription
from (query)string (date)noFirst day, YYYY-MM-DD; with to. Both absent: the first of the month
to (query)string (date)noLast day, included; with from, at most 366 days after it. Both absent: today
Response 200 · InvoiceEstimate
FieldTypeRequiredDescription
period_fromstring (date-time)noStart of the period, UTC midnight
period_tostring (date-time)noEnd of the period, exclusive: the midnight after its last day, UTC
as_ofstring (date-time)noWhen the estimate was drawn
revenue_baseggr | ngrno
linesobject[]no
GET

/v1/live-tables

Live Casino tables on your games as they stand now, limits in one currency

Signed
Parameters
FieldTypeRequiredDescription
currency (query)stringnoISO code the limits are wanted in
Response 200 · LiveTables
FieldTypeRequiredDescription
currencystringyes
pendingbooleanyesThe currency was asked for the first time just now; its tables arrive within seconds
tablesLiveTable[]yes

Wallet integration

POST

/v1/test/wallet-validation

Sandbox only: run the wallet test suite against your wallet

Signed
Request body · object
FieldTypeRequiredDescription
player_idstringyesYour test player, with at least 10.00
currencystringyesThe currency of that balance
Response 202 · WalletValidationRun
FieldTypeRequiredDescription
idstring (uuid)no
statusstringnoqueued, running, passed, failed or error
passedintegerno
warnedintegerno
failedintegerno
skippedintegerno
totalintegerno
errorstringnoWhy the run could not be carried out
casesobject[]no
GET

/v1/test/wallet-validation/{id}

Sandbox only: a run and every case so far

Signed
Parameters
FieldTypeRequiredDescription
id (path)stringnoThe run id from the start
Response 200 · WalletValidationRun
FieldTypeRequiredDescription
idstring (uuid)no
statusstringnoqueued, running, passed, failed or error
passedintegerno
warnedintegerno
failedintegerno
skippedintegerno
totalintegerno
errorstringnoWhy the run could not be carried out
casesobject[]no

Sessions

POST

/v1/sessions

Open a game for a player

Signed
Request body · CreateSession
FieldTypeRequiredDescription
player_idstringyesYour reference, up to 120 characters
currencystringyesISO 4217, fixed for the session
game_idstringyesid from GET /v1/games
localestringnoen, ru-RU, …; at most 20 characters
lobby_urlstringno
ttl_minutesintegerno
player_countrystringnoISO 3166-1 alpha-2
player_ipstringnoThe player's own address; the country is read off it
player_devicedesktop | mobileno
deposit_urlstringno
player_namestringnoNickname other players see in multiplayer games; never the real name
brandobjectnoWhich of your brands the player plays on. Providers that keep an account per brand open the game under that brand’s account; absent, under yours.
Response 200 · Session
FieldTypeRequiredDescription
session_idstringyes
launch_urlstringyesOpen the game here; never build it yourself
expires_atstring (date-time)yes
POST

/v1/games/{id}/demo

Fun play without a player or wallet

Signed
Parameters
FieldTypeRequiredDescription
id (path)stringnoGame id from GET /v1/games
Request body · CreateDemo
FieldTypeRequiredDescription
localestringno
lobby_urlstringno
player_countrystringno
player_ipstringno
player_devicedesktop | mobileno
Response 200 · object
FieldTypeRequiredDescription
launch_urlstringyes
POST

/v1/sessions/{id}/close

End a session

Signed
Parameters
FieldTypeRequiredDescription
id (path)stringnosession_id from POST /v1/sessions
Response 200 · ClosedSession
FieldTypeRequiredDescription
session_idstringno
statusstringno
closed_atstring (date-time)no

Promotions

POST

/v1/free-spins

Grant free spins; idempotent on reference

Signed
Request body · CreateFreeSpins
FieldTypeRequiredDescription
player_idstringyes
currencystringyes
game_idsstring[]yes
quantityintegeryes
bet_amountstringyesStake of one spin, from GET /v1/free-spins/bet-options
valid_untilstring (date-time)yesIn the future, at most 90 days away
referencestringyesYour id for the grant; a repeat answers the first grant
brandobjectnoWhich of your brands the player plays on, as in POST /v1/sessions. Providers that keep an account per brand place the series under that brand’s account; absent, the brand of the player’s latest session, then yours.
buy_in_idstringnoA bought feature each spin opens with, from GET /v1/free-spins/buy-ins; needs exactly one game
Response 200 · FreeSpins
FieldTypeRequiredDescription
idstringno
free_spins_idstringnoWhat your wallet sees on the bets and wins of the series
statuspending | active | finished | failed | cancellednopending: not yet confirmed by the game provider; failed: refused by it, and a repeat under the same reference places it again
player_idstringno
currencystringno
game_idsstring[]no
quantityintegerno
bet_amountstringnoStake of one spin
valid_untilstring (date-time)no
referencestringno
created_atstring (date-time)no
finished_atstring | null (date-time)no
cancelled_atstring | null (date-time)no
win_amountstring | nullnoTotal paid, for game providers that settle the series in one call
buy_in_idstring | nullnoThe bought feature each spin opens with, when the grant named one
GET

/v1/free-spins

Find a grant by your reference

Signed
Parameters
FieldTypeRequiredDescription
reference (query)stringno
Response 200 · FreeSpins
FieldTypeRequiredDescription
idstringno
free_spins_idstringnoWhat your wallet sees on the bets and wins of the series
statuspending | active | finished | failed | cancellednopending: not yet confirmed by the game provider; failed: refused by it, and a repeat under the same reference places it again
player_idstringno
currencystringno
game_idsstring[]no
quantityintegerno
bet_amountstringnoStake of one spin
valid_untilstring (date-time)no
referencestringno
created_atstring (date-time)no
finished_atstring | null (date-time)no
cancelled_atstring | null (date-time)no
win_amountstring | nullnoTotal paid, for game providers that settle the series in one call
buy_in_idstring | nullnoThe bought feature each spin opens with, when the grant named one
GET

/v1/free-spins/bet-options

Stakes the game provider accepts for a grant

Signed
Parameters
FieldTypeRequiredDescription
game_id (query)stringno
currency (query)stringno
brand (query)stringnoYour brand code, as brand.code in POST /v1/sessions. A provider with an account per brand answers that account's stakes.
player_id (query)stringnoWithout brand, the brand of this player's latest session is taken.
Response 200 · object
FieldTypeRequiredDescription
game_idstringyes
currencystringyes
amountsstring[]yes
GET

/v1/free-spins/buy-ins

Bought features a free spin of the game may open with

Signed
Parameters
FieldTypeRequiredDescription
game_id (query)stringno
currency (query)stringno
Response 200 · object
FieldTypeRequiredDescription
game_idstringyes
currencystringyes
buy_insobject[]yes
GET

/v1/free-spins/providers

The providers whose games take free-spin grants

Signed
Response 200 · object
FieldTypeRequiredDescription
provider_codesstring[]yes
GET

/v1/free-spins/{id}

Read a grant

Signed
Parameters
FieldTypeRequiredDescription
id (path)stringnoGrant id
Response 200 · FreeSpins
FieldTypeRequiredDescription
idstringno
free_spins_idstringnoWhat your wallet sees on the bets and wins of the series
statuspending | active | finished | failed | cancellednopending: not yet confirmed by the game provider; failed: refused by it, and a repeat under the same reference places it again
player_idstringno
currencystringno
game_idsstring[]no
quantityintegerno
bet_amountstringnoStake of one spin
valid_untilstring (date-time)no
referencestringno
created_atstring (date-time)no
finished_atstring | null (date-time)no
cancelled_atstring | null (date-time)no
win_amountstring | nullnoTotal paid, for game providers that settle the series in one call
buy_in_idstring | nullnoThe bought feature each spin opens with, when the grant named one
POST

/v1/free-spins/{id}/cancel

Withdraw an active grant; idempotent

Signed
Parameters
FieldTypeRequiredDescription
id (path)stringnoGrant id
Response 200 · FreeSpins
FieldTypeRequiredDescription
idstringno
free_spins_idstringnoWhat your wallet sees on the bets and wins of the series
statuspending | active | finished | failed | cancellednopending: not yet confirmed by the game provider; failed: refused by it, and a repeat under the same reference places it again
player_idstringno
currencystringno
game_idsstring[]no
quantityintegerno
bet_amountstringnoStake of one spin
valid_untilstring (date-time)no
referencestringno
created_atstring (date-time)no
finished_atstring | null (date-time)no
cancelled_atstring | null (date-time)no
win_amountstring | nullnoTotal paid, for game providers that settle the series in one call
buy_in_idstring | nullnoThe bought feature each spin opens with, when the grant named one
POST

/v1/bonus-campaigns

Place a bonus campaign for your players; idempotent on reference

Signed
Request body · CreateBonusCampaign
FieldTypeRequiredDescription
typeBonusCampaignTypeyes
namestringyesShown to the player in the game
currencystringyesISO 4217; the game provider may take bonuses in some currencies only
game_idsstring[]yes
player_idsstring[]yes
valid_fromstring (date-time)noOptional; the campaign starts now when absent
valid_untilstring (date-time)yesIn the future, after valid_from, at most 90 days after it
triggersBonusTriggersyesAt least one trigger. Each trigger that fires hands the bonus over once more.
spin_countintegernofree_spins only, required there
bet_amountstringnofree_spins and buy_bonus only, required there: stake of one spin, or the price of the bought bonus
prizesBonusPrize[]noDrawn types only: exactly 16 for fortune_wheel and treasure_chest, 1 to 100 for golden_dragon; at least one weight above 0
min_cashout_multiplierstringnofree_spins on crash games: the least multiplier a spin cashes out at, 1.3 to below 100
campaign_limitstringnoOptional: the total the campaign pays before it ends
referencestringyesYour id for the campaign; a repeat answers the first campaign
Response 200 · BonusCampaign
FieldTypeRequiredDescription
idstringyes
campaign_idstringyesWhat your wallet sees as free_spins_id on the spins this campaign hands over
typeBonusCampaignTypeyes
statuspending | active | ended | failed | cancelledyesended: past valid_until; failed: the game provider refused it, see failure_reason; cancelled: ended early with POST /v1/bonus-campaigns/{id}/cancel
namestring | nullno
currencystring | nullno
game_idsstring[]yes
player_idsstring[]yes
valid_fromstring | null (date-time)no
valid_untilstring | null (date-time)no
triggersobjectyes
spin_countinteger | nullno
bet_amountstring | nullnofree_spins: stake of one spin
prizesBonusPrize[]yes
min_cashout_multiplierstring | nullno
campaign_limitstring | nullnoThe total the campaign pays before it ends
referencestring | nullno
failure_reasonstring | nullnoWhy the game provider refused it, when status is failed
created_atstring | null (date-time)no
GET

/v1/bonus-campaigns

Find a campaign by your reference, or list the campaigns of one player

Signed
Parameters
FieldTypeRequiredDescription
reference (query)stringnoYour reference of the campaign; answers that one campaign
player_id (query)stringnoYour player reference; answers the campaigns of that player
Response 200 · BonusCampaign | PlayerBonusCampaigns
GET

/v1/bonus-campaigns/options

Campaign types and triggers the game provider of a game takes

Signed
Parameters
FieldTypeRequiredDescription
game_id (query)stringnoid from GET /v1/games
Response 200 · BonusCampaignOptions
FieldTypeRequiredDescription
game_idstringyes
typesBonusCampaignType[]yes
triggersfirst_game_launch | bet_amount | spin_count | loss_amount[]yes
cancellablebooleanyesWhether a campaign on this game can be ended early with POST /v1/bonus-campaigns/{id}/cancel
GET

/v1/bonus-campaigns/{id}

Read a campaign

Signed
Parameters
FieldTypeRequiredDescription
id (path)stringnoCampaign id
Response 200 · BonusCampaign
FieldTypeRequiredDescription
idstringyes
campaign_idstringyesWhat your wallet sees as free_spins_id on the spins this campaign hands over
typeBonusCampaignTypeyes
statuspending | active | ended | failed | cancelledyesended: past valid_until; failed: the game provider refused it, see failure_reason; cancelled: ended early with POST /v1/bonus-campaigns/{id}/cancel
namestring | nullno
currencystring | nullno
game_idsstring[]yes
player_idsstring[]yes
valid_fromstring | null (date-time)no
valid_untilstring | null (date-time)no
triggersobjectyes
spin_countinteger | nullno
bet_amountstring | nullnofree_spins: stake of one spin
prizesBonusPrize[]yes
min_cashout_multiplierstring | nullno
campaign_limitstring | nullnoThe total the campaign pays before it ends
referencestring | nullno
failure_reasonstring | nullnoWhy the game provider refused it, when status is failed
created_atstring | null (date-time)no
POST

/v1/bonus-campaigns/{id}/cancel

End an active campaign early, where its game provider can; idempotent

Signed
Parameters
FieldTypeRequiredDescription
id (path)stringnoCampaign id
Response 200 · BonusCampaign
FieldTypeRequiredDescription
idstringyes
campaign_idstringyesWhat your wallet sees as free_spins_id on the spins this campaign hands over
typeBonusCampaignTypeyes
statuspending | active | ended | failed | cancelledyesended: past valid_until; failed: the game provider refused it, see failure_reason; cancelled: ended early with POST /v1/bonus-campaigns/{id}/cancel
namestring | nullno
currencystring | nullno
game_idsstring[]yes
player_idsstring[]yes
valid_fromstring | null (date-time)no
valid_untilstring | null (date-time)no
triggersobjectyes
spin_countinteger | nullno
bet_amountstring | nullnofree_spins: stake of one spin
prizesBonusPrize[]yes
min_cashout_multiplierstring | nullno
campaign_limitstring | nullnoThe total the campaign pays before it ends
referencestring | nullno
failure_reasonstring | nullnoWhy the game provider refused it, when status is failed
created_atstring | null (date-time)no
GET

/v1/jackpots

Progressive jackpots open on your games

Signed
Response 200 · Jackpots
FieldTypeRequiredDescription
updated_atstring (date-time)no
jackpotsobject[]no
GET

/v1/jackpots/winners

Jackpots your players won lately, newest first

Signed
Response 200 · object
FieldTypeRequiredDescription
winnersJackpotWinner[]yes

Reconciliation

GET

/v1/transactions/{id}

One movement as our books hold it

Signed
Parameters
FieldTypeRequiredDescription
id (path)stringnotransaction_id sent to your wallet
Response 200 · Transaction
FieldTypeRequiredDescription
transaction_idstringno
typebet | win | rollbackno
statuscompleted | refused | failed | cancelled | pendingno
round_idstringno
session_idstringno
player_idstringno
currencystringno
amountstringnoAmount of the movement
reference_transaction_idstring | nullnoFor a rollback: what it undid
operator_transaction_idstring | nullnoThe id your wallet answered with
created_atstring (date-time)no
completed_atstring | null (date-time)no
GET

/v1/rounds/{id}

Every movement of one round, oldest first

Signed
Parameters
FieldTypeRequiredDescription
id (path)stringnoround_id sent to your wallet
Response 200 · object
FieldTypeRequiredDescription
round_idstringyes
transactionsTransaction[]yes

Schemas

Error

FieldTypeRequiredDescription
errorUNAUTHORIZED | VALIDATION_FAILED | NOT_FOUND | METHOD_NOT_ALLOWED | UNSUPPORTED_MEDIA_TYPE | GAME_UNAVAILABLE | GAME_RESTRICTED_IN_COUNTRY | NO_DEMO | PLAYER_BLOCKED | FREE_SPINS_REFUSED | BONUS_CAMPAIGN_REFUSED | VALIDATION_RUN_REFUSED | ADDRESS_NOT_ALLOWED | RATE_LIMITED | UPSTREAM_UNAVAILABLEyes
messagestringyes
retryablebooleanyestrue: the outcome is unknown, repeat with the same ids
fieldsobject[]yesFilled on VALIDATION_FAILED only. field is the snake_case name of the body field or query parameter, or "body" when the body is not valid JSON.

WalletValidationRun

FieldTypeRequiredDescription
idstring (uuid)no
statusstringnoqueued, running, passed, failed or error
passedintegerno
warnedintegerno
failedintegerno
skippedintegerno
totalintegerno
errorstringnoWhy the run could not be carried out
casesobject[]no

Ping

FieldTypeRequiredDescription
operator_codestringyes
key_idstringyes
server_timestring (date-time)yes

Game

FieldTypeRequiredDescription
idstring (uuid)yesCatalogue id of the title (UUID). What POST /v1/sessions takes. Not what wallet callbacks carry as game_id.
provider_codestringyesThe provider
codestringyesThe provider game code, for display and support. Wallet callbacks may carry a different code for the same title.
namestringyes
studiostring | nullyesStudio display name
studio_codestring | nullyesDeprecated Deprecated: repeats provider_code
typeGameTypeyes
rtpnumber | nullyesPercentage, e.g. 96.5
thumbnail_urlstring | nullyes
imagesobjectyes
has_demobooleanyes
volatilityinteger | nullnoThe studio’s volatility, 1 (low) to 5 (high)
paylinesstring | nullnoHow the game pays, in the studio’s words: 40 Fixed Lines, Ways, Cascade
game_formatstring | nullnoRows by reels in the studio’s words, e.g. 4x5
hit_ratenumber | nullnoShare of winning rounds, a percentage
max_winnumber | nullnoThe biggest win as a multiple of the bet
release_datestring | null (date)noThe studio’s release month as its first day
jackpotstring | nullnoThe studio’s jackpot family the game is linked to
certified_marketsstring[]noWhere the studio has certified the game. Informational: it closes nothing; restricted_countries does
restricted_countriesstring[]yes
section_codestring | nullyesPricing section the game belongs to, e.g. live
free_spinsbooleanyesWhether free spins can be granted on the game now

GamesPage

FieldTypeRequiredDescription
gamesGame[]yes
next_cursorstring | nullyesPass back as cursor; null on the last page

Provider

FieldTypeRequiredDescription
provider_codestringyes
provider_namestringyes
studio_codestringnoDeprecated Deprecated: repeats provider_code
namestringnoDeprecated Deprecated: repeats provider_name
logo_urlstring | nullno
game_countintegeryes
imagesobjectno

Rates

FieldTypeRequiredDescription
revenue_baseggr | ngrno
marketrest_of_world | asiano
regulatedbooleanno
tier_modewhole | progressiveno
providersobject[]no

Rate

FieldTypeRequiredDescription
tier_ordinalintegerno
percentnumbernoA percentage: 12.5 means 12.5%

InvoiceEstimate

FieldTypeRequiredDescription
period_fromstring (date-time)noStart of the period, UTC midnight
period_tostring (date-time)noEnd of the period, exclusive: the midnight after its last day, UTC
as_ofstring (date-time)noWhen the estimate was drawn
revenue_baseggr | ngrno
linesobject[]no

CreateSession

FieldTypeRequiredDescription
player_idstringyesYour reference, up to 120 characters
currencystringyesISO 4217, fixed for the session
game_idstringyesid from GET /v1/games
localestringnoen, ru-RU, …; at most 20 characters
lobby_urlstringno
ttl_minutesintegerno
player_countrystringnoISO 3166-1 alpha-2
player_ipstringnoThe player's own address; the country is read off it
player_devicedesktop | mobileno
deposit_urlstringno
player_namestringnoNickname other players see in multiplayer games; never the real name
brandobjectnoWhich of your brands the player plays on. Providers that keep an account per brand open the game under that brand’s account; absent, under yours.

CreateDemo

FieldTypeRequiredDescription
localestringno
lobby_urlstringno
player_countrystringno
player_ipstringno
player_devicedesktop | mobileno

Session

FieldTypeRequiredDescription
session_idstringyes
launch_urlstringyesOpen the game here; never build it yourself
expires_atstring (date-time)yes

ClosedSession

FieldTypeRequiredDescription
session_idstringno
statusstringno
closed_atstring (date-time)no

CreateFreeSpins

FieldTypeRequiredDescription
player_idstringyes
currencystringyes
game_idsstring[]yes
quantityintegeryes
bet_amountstringyesStake of one spin, from GET /v1/free-spins/bet-options
valid_untilstring (date-time)yesIn the future, at most 90 days away
referencestringyesYour id for the grant; a repeat answers the first grant
brandobjectnoWhich of your brands the player plays on, as in POST /v1/sessions. Providers that keep an account per brand place the series under that brand’s account; absent, the brand of the player’s latest session, then yours.
buy_in_idstringnoA bought feature each spin opens with, from GET /v1/free-spins/buy-ins; needs exactly one game

FreeSpins

FieldTypeRequiredDescription
idstringno
free_spins_idstringnoWhat your wallet sees on the bets and wins of the series
statuspending | active | finished | failed | cancellednopending: not yet confirmed by the game provider; failed: refused by it, and a repeat under the same reference places it again
player_idstringno
currencystringno
game_idsstring[]no
quantityintegerno
bet_amountstringnoStake of one spin
valid_untilstring (date-time)no
referencestringno
created_atstring (date-time)no
finished_atstring | null (date-time)no
cancelled_atstring | null (date-time)no
win_amountstring | nullnoTotal paid, for game providers that settle the series in one call
buy_in_idstring | nullnoThe bought feature each spin opens with, when the grant named one

BonusTriggers

FieldTypeRequiredDescription
first_game_launchbooleannoThe player opens one of the games for the first time in the campaign
bet_amountobject[]no
spin_countobject[]no
loss_amountstring | nullnoNet loss to reach, positive

BonusPrize

FieldTypeRequiredDescription
kindmoney | free_spinsyesfree_spins only on a fortune_wheel
amountstring | nullnomoney: the amount paid
spinsinteger | nullnofree_spins: how many
bet_amountstring | nullnofree_spins: stake of one spin
weightintegeryes

CreateBonusCampaign

FieldTypeRequiredDescription
typeBonusCampaignTypeyes
namestringyesShown to the player in the game
currencystringyesISO 4217; the game provider may take bonuses in some currencies only
game_idsstring[]yes
player_idsstring[]yes
valid_fromstring (date-time)noOptional; the campaign starts now when absent
valid_untilstring (date-time)yesIn the future, after valid_from, at most 90 days after it
triggersBonusTriggersyesAt least one trigger. Each trigger that fires hands the bonus over once more.
spin_countintegernofree_spins only, required there
bet_amountstringnofree_spins and buy_bonus only, required there: stake of one spin, or the price of the bought bonus
prizesBonusPrize[]noDrawn types only: exactly 16 for fortune_wheel and treasure_chest, 1 to 100 for golden_dragon; at least one weight above 0
min_cashout_multiplierstringnofree_spins on crash games: the least multiplier a spin cashes out at, 1.3 to below 100
campaign_limitstringnoOptional: the total the campaign pays before it ends
referencestringyesYour id for the campaign; a repeat answers the first campaign

BonusCampaign

FieldTypeRequiredDescription
idstringyes
campaign_idstringyesWhat your wallet sees as free_spins_id on the spins this campaign hands over
typeBonusCampaignTypeyes
statuspending | active | ended | failed | cancelledyesended: past valid_until; failed: the game provider refused it, see failure_reason; cancelled: ended early with POST /v1/bonus-campaigns/{id}/cancel
namestring | nullno
currencystring | nullno
game_idsstring[]yes
player_idsstring[]yes
valid_fromstring | null (date-time)no
valid_untilstring | null (date-time)no
triggersobjectyes
spin_countinteger | nullno
bet_amountstring | nullnofree_spins: stake of one spin
prizesBonusPrize[]yes
min_cashout_multiplierstring | nullno
campaign_limitstring | nullnoThe total the campaign pays before it ends
referencestring | nullno
failure_reasonstring | nullnoWhy the game provider refused it, when status is failed
created_atstring | null (date-time)no

PlayerBonusCampaigns

FieldTypeRequiredDescription
campaignsBonusCampaign[]yesCampaigns naming the player, newest first; empty when there are none

BonusCampaignOptions

FieldTypeRequiredDescription
game_idstringyes
typesBonusCampaignType[]yes
triggersfirst_game_launch | bet_amount | spin_count | loss_amount[]yes
cancellablebooleanyesWhether a campaign on this game can be ended early with POST /v1/bonus-campaigns/{id}/cancel

LiveTables

FieldTypeRequiredDescription
currencystringyes
pendingbooleanyesThe currency was asked for the first time just now; its tables arrive within seconds
tablesLiveTable[]yes

LiveTable

FieldTypeRequiredDescription
game_idstringyesid from GET /v1/games
namestring | nullno
openbooleanyesWhether the table takes bets now
new_tablebooleanno
imagestring | nullnoThe provider's current picture of the table
dealerstring | nullno
min_betnumber | nullnoLowest bet in the currency asked for, a JSON number
max_betnumber | nullnoHighest bet in the currency asked for, a JSON number
playersinteger | nullnoPlayers at the table now
seatsinteger | nullnoSeats at a seated table (blackjack); null elsewhere
seats_availableinteger | nullno
resultsnoRecent results in the provider's own shape, which differs by game type
updated_atstring (date-time)no

Jackpots

FieldTypeRequiredDescription
updated_atstring (date-time)no
jackpotsobject[]no

JackpotWinner

FieldTypeRequiredDescription
jackpot_tier_idstringno
player_idstringno
amountnumbernoAmount won, a JSON number (not a string)
currencystringno
won_atstring (date-time)no
win_typeprogressive | community | fixedno
round_idstringnoThe provider's round id

Transaction

FieldTypeRequiredDescription
transaction_idstringno
typebet | win | rollbackno
statuscompleted | refused | failed | cancelled | pendingno
round_idstringno
session_idstringno
player_idstringno
currencystringno
amountstringnoAmount of the movement
reference_transaction_idstring | nullnoFor a rollback: what it undid
operator_transaction_idstring | nullnoThe id your wallet answered with
created_atstring (date-time)no
completed_atstring | null (date-time)no

WalletRequest

FieldTypeRequiredDescription
actiongetbalance | bet | win | rollbackyes
transaction_idstringyesIdempotency key, "<provider>:<id>". Empty string on getbalance
reference_transaction_idstring | nullyesrollback only: the transaction being undone
session_idstringyes
round_idstringyesThe provider's round. Always empty on getbalance
player_idstringyes
game_idstring | nullyesGame provider code of the game the round is played on; null on getbalance. Not the catalogue id
currencystringyes
amountstring | nullyesIn the currency's own precision; null on getbalance
free_spins_idstringnoPresent only on bets, wins and rollbacks of a movement of a free-spin series; for spins a bonus campaign hands over it is the campaign_id

WalletResponse

FieldTypeRequiredDescription
balancestringyesBalance after the movement. Must be a string: a number is read as an unreadable answer
transaction_idstringnoYour own id for the movement, a string or a number
bonus_amountstring | numbernobet and win only: the part that was bonus money, a decimal string or a number; more than the amount moved counts as the amount

WalletError

FieldTypeRequiredDescription
errorstringyesINSUFFICIENT_FUNDS, BET_LIMIT, PLAYER_BLOCKED, PLAYER_NOT_FOUND, CURRENCY_MISMATCH, SESSION_CLOSED, INVALID_SIGNATURE or VALIDATION_FAILED; compared without regard to case
messagestringno

InvoiceParty

FieldTypeRequiredDescription
namestringno
registration_numberstringno
addressstringno
countrystringno

InvoiceWebhook

FieldTypeRequiredDescription
eventinvoice.issued | invoice.voidedno
sent_atstring (date-time)no
invoiceobjectnoFigures (revenue, bonus, gross, rate_percent, amount, adjustment_amount, tax_percent, tax_amount, total, ggr, band amounts) are JSON numbers.
documentobjectno
Requests are not executed from this page. Use the Postman collection against the sandbox; production is never called from the public documentation.