Concepts
The parties, games, triggers, bet levels, rounds and jackpot terms used throughout the API.
On this page
Parties
| Term | Meaning |
|---|---|
| Partner | Whoever calls the ReelXtra API (application programming interface) with a signed key. Your Partner identity comes only from the key id. A Partner is either a Provider or an Operator. |
| Provider | A game integration Partner: a game studio whose backend calls us for its slot games. A Provider's Operators are the casinos it serves. |
| Operator | The online casino brand that holds the player's account and balance. Every Operator belongs to exactly one Partner, through one of its Groups. A casino can be a Partner itself (a casino integration) and call us directly, independent of any game. |
| Group | A set of one Partner's Operators. Every Partner has at least a default Group; Operators in a Group can share jackpot pools, and a Partner's Groups can share its Partner pools. |
| Player | A person playing at an Operator, identified to us only by an opaque playerId, unique within that Operator. Never send names, emails or other personal data. |
Your Operators by Partner kind
The tree is Partner, Group, Operator, and operatorId is the code of one of your own Operators (an operator code is unique within
your Partner, so two Partners can both have an Operator C). A code that is not an enabled Operator of your Partner fails with
1100 operatorNotAllowed.
- Provider: one Operator for each casino you serve. Always send
operatorId. - Operator Partner: your own Operator or Operators (a casino group with several brands has several). If you have exactly one Operator,
operatorIdis optional on your calls; with more than one, send it every time.
Games
| Term | Meaning |
|---|---|
| Base Game | A Provider's slot game. In game integration the Extra Game runs beside it. |
| Extra Game | One of our side games (Reel Stars, Reel Triple, Reel Streak), identified by gameId. |
| Extra Bet | The amount wagered on one play of an Extra Game, sent in POST /v1/partner/bets. |
| Trigger | Optional context on a bet: the slot spin or casino bet that caused the play (bet, gameRef, betRef). It is never the Extra Bet itself. See Bets. |
| Bet Level | One step of an Extra Game's bet ladder (level 1, 2, 3 and so on). The Operator offers a chosen set of levels, which may have gaps (for example 1, 2, 3, 4, 5, 10 and 15). The price of a level is calculated from the level, the Operator's base bet for the game and a fixed factor for the currency. A bet carries the level the player selected and an amount that must equal the current price of that level exactly, and GET /v1/partner/games/{gameId}/levels returns exactly the offered levels and their prices. The player chooses the level. |
| Game Variant | A version of a game with a fixed RTP (return to player), certified by a test lab before launch (70%–96%; Reel Triple 80%–96%). The Operator chooses it; you don't send it. |
| Round | One complete, final play of an Extra Game for one Extra Bet, with its win. Every committed round has a roundId. |
| Game Session | One player playing one Extra Game through one Partner at one Operator. It carries the tokens the widget needs. |
| Domain | Open, Regulated or White label: the part of a Site that your Partner and its Operators belong to, set by us at onboarding. Your Operators' rules and settlement follow their Domain. It never appears in a request. |
| Widget placement | Where the widget sits: embedded in a game page (game integration) or an overlay on the casino site (casino integration). |
| Reveal mode | When the widget shows a result: 1 immediately (casino default) or 2 when the Partner calls reveal() (game default), with a short timeout (default 2 s, 1 to 3 s) if it never does. Set per Operator. |
| Player Game State | What a player has built up in a game, such as a part-filled bingo card. It belongs to (Operator, player, game, bet level, currency) and survives across sessions and devices. |
Bet/Win only
Every play is exactly one bet in, one win out. There are no player decisions, cash-outs, buy features or
payments outside a bet response. Anything a player wins is in the win field of a bet response.
Who decides when a play happens
- Game integration: the Provider sends a play for a base spin where the player switched the Extra Game on. A Provider does not send plays for free spins or bonus rounds.
- Casino integration: the Operator decides which casino bets trigger a play, with its own trigger rule, and whether free spins or bonus rounds count.
- In both streams the Extra Bet is at the price of a level chosen by the player: the bet carries the
leveland theamount. It is never derived from the casino bet or the base bet.
Shared player state across streams
A player's progress in an Extra Game is shared between a Provider's slot and the Operator's overlay only when
both Partners send the Operator's own player id as playerId. Operator Partners must. Providers are
recommended to. If the ids differ, the two streams keep separate cards.
Jackpots (Reel Stars and Reel Triple)
| Term | Meaning |
|---|---|
| Progressive Counter | The rules of a jackpot: seed, contribution rate and the games and levels it applies to. |
| Pool | One live jackpot: one Counter, at one Bet Level, owned by one Operator, one Group or the Network. A player at 0.10 can never win a pool filled by 0.50 bets. |
| Seed | The base part of a jackpot win, a multiple of the bet amount set by the game maths. |
| Growth | The money built up in a pool from contributions. A jackpot hit pays the seed plus all the growth in one shot. |
| Carried-over Bonus | A Reel Triple Mini or Minor bonus locked on a card that timed out. It is paid in the response to the player's next bet on that game, level and currency, even from the other stream. If the Bet Level is withdrawn from the player's Operator, or the game is retired for that Operator, the bonus can no longer be paid and is written off after a notice period (default 90 days). |
Which pool applies is decided by us: the Operator's own pool if it has one, else its Group's, else the
Network's. You see the result in the bet response (poolId, poolOwnerType).
Money
- Wallet-less. The balance holder debits the Extra Bet and credits the win. We never move money.
- Decimal strings. All amounts are JSON strings, e.g.
"1.00","0.00012000". Never send or parse them as floating-point numbers. - Whole minimal units. Every win is a whole number of the currency's smallest unit (cent, satoshi). Use
GET /v1/partner/currenciesfor each currency's precision. - Currencies and classes. Every currency the Operator offers is playable: fiat, crypto, fun currencies and social casino coins. They fall in two classes (Real: fiat and crypto; Fun: fun currencies and social casino coins), and a jackpot only takes bets of its own kind: each Operator has one Real jackpot per progressive game and level, which takes every fiat and crypto bet, and a separate Fun jackpot for each fun currency it offers, which takes only bets in that fun currency (fun currencies never share a jackpot), so a player feeds and wins only the jackpot of their currency. The one currency that is never playable for real is
FUN, the demo currency. A progressive game is offered in a currency only where the Operator has a jackpot for that currency; ReelXtra sets the Operator's Real jackpots up at onboarding, and the first bet in a fun currency the Operator offers creates its Fun jackpot on the spot (nothing for you to do: the bet goes through), so a bet in a currency with no jackpot, or in a fun currency the Operator does not offer, is refused with1502. - Final rounds. A committed round is final. There is no rollback of a committed round.
Demo play
A demo session uses the same games and widget with the demo currency FUN. Nothing is charged, stored or reported.
Demo is only available where the Operator's jurisdiction allows it. In casino integration, demo plays still come
through the signed API, with a FUN trigger.
A demo session is created only with a signed POST /v1/partner/sessions call with demo: true, and is played with the same sessionToken and POST /v1/partner/bets calls as a real one, in FUN
(its ladder prices are your Operator's own; read them with GET /v1/partner/games/{gameId}/levels?currency=FUN). Its ids start with dses_ and its session token with dst_; every demo bet response says "demo": true
and has a round id starting with d-, which no lookup, history link or reconciliation file knows. All demo players of a Domain share one demo jackpot per game and level, which starts again from its seed when our servers restart.
A demo session ends after 30 minutes idle, after 24 hours at most,
or if our server holding it restarts; then bets get 1301 sessionNotFound and you create a new demo session. A demo session is limited to 5 plays per second, and demo calls have their own rate limit, so they never use up your real allowance.