API reference
Generated from the OpenAPI document, version 1.0.0+2026-11-07. The same document is available to download.
Getting started
/v1/ping
Verify signing and clock
| Field | Type | Required | Description |
|---|---|---|---|
| operator_code | string | yes | |
| key_id | string | yes | |
| server_time | string (date-time) | yes |
/v1/debug/signature
Sandbox only: check a signature step by step (not signed)
| Field | Type | Required | Description |
|---|---|---|---|
| key_id | string | yes | The X-Agg-Key-Id you sent |
| timestamp | string | yes | The X-Agg-Timestamp you sent, Unix seconds |
| signature | string | yes | The X-Agg-Signature you sent |
| method | string | yes | GET, POST, PUT or DELETE |
| path | string | yes | Path and query exactly as sent |
| body | string | null | no | The raw body; null or absent for a request without one |
| Field | Type | Required | Description |
|---|---|---|---|
| valid | boolean | no | |
| diagnosis | string | no | One sentence: what is wrong, or that nothing is |
| key | object | no | |
| timestamp | object | no | |
| payload | object | no | |
| canonical_string | string | no | timestamp + "." + payload, exactly what is signed |
| signature | object | no | |
| hints | string[] | no |
Catalogue
/v1/games
Games you may offer, paged by cursor
| Field | Type | Required | Description |
|---|---|---|---|
| type (query) | GameType | no | |
| provider_code (query) | string | no | One provider, as GET /v1/providers names it |
| studio_code (query) | string | no | Deprecated Deprecated: the same filter as provider_code under its older name; wins when both are sent. |
| country (query) | string | no | ISO 3166-1 alpha-2. Leaves out games that cannot be played in that country. |
| cursor (query) | string | no | next_cursor of the previous page |
| limit (query) | integer | no | 1..200, default 50. Above 200 is cut to 200; below 1 is VALIDATION_FAILED. |
| Field | Type | Required | Description |
|---|---|---|---|
| games | Game[] | yes | |
| next_cursor | string | null | yes | Pass back as cursor; null on the last page |
/v1/providers
Providers behind the games, whole list
| Field | Type | Required | Description |
|---|---|---|---|
| providers | Provider[] | yes |
/v1/images/{id}
An image by id (not signed)
| Field | Type | Required | Description |
|---|---|---|---|
| id (path) | string | no | Image id from an images URL |
/v1/rates
Your revenue-share percent per provider and band
| Field | Type | Required | Description |
|---|---|---|---|
| revenue_base | ggr | ngr | no | |
| market | rest_of_world | asia | no | |
| regulated | boolean | no | |
| tier_mode | whole | progressive | no | |
| providers | object[] | no |
/v1/invoices/estimate
What your invoice would say if it were drawn now
| Field | Type | Required | Description |
|---|---|---|---|
| from (query) | string (date) | no | First day, YYYY-MM-DD; with to. Both absent: the first of the month |
| to (query) | string (date) | no | Last day, included; with from, at most 366 days after it. Both absent: today |
| Field | Type | Required | Description |
|---|---|---|---|
| period_from | string (date-time) | no | Start of the period, UTC midnight |
| period_to | string (date-time) | no | End of the period, exclusive: the midnight after its last day, UTC |
| as_of | string (date-time) | no | When the estimate was drawn |
| revenue_base | ggr | ngr | no | |
| lines | object[] | no |
/v1/live-tables
Live Casino tables on your games as they stand now, limits in one currency
| Field | Type | Required | Description |
|---|---|---|---|
| currency (query) | string | no | ISO code the limits are wanted in |
| Field | Type | Required | Description |
|---|---|---|---|
| currency | string | yes | |
| pending | boolean | yes | The currency was asked for the first time just now; its tables arrive within seconds |
| tables | LiveTable[] | yes |
Wallet integration
/v1/test/wallet-validation
Sandbox only: run the wallet test suite against your wallet
| Field | Type | Required | Description |
|---|---|---|---|
| player_id | string | yes | Your test player, with at least 10.00 |
| currency | string | yes | The currency of that balance |
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | no | |
| status | string | no | queued, running, passed, failed or error |
| passed | integer | no | |
| warned | integer | no | |
| failed | integer | no | |
| skipped | integer | no | |
| total | integer | no | |
| error | string | no | Why the run could not be carried out |
| cases | object[] | no |
/v1/test/wallet-validation/{id}
Sandbox only: a run and every case so far
| Field | Type | Required | Description |
|---|---|---|---|
| id (path) | string | no | The run id from the start |
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | no | |
| status | string | no | queued, running, passed, failed or error |
| passed | integer | no | |
| warned | integer | no | |
| failed | integer | no | |
| skipped | integer | no | |
| total | integer | no | |
| error | string | no | Why the run could not be carried out |
| cases | object[] | no |
Sessions
/v1/sessions
Open a game for a player
| Field | Type | Required | Description |
|---|---|---|---|
| player_id | string | yes | Your reference, up to 120 characters |
| currency | string | yes | ISO 4217, fixed for the session |
| game_id | string | yes | id from GET /v1/games |
| locale | string | no | en, ru-RU, …; at most 20 characters |
| lobby_url | string | no | |
| ttl_minutes | integer | no | |
| player_country | string | no | ISO 3166-1 alpha-2 |
| player_ip | string | no | The player's own address; the country is read off it |
| player_device | desktop | mobile | no | |
| deposit_url | string | no | |
| player_name | string | no | Nickname other players see in multiplayer games; never the real name |
| brand | object | no | Which 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. |
| Field | Type | Required | Description |
|---|---|---|---|
| session_id | string | yes | |
| launch_url | string | yes | Open the game here; never build it yourself |
| expires_at | string (date-time) | yes |
/v1/games/{id}/demo
Fun play without a player or wallet
| Field | Type | Required | Description |
|---|---|---|---|
| id (path) | string | no | Game id from GET /v1/games |
| Field | Type | Required | Description |
|---|---|---|---|
| locale | string | no | |
| lobby_url | string | no | |
| player_country | string | no | |
| player_ip | string | no | |
| player_device | desktop | mobile | no |
| Field | Type | Required | Description |
|---|---|---|---|
| launch_url | string | yes |
/v1/sessions/{id}/close
End a session
| Field | Type | Required | Description |
|---|---|---|---|
| id (path) | string | no | session_id from POST /v1/sessions |
| Field | Type | Required | Description |
|---|---|---|---|
| session_id | string | no | |
| status | string | no | |
| closed_at | string (date-time) | no |
Promotions
/v1/free-spins
Grant free spins; idempotent on reference
| Field | Type | Required | Description |
|---|---|---|---|
| player_id | string | yes | |
| currency | string | yes | |
| game_ids | string[] | yes | |
| quantity | integer | yes | |
| bet_amount | string | yes | Stake of one spin, from GET /v1/free-spins/bet-options |
| valid_until | string (date-time) | yes | In the future, at most 90 days away |
| reference | string | yes | Your id for the grant; a repeat answers the first grant |
| brand | object | no | Which 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_id | string | no | A bought feature each spin opens with, from GET /v1/free-spins/buy-ins; needs exactly one game |
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | no | |
| free_spins_id | string | no | What your wallet sees on the bets and wins of the series |
| status | pending | active | finished | failed | cancelled | no | pending: not yet confirmed by the game provider; failed: refused by it, and a repeat under the same reference places it again |
| player_id | string | no | |
| currency | string | no | |
| game_ids | string[] | no | |
| quantity | integer | no | |
| bet_amount | string | no | Stake of one spin |
| valid_until | string (date-time) | no | |
| reference | string | no | |
| created_at | string (date-time) | no | |
| finished_at | string | null (date-time) | no | |
| cancelled_at | string | null (date-time) | no | |
| win_amount | string | null | no | Total paid, for game providers that settle the series in one call |
| buy_in_id | string | null | no | The bought feature each spin opens with, when the grant named one |
/v1/free-spins
Find a grant by your reference
| Field | Type | Required | Description |
|---|---|---|---|
| reference (query) | string | no |
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | no | |
| free_spins_id | string | no | What your wallet sees on the bets and wins of the series |
| status | pending | active | finished | failed | cancelled | no | pending: not yet confirmed by the game provider; failed: refused by it, and a repeat under the same reference places it again |
| player_id | string | no | |
| currency | string | no | |
| game_ids | string[] | no | |
| quantity | integer | no | |
| bet_amount | string | no | Stake of one spin |
| valid_until | string (date-time) | no | |
| reference | string | no | |
| created_at | string (date-time) | no | |
| finished_at | string | null (date-time) | no | |
| cancelled_at | string | null (date-time) | no | |
| win_amount | string | null | no | Total paid, for game providers that settle the series in one call |
| buy_in_id | string | null | no | The bought feature each spin opens with, when the grant named one |
/v1/free-spins/bet-options
Stakes the game provider accepts for a grant
| Field | Type | Required | Description |
|---|---|---|---|
| game_id (query) | string | no | |
| currency (query) | string | no | |
| brand (query) | string | no | Your brand code, as brand.code in POST /v1/sessions. A provider with an account per brand answers that account's stakes. |
| player_id (query) | string | no | Without brand, the brand of this player's latest session is taken. |
| Field | Type | Required | Description |
|---|---|---|---|
| game_id | string | yes | |
| currency | string | yes | |
| amounts | string[] | yes |
/v1/free-spins/buy-ins
Bought features a free spin of the game may open with
| Field | Type | Required | Description |
|---|---|---|---|
| game_id (query) | string | no | |
| currency (query) | string | no |
| Field | Type | Required | Description |
|---|---|---|---|
| game_id | string | yes | |
| currency | string | yes | |
| buy_ins | object[] | yes |
/v1/free-spins/providers
The providers whose games take free-spin grants
| Field | Type | Required | Description |
|---|---|---|---|
| provider_codes | string[] | yes |
/v1/free-spins/{id}
Read a grant
| Field | Type | Required | Description |
|---|---|---|---|
| id (path) | string | no | Grant id |
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | no | |
| free_spins_id | string | no | What your wallet sees on the bets and wins of the series |
| status | pending | active | finished | failed | cancelled | no | pending: not yet confirmed by the game provider; failed: refused by it, and a repeat under the same reference places it again |
| player_id | string | no | |
| currency | string | no | |
| game_ids | string[] | no | |
| quantity | integer | no | |
| bet_amount | string | no | Stake of one spin |
| valid_until | string (date-time) | no | |
| reference | string | no | |
| created_at | string (date-time) | no | |
| finished_at | string | null (date-time) | no | |
| cancelled_at | string | null (date-time) | no | |
| win_amount | string | null | no | Total paid, for game providers that settle the series in one call |
| buy_in_id | string | null | no | The bought feature each spin opens with, when the grant named one |
/v1/free-spins/{id}/cancel
Withdraw an active grant; idempotent
| Field | Type | Required | Description |
|---|---|---|---|
| id (path) | string | no | Grant id |
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | no | |
| free_spins_id | string | no | What your wallet sees on the bets and wins of the series |
| status | pending | active | finished | failed | cancelled | no | pending: not yet confirmed by the game provider; failed: refused by it, and a repeat under the same reference places it again |
| player_id | string | no | |
| currency | string | no | |
| game_ids | string[] | no | |
| quantity | integer | no | |
| bet_amount | string | no | Stake of one spin |
| valid_until | string (date-time) | no | |
| reference | string | no | |
| created_at | string (date-time) | no | |
| finished_at | string | null (date-time) | no | |
| cancelled_at | string | null (date-time) | no | |
| win_amount | string | null | no | Total paid, for game providers that settle the series in one call |
| buy_in_id | string | null | no | The bought feature each spin opens with, when the grant named one |
/v1/bonus-campaigns
Place a bonus campaign for your players; idempotent on reference
| Field | Type | Required | Description |
|---|---|---|---|
| type | BonusCampaignType | yes | |
| name | string | yes | Shown to the player in the game |
| currency | string | yes | ISO 4217; the game provider may take bonuses in some currencies only |
| game_ids | string[] | yes | |
| player_ids | string[] | yes | |
| valid_from | string (date-time) | no | Optional; the campaign starts now when absent |
| valid_until | string (date-time) | yes | In the future, after valid_from, at most 90 days after it |
| triggers | BonusTriggers | yes | At least one trigger. Each trigger that fires hands the bonus over once more. |
| spin_count | integer | no | free_spins only, required there |
| bet_amount | string | no | free_spins and buy_bonus only, required there: stake of one spin, or the price of the bought bonus |
| prizes | BonusPrize[] | no | Drawn types only: exactly 16 for fortune_wheel and treasure_chest, 1 to 100 for golden_dragon; at least one weight above 0 |
| min_cashout_multiplier | string | no | free_spins on crash games: the least multiplier a spin cashes out at, 1.3 to below 100 |
| campaign_limit | string | no | Optional: the total the campaign pays before it ends |
| reference | string | yes | Your id for the campaign; a repeat answers the first campaign |
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | yes | |
| campaign_id | string | yes | What your wallet sees as free_spins_id on the spins this campaign hands over |
| type | BonusCampaignType | yes | |
| status | pending | active | ended | failed | cancelled | yes | ended: past valid_until; failed: the game provider refused it, see failure_reason; cancelled: ended early with POST /v1/bonus-campaigns/{id}/cancel |
| name | string | null | no | |
| currency | string | null | no | |
| game_ids | string[] | yes | |
| player_ids | string[] | yes | |
| valid_from | string | null (date-time) | no | |
| valid_until | string | null (date-time) | no | |
| triggers | object | yes | |
| spin_count | integer | null | no | |
| bet_amount | string | null | no | free_spins: stake of one spin |
| prizes | BonusPrize[] | yes | |
| min_cashout_multiplier | string | null | no | |
| campaign_limit | string | null | no | The total the campaign pays before it ends |
| reference | string | null | no | |
| failure_reason | string | null | no | Why the game provider refused it, when status is failed |
| created_at | string | null (date-time) | no |
/v1/bonus-campaigns
Find a campaign by your reference, or list the campaigns of one player
| Field | Type | Required | Description |
|---|---|---|---|
| reference (query) | string | no | Your reference of the campaign; answers that one campaign |
| player_id (query) | string | no | Your player reference; answers the campaigns of that player |
/v1/bonus-campaigns/options
Campaign types and triggers the game provider of a game takes
| Field | Type | Required | Description |
|---|---|---|---|
| game_id (query) | string | no | id from GET /v1/games |
| Field | Type | Required | Description |
|---|---|---|---|
| game_id | string | yes | |
| types | BonusCampaignType[] | yes | |
| triggers | first_game_launch | bet_amount | spin_count | loss_amount[] | yes | |
| cancellable | boolean | yes | Whether a campaign on this game can be ended early with POST /v1/bonus-campaigns/{id}/cancel |
/v1/bonus-campaigns/{id}
Read a campaign
| Field | Type | Required | Description |
|---|---|---|---|
| id (path) | string | no | Campaign id |
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | yes | |
| campaign_id | string | yes | What your wallet sees as free_spins_id on the spins this campaign hands over |
| type | BonusCampaignType | yes | |
| status | pending | active | ended | failed | cancelled | yes | ended: past valid_until; failed: the game provider refused it, see failure_reason; cancelled: ended early with POST /v1/bonus-campaigns/{id}/cancel |
| name | string | null | no | |
| currency | string | null | no | |
| game_ids | string[] | yes | |
| player_ids | string[] | yes | |
| valid_from | string | null (date-time) | no | |
| valid_until | string | null (date-time) | no | |
| triggers | object | yes | |
| spin_count | integer | null | no | |
| bet_amount | string | null | no | free_spins: stake of one spin |
| prizes | BonusPrize[] | yes | |
| min_cashout_multiplier | string | null | no | |
| campaign_limit | string | null | no | The total the campaign pays before it ends |
| reference | string | null | no | |
| failure_reason | string | null | no | Why the game provider refused it, when status is failed |
| created_at | string | null (date-time) | no |
/v1/bonus-campaigns/{id}/cancel
End an active campaign early, where its game provider can; idempotent
| Field | Type | Required | Description |
|---|---|---|---|
| id (path) | string | no | Campaign id |
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | yes | |
| campaign_id | string | yes | What your wallet sees as free_spins_id on the spins this campaign hands over |
| type | BonusCampaignType | yes | |
| status | pending | active | ended | failed | cancelled | yes | ended: past valid_until; failed: the game provider refused it, see failure_reason; cancelled: ended early with POST /v1/bonus-campaigns/{id}/cancel |
| name | string | null | no | |
| currency | string | null | no | |
| game_ids | string[] | yes | |
| player_ids | string[] | yes | |
| valid_from | string | null (date-time) | no | |
| valid_until | string | null (date-time) | no | |
| triggers | object | yes | |
| spin_count | integer | null | no | |
| bet_amount | string | null | no | free_spins: stake of one spin |
| prizes | BonusPrize[] | yes | |
| min_cashout_multiplier | string | null | no | |
| campaign_limit | string | null | no | The total the campaign pays before it ends |
| reference | string | null | no | |
| failure_reason | string | null | no | Why the game provider refused it, when status is failed |
| created_at | string | null (date-time) | no |
/v1/jackpots
Progressive jackpots open on your games
| Field | Type | Required | Description |
|---|---|---|---|
| updated_at | string (date-time) | no | |
| jackpots | object[] | no |
/v1/jackpots/winners
Jackpots your players won lately, newest first
| Field | Type | Required | Description |
|---|---|---|---|
| winners | JackpotWinner[] | yes |
Reconciliation
/v1/transactions/{id}
One movement as our books hold it
| Field | Type | Required | Description |
|---|---|---|---|
| id (path) | string | no | transaction_id sent to your wallet |
| Field | Type | Required | Description |
|---|---|---|---|
| transaction_id | string | no | |
| type | bet | win | rollback | no | |
| status | completed | refused | failed | cancelled | pending | no | |
| round_id | string | no | |
| session_id | string | no | |
| player_id | string | no | |
| currency | string | no | |
| amount | string | no | Amount of the movement |
| reference_transaction_id | string | null | no | For a rollback: what it undid |
| operator_transaction_id | string | null | no | The id your wallet answered with |
| created_at | string (date-time) | no | |
| completed_at | string | null (date-time) | no |
/v1/rounds/{id}
Every movement of one round, oldest first
| Field | Type | Required | Description |
|---|---|---|---|
| id (path) | string | no | round_id sent to your wallet |
| Field | Type | Required | Description |
|---|---|---|---|
| round_id | string | yes | |
| transactions | Transaction[] | yes |
Schemas
Error
| Field | Type | Required | Description |
|---|---|---|---|
| error | UNAUTHORIZED | 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_UNAVAILABLE | yes | |
| message | string | yes | |
| retryable | boolean | yes | true: the outcome is unknown, repeat with the same ids |
| fields | object[] | yes | Filled 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
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | no | |
| status | string | no | queued, running, passed, failed or error |
| passed | integer | no | |
| warned | integer | no | |
| failed | integer | no | |
| skipped | integer | no | |
| total | integer | no | |
| error | string | no | Why the run could not be carried out |
| cases | object[] | no |
Ping
| Field | Type | Required | Description |
|---|---|---|---|
| operator_code | string | yes | |
| key_id | string | yes | |
| server_time | string (date-time) | yes |
Game
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | yes | Catalogue id of the title (UUID). What POST /v1/sessions takes. Not what wallet callbacks carry as game_id. |
| provider_code | string | yes | The provider |
| code | string | yes | The provider game code, for display and support. Wallet callbacks may carry a different code for the same title. |
| name | string | yes | |
| studio | string | null | yes | Studio display name |
| studio_code | string | null | yes | Deprecated Deprecated: repeats provider_code |
| type | GameType | yes | |
| rtp | number | null | yes | Percentage, e.g. 96.5 |
| thumbnail_url | string | null | yes | |
| images | object | yes | |
| has_demo | boolean | yes | |
| volatility | integer | null | no | The studio’s volatility, 1 (low) to 5 (high) |
| paylines | string | null | no | How the game pays, in the studio’s words: 40 Fixed Lines, Ways, Cascade |
| game_format | string | null | no | Rows by reels in the studio’s words, e.g. 4x5 |
| hit_rate | number | null | no | Share of winning rounds, a percentage |
| max_win | number | null | no | The biggest win as a multiple of the bet |
| release_date | string | null (date) | no | The studio’s release month as its first day |
| jackpot | string | null | no | The studio’s jackpot family the game is linked to |
| certified_markets | string[] | no | Where the studio has certified the game. Informational: it closes nothing; restricted_countries does |
| restricted_countries | string[] | yes | |
| section_code | string | null | yes | Pricing section the game belongs to, e.g. live |
| free_spins | boolean | yes | Whether free spins can be granted on the game now |
GamesPage
| Field | Type | Required | Description |
|---|---|---|---|
| games | Game[] | yes | |
| next_cursor | string | null | yes | Pass back as cursor; null on the last page |
Provider
| Field | Type | Required | Description |
|---|---|---|---|
| provider_code | string | yes | |
| provider_name | string | yes | |
| studio_code | string | no | Deprecated Deprecated: repeats provider_code |
| name | string | no | Deprecated Deprecated: repeats provider_name |
| logo_url | string | null | no | |
| game_count | integer | yes | |
| images | object | no |
Rates
| Field | Type | Required | Description |
|---|---|---|---|
| revenue_base | ggr | ngr | no | |
| market | rest_of_world | asia | no | |
| regulated | boolean | no | |
| tier_mode | whole | progressive | no | |
| providers | object[] | no |
Rate
| Field | Type | Required | Description |
|---|---|---|---|
| tier_ordinal | integer | no | |
| percent | number | no | A percentage: 12.5 means 12.5% |
InvoiceEstimate
| Field | Type | Required | Description |
|---|---|---|---|
| period_from | string (date-time) | no | Start of the period, UTC midnight |
| period_to | string (date-time) | no | End of the period, exclusive: the midnight after its last day, UTC |
| as_of | string (date-time) | no | When the estimate was drawn |
| revenue_base | ggr | ngr | no | |
| lines | object[] | no |
CreateSession
| Field | Type | Required | Description |
|---|---|---|---|
| player_id | string | yes | Your reference, up to 120 characters |
| currency | string | yes | ISO 4217, fixed for the session |
| game_id | string | yes | id from GET /v1/games |
| locale | string | no | en, ru-RU, …; at most 20 characters |
| lobby_url | string | no | |
| ttl_minutes | integer | no | |
| player_country | string | no | ISO 3166-1 alpha-2 |
| player_ip | string | no | The player's own address; the country is read off it |
| player_device | desktop | mobile | no | |
| deposit_url | string | no | |
| player_name | string | no | Nickname other players see in multiplayer games; never the real name |
| brand | object | no | Which 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
| Field | Type | Required | Description |
|---|---|---|---|
| locale | string | no | |
| lobby_url | string | no | |
| player_country | string | no | |
| player_ip | string | no | |
| player_device | desktop | mobile | no |
Session
| Field | Type | Required | Description |
|---|---|---|---|
| session_id | string | yes | |
| launch_url | string | yes | Open the game here; never build it yourself |
| expires_at | string (date-time) | yes |
ClosedSession
| Field | Type | Required | Description |
|---|---|---|---|
| session_id | string | no | |
| status | string | no | |
| closed_at | string (date-time) | no |
CreateFreeSpins
| Field | Type | Required | Description |
|---|---|---|---|
| player_id | string | yes | |
| currency | string | yes | |
| game_ids | string[] | yes | |
| quantity | integer | yes | |
| bet_amount | string | yes | Stake of one spin, from GET /v1/free-spins/bet-options |
| valid_until | string (date-time) | yes | In the future, at most 90 days away |
| reference | string | yes | Your id for the grant; a repeat answers the first grant |
| brand | object | no | Which 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_id | string | no | A bought feature each spin opens with, from GET /v1/free-spins/buy-ins; needs exactly one game |
FreeSpins
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | no | |
| free_spins_id | string | no | What your wallet sees on the bets and wins of the series |
| status | pending | active | finished | failed | cancelled | no | pending: not yet confirmed by the game provider; failed: refused by it, and a repeat under the same reference places it again |
| player_id | string | no | |
| currency | string | no | |
| game_ids | string[] | no | |
| quantity | integer | no | |
| bet_amount | string | no | Stake of one spin |
| valid_until | string (date-time) | no | |
| reference | string | no | |
| created_at | string (date-time) | no | |
| finished_at | string | null (date-time) | no | |
| cancelled_at | string | null (date-time) | no | |
| win_amount | string | null | no | Total paid, for game providers that settle the series in one call |
| buy_in_id | string | null | no | The bought feature each spin opens with, when the grant named one |
BonusTriggers
| Field | Type | Required | Description |
|---|---|---|---|
| first_game_launch | boolean | no | The player opens one of the games for the first time in the campaign |
| bet_amount | object[] | no | |
| spin_count | object[] | no | |
| loss_amount | string | null | no | Net loss to reach, positive |
BonusPrize
| Field | Type | Required | Description |
|---|---|---|---|
| kind | money | free_spins | yes | free_spins only on a fortune_wheel |
| amount | string | null | no | money: the amount paid |
| spins | integer | null | no | free_spins: how many |
| bet_amount | string | null | no | free_spins: stake of one spin |
| weight | integer | yes |
CreateBonusCampaign
| Field | Type | Required | Description |
|---|---|---|---|
| type | BonusCampaignType | yes | |
| name | string | yes | Shown to the player in the game |
| currency | string | yes | ISO 4217; the game provider may take bonuses in some currencies only |
| game_ids | string[] | yes | |
| player_ids | string[] | yes | |
| valid_from | string (date-time) | no | Optional; the campaign starts now when absent |
| valid_until | string (date-time) | yes | In the future, after valid_from, at most 90 days after it |
| triggers | BonusTriggers | yes | At least one trigger. Each trigger that fires hands the bonus over once more. |
| spin_count | integer | no | free_spins only, required there |
| bet_amount | string | no | free_spins and buy_bonus only, required there: stake of one spin, or the price of the bought bonus |
| prizes | BonusPrize[] | no | Drawn types only: exactly 16 for fortune_wheel and treasure_chest, 1 to 100 for golden_dragon; at least one weight above 0 |
| min_cashout_multiplier | string | no | free_spins on crash games: the least multiplier a spin cashes out at, 1.3 to below 100 |
| campaign_limit | string | no | Optional: the total the campaign pays before it ends |
| reference | string | yes | Your id for the campaign; a repeat answers the first campaign |
BonusCampaign
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | yes | |
| campaign_id | string | yes | What your wallet sees as free_spins_id on the spins this campaign hands over |
| type | BonusCampaignType | yes | |
| status | pending | active | ended | failed | cancelled | yes | ended: past valid_until; failed: the game provider refused it, see failure_reason; cancelled: ended early with POST /v1/bonus-campaigns/{id}/cancel |
| name | string | null | no | |
| currency | string | null | no | |
| game_ids | string[] | yes | |
| player_ids | string[] | yes | |
| valid_from | string | null (date-time) | no | |
| valid_until | string | null (date-time) | no | |
| triggers | object | yes | |
| spin_count | integer | null | no | |
| bet_amount | string | null | no | free_spins: stake of one spin |
| prizes | BonusPrize[] | yes | |
| min_cashout_multiplier | string | null | no | |
| campaign_limit | string | null | no | The total the campaign pays before it ends |
| reference | string | null | no | |
| failure_reason | string | null | no | Why the game provider refused it, when status is failed |
| created_at | string | null (date-time) | no |
PlayerBonusCampaigns
| Field | Type | Required | Description |
|---|---|---|---|
| campaigns | BonusCampaign[] | yes | Campaigns naming the player, newest first; empty when there are none |
BonusCampaignOptions
| Field | Type | Required | Description |
|---|---|---|---|
| game_id | string | yes | |
| types | BonusCampaignType[] | yes | |
| triggers | first_game_launch | bet_amount | spin_count | loss_amount[] | yes | |
| cancellable | boolean | yes | Whether a campaign on this game can be ended early with POST /v1/bonus-campaigns/{id}/cancel |
LiveTables
| Field | Type | Required | Description |
|---|---|---|---|
| currency | string | yes | |
| pending | boolean | yes | The currency was asked for the first time just now; its tables arrive within seconds |
| tables | LiveTable[] | yes |
LiveTable
| Field | Type | Required | Description |
|---|---|---|---|
| game_id | string | yes | id from GET /v1/games |
| name | string | null | no | |
| open | boolean | yes | Whether the table takes bets now |
| new_table | boolean | no | |
| image | string | null | no | The provider's current picture of the table |
| dealer | string | null | no | |
| min_bet | number | null | no | Lowest bet in the currency asked for, a JSON number |
| max_bet | number | null | no | Highest bet in the currency asked for, a JSON number |
| players | integer | null | no | Players at the table now |
| seats | integer | null | no | Seats at a seated table (blackjack); null elsewhere |
| seats_available | integer | null | no | |
| results | no | Recent results in the provider's own shape, which differs by game type | |
| updated_at | string (date-time) | no |
Jackpots
| Field | Type | Required | Description |
|---|---|---|---|
| updated_at | string (date-time) | no | |
| jackpots | object[] | no |
JackpotWinner
| Field | Type | Required | Description |
|---|---|---|---|
| jackpot_tier_id | string | no | |
| player_id | string | no | |
| amount | number | no | Amount won, a JSON number (not a string) |
| currency | string | no | |
| won_at | string (date-time) | no | |
| win_type | progressive | community | fixed | no | |
| round_id | string | no | The provider's round id |
Transaction
| Field | Type | Required | Description |
|---|---|---|---|
| transaction_id | string | no | |
| type | bet | win | rollback | no | |
| status | completed | refused | failed | cancelled | pending | no | |
| round_id | string | no | |
| session_id | string | no | |
| player_id | string | no | |
| currency | string | no | |
| amount | string | no | Amount of the movement |
| reference_transaction_id | string | null | no | For a rollback: what it undid |
| operator_transaction_id | string | null | no | The id your wallet answered with |
| created_at | string (date-time) | no | |
| completed_at | string | null (date-time) | no |
WalletRequest
| Field | Type | Required | Description |
|---|---|---|---|
| action | getbalance | bet | win | rollback | yes | |
| transaction_id | string | yes | Idempotency key, "<provider>:<id>". Empty string on getbalance |
| reference_transaction_id | string | null | yes | rollback only: the transaction being undone |
| session_id | string | yes | |
| round_id | string | yes | The provider's round. Always empty on getbalance |
| player_id | string | yes | |
| game_id | string | null | yes | Game provider code of the game the round is played on; null on getbalance. Not the catalogue id |
| currency | string | yes | |
| amount | string | null | yes | In the currency's own precision; null on getbalance |
| free_spins_id | string | no | Present 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
| Field | Type | Required | Description |
|---|---|---|---|
| balance | string | yes | Balance after the movement. Must be a string: a number is read as an unreadable answer |
| transaction_id | string | no | Your own id for the movement, a string or a number |
| bonus_amount | string | number | no | bet 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
| Field | Type | Required | Description |
|---|---|---|---|
| error | string | yes | INSUFFICIENT_FUNDS, BET_LIMIT, PLAYER_BLOCKED, PLAYER_NOT_FOUND, CURRENCY_MISMATCH, SESSION_CLOSED, INVALID_SIGNATURE or VALIDATION_FAILED; compared without regard to case |
| message | string | no |
InvoiceParty
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | no | |
| registration_number | string | no | |
| address | string | no | |
| country | string | no |
InvoiceWebhook
| Field | Type | Required | Description |
|---|---|---|---|
| event | invoice.issued | invoice.voided | no | |
| sent_at | string (date-time) | no | |
| invoice | object | no | Figures (revenue, bonus, gross, rate_percent, amount, adjustment_amount, tax_percent, tax_amount, total, ggr, band amounts) are JSON numbers. |
| document | object | no |
