ReelXtra Partner API

Version 1.0.0. 15 endpoints, generated from the OpenAPI specification.

Download openapi.yaml

Base URL: https://sandbox.reelxtra.net

Endpoints

Sessions

POST/v1/partner/sessions

Create a game session for one player and one Extra Game

Requires X-RX-Nonce. The `launchUrl` is `https://<public host>/v1/public/widget/#lt=<launch token>`. Replaces any existing session for the same Partner, Operator, player and game; sessions of other Partners or other games are not affected. Refused with 503 1506 maintenance during a planned maintenance window for the game. With `demo: true` the call creates a Demo Session: fun currency (`FUN`), nothing stored or charged, kept only in the memory of one of our servers. It is refused with 403 1504 demoNotAllowed where the Operator's Compliance Profile forbids demo, or where it requires a verified session and no `playerId` is sent. The response carries a demo `sessionId` (`dses_...`) and a demo `sessionToken` (`dst_...`); play it with the same `POST /v1/partner/bets` call, in `FUN`. It ends after 30 minutes without a play, after 24 hours, or when our server restarts; its credentials then answer 1301 sessionNotFound and you create a new one.

Parameters

NameInTypeRequiredDescription
X-RX-NonceheaderstringYesA fresh value for every request, used once. Missing or malformed is 400 1200; reused is 401 1002.

Request body (application/json, CreateSessionRequest)

NameTypeRequiredDescription
operatorIdstringNoRequired for a Provider. Optional for an Operator Partner with exactly one Operator. The code of one of your Operators (otherwise 1100 operatorNotAllowed).
playerIdstringNoOpaque; no personal data. Send the Operator's own player id so a player's progress is shared across streams. Required unless demo is true; for a demo it is optional, only counts the session as verified (needed where the profile requires a verified session) and is never stored.
gameIdstring: reel-stars | reel-triple | reel-streakYes
currencystringYesA real currency; for a demo session `FUN`.
languagestringNo
demobooleanNotrue creates a Demo Session in the fun currency FUN; refused with 1504 where the jurisdiction's profile forbids demo.
levelintegerNoOptional. The bet level the casino has selected: the widget shows the player's card of this level (in the session currency) when it connects. Display only: every bet still names its own level. A level the Operator does not offer for the game is refused with 1200; a demo session ignores it.
levelsinteger[]NoOptional. The bet levels (bet sizes) the casino allows this player in this session: the widget shows the price of these only and its level control steps through these only; one level fixes the bet. Each must be offered by the Operator for the game, and `level`, when sent, must be one of them (else 1200). Display only: a bet at another offered level is still played. A demo session ignores it.

Responses

  • 201 Session created (a demo session has the `dses_` and `dst_` ids)
  • 4XX Error
  • 5XX Error
POST/v1/partner/sessions/{sessionId}/launch

Get a fresh one-time launch link for a session (page reload or navigation)

Requires X-RX-Nonce (not idempotent). Works only on an active session. Rate limited per session (1600 rateLimited). Refused with 503 1506 maintenance during a planned maintenance window. Once the new link is opened, the widget's new session key replaces the previous one and the old widget's connection is closed. The new widget shows the player's current state. Does not reset idle expiry.

Parameters

NameInTypeRequiredDescription
X-RX-NonceheaderstringYesA fresh value for every request, used once. Missing or malformed is 400 1200; reused is 401 1002.
sessionIdpathstringYes

Responses

  • 200 New launch link
  • 4XX Error
  • 5XX Error
DELETE/v1/partner/sessions/{sessionId}

Close a session (log the player out)

Requires X-RX-Nonce. Closing a session that is already closed is not an error (204). A session that does not exist, or that belongs to another Partner, is 404 1301 sessionNotFound.

Parameters

NameInTypeRequiredDescription
X-RX-NonceheaderstringYesA fresh value for every request, used once. Missing or malformed is 400 1200; reused is 401 1002.
sessionIdpathstringYes

Responses

  • 204 Session closed
  • 4XX Error
  • 5XX Error

Bets

POST/v1/partner/bets

Place an Extra Bet and receive the win

Takes no nonce. Idempotent by betId: retry the identical request until a definite answer (HTTP 200, a non-429 4xx, or 503 with code 1506 maintenance). A different request with the same betId returns 409 betIdReuse. During a planned maintenance window that is running (`active` true in `maintenance`) a new bet is refused with 503 1506 maintenance (definite: refund it); a retry of an already accepted bet still returns its result. A window that has only been announced does not refuse bets. When the server cannot confirm the bet it answers 503 9001 serviceUnavailable (retryable): retry with the same betId. The stored Pending Outcome is finished and never replayed, so the bet is paid once. A new bet into the Network Pools of an Operator (or Group) that staff have suspended for non-payment is refused with 403 1507 settlementSuspended (definite: refund it, don't retry that betId); fixed-prize games and Operator-owned Pools are not affected. A new bet is also refused with 403 1508 sideGameOff (definite: no Round was made, refund it, don't retry that betId) while the player's on/off switch of that game is off or the widget is hidden; ReelXtra decides this, not the Partner. A retry of an already accepted bet still returns its result.

Request body (application/json, BetRequest)

NameTypeRequiredDescription
sessionTokenstringYesThe `st_...` token of a real session, or the `dst_...` token of a demo session (the bet is then a demo play in `FUN`).
betIdstringYesPrintable ASCII, unique per Partner for at least 7 days
betCreatedAtstring (date-time)YesISO 8601 UTC with exactly millisecond precision, e.g. 2027-03-01T12:00:00.000Z
levelintegerYesThe Bet Level the player selected. It selects the player's card. A level that is not one of the levels offered to the Operator is 1200 validationFailed.
amountobjectYesGreater than 0. The amount actually bet, which is what the Partner debited. It must equal the current price of level, otherwise 1201 priceMismatch. Jackpot contributions are calculated from it.
currencystringYesMust be the currency of the session, otherwise 1202 currencyNotSupported.
triggerobjectNoThe slot spin or casino bet that caused the play. Context only: the Extra Bet amount is still a ladder level chosen by the player. Optional and never checked against a limit; combined-bet caps are the Partner's responsibility. Part of the idempotency check: the same betId with a different trigger returns 1400 betIdReuse.

Responses

  • 200 Definite result (committed, voided or cancelled)
  • 4XX Error
  • 5XX Error
POST/v1/partner/bets/{betId}/cancel

Cancel a bet that has not committed

Takes no nonce. Send the same fields as the original bet; the betId in the path must equal the betId in the body, otherwise 400 1200 validationFailed. Returns cancelled, or the stored committed/voided result when it is too late to cancel. Cancelling an unknown betId records it so a late copy is refused.

Parameters

NameInTypeRequiredDescription
betIdpathstringYes

Request body (application/json, BetRequest)

NameTypeRequiredDescription
sessionTokenstringYesThe `st_...` token of a real session, or the `dst_...` token of a demo session (the bet is then a demo play in `FUN`).
betIdstringYesPrintable ASCII, unique per Partner for at least 7 days
betCreatedAtstring (date-time)YesISO 8601 UTC with exactly millisecond precision, e.g. 2027-03-01T12:00:00.000Z
levelintegerYesThe Bet Level the player selected. It selects the player's card. A level that is not one of the levels offered to the Operator is 1200 validationFailed.
amountobjectYesGreater than 0. The amount actually bet, which is what the Partner debited. It must equal the current price of level, otherwise 1201 priceMismatch. Jackpot contributions are calculated from it.
currencystringYesMust be the currency of the session, otherwise 1202 currencyNotSupported.
triggerobjectNoThe slot spin or casino bet that caused the play. Context only: the Extra Bet amount is still a ladder level chosen by the player. Optional and never checked against a limit; combined-bet caps are the Partner's responsibility. Part of the idempotency check: the same betId with a different trigger returns 1400 betIdReuse.

Responses

  • 200 Definite result
  • 4XX Error
  • 5XX Error
GET/v1/partner/rounds/{betId}

Look up the stored result of a bet

Bets older than 30 days are forwarded by the silo to the internal history reader (Reporting). A bet that is not committed has zero money fields and a null `roundId`. A look-up never changes a bet. An unknown betId returns 404 1401 betNotFound, which is not final: cancel the bet and refund only when cancel returns cancelled. A bet accepted but not yet final returns 409 1402 betInProgress with Retry-After.

Parameters

NameInTypeRequiredDescription
betIdpathstringYes

Responses

  • 200 Stored result
  • 4XX Error
  • 5XX Error
POST/v1/partner/rounds/{betId}/history

Get a signed link to the round history page for a bet

Takes the betId only (path), no body, no nonce. The silo signs the link itself, so the call never waits on another server and does not check that the bet exists. The link is valid for 24 hours and opens in a browser (it is served under /v1/public, not signed with HMAC). A bet that is unknown, or not yet replicated to Reporting, shows a "not found / not yet available" page. Give the player a new link by calling again.

Parameters

NameInTypeRequiredDescription
betIdpathstringYes

Responses

  • 200 Signed history link
  • 4XX Error
  • 5XX Error

Games

GET/v1/partner/games

List the Extra Games enabled for an Operator

Only games that are enabled and that the Operator has a Game Variant for are listed. A game with a planned maintenance window running now, or one starting within the next 24 hours, carries `maintenance`.

Parameters

NameInTypeRequiredDescription
operatorIdquerystringNoRequired for a Provider. Optional for an Operator Partner with exactly one Operator. The code of one of your Operators (otherwise 1100 operatorNotAllowed).

Responses

  • 200 Games
  • 4XX Error
  • 5XX Error
GET/v1/partner/games/{gameId}/levels

Read the levels the Operator offers for a game and currency, with their prices

Returns exactly the levels offered to the Operator for the game, which may have gaps, with the current price of each. A currency the Operator does not offer (including one with no exchange rate yet) returns 1202 currencyNotSupported. A bet at a level not in the list is refused with 1200 validationFailed; a listed level at another price is 1201 priceMismatch. The demo currency `FUN` is offered here only where the Operator's profile allows demo, with the Operator's own ladder prices. `maintenance` is present while a planned maintenance window is running for the game, or starts within the next 24 hours.

Parameters

NameInTypeRequiredDescription
gameIdpathstring: reel-stars | reel-triple | reel-streakYes
operatorIdquerystringNoRequired for a Provider. Optional for an Operator Partner with exactly one Operator. The code of one of your Operators (otherwise 1100 operatorNotAllowed).
currencyquerystringYes

Responses

  • 200 Bet ladder
  • 4XX Error
  • 5XX Error
GET/v1/partner/games/{gameId}/rules

Rules text and paytable for the Operator's Game Variant

Returns the rules as an HTML fragment (every text escaped, no script, no style) with the RTP of the Operator's Game Variant including the jackpot contribution. A language with no translation falls back to English; the answer's language says which one was used. `language` is a tag of 2 to 35 letters, digits, hyphens and underscores (such as `en`, `pt-BR` or `en_SC`), otherwise 1200 validationFailed.

Parameters

NameInTypeRequiredDescription
gameIdpathstring: reel-stars | reel-triple | reel-streakYes
operatorIdquerystringNoRequired for a Provider. Optional for an Operator Partner with exactly one Operator. The code of one of your Operators (otherwise 1100 operatorNotAllowed).
languagequerystringNo

Responses

  • 200 Rules
  • 4XX Error
  • 5XX Error
GET/v1/partner/currencies

Currencies enabled for your Operators, with precision

Responses

  • 200 Currencies
  • 4XX Error
  • 5XX Error

Players

POST/v1/partner/players/{playerId}/block

Block a player (self-exclusion or Operator decision)

Requires X-RX-Nonce. The block closes the player's open sessions and is applied on every silo at once; new sessions and bets are refused with 1501. When until is sent (a time in the future) it is stored and the block ends at that time; without it the block is indefinite. Blocking a player who is already blocked the same way changes nothing and is not an error.

Parameters

NameInTypeRequiredDescription
X-RX-NonceheaderstringYesA fresh value for every request, used once. Missing or malformed is 400 1200; reused is 401 1002.
playerIdpathstringYes

Request body (application/json)

NameTypeRequiredDescription
operatorIdstringNoRequired for a Provider. Optional for an Operator Partner with exactly one Operator. The code of one of your Operators (otherwise 1100 operatorNotAllowed).
reasonstring: selfExclusion | operatorBlock | otherYes
untilstring (date-time)NoOmit for an indefinite block. A time that is not in the future is 1200 validationFailed.

Responses

  • 204 Blocked
  • 4XX Error
  • 5XX Error
POST/v1/partner/players/{playerId}/unblock

Remove a block

Requires X-RX-Nonce. Unblocking a player who is not blocked changes nothing and is not an error. Only the Partner that set the block, or an Operator Partner of the same Operator, can lift it; any other Partner gets 1103 unblockNotAllowed and the block stays. The body may be empty or `{}` when the Operator is implied.

Parameters

NameInTypeRequiredDescription
X-RX-NonceheaderstringYesA fresh value for every request, used once. Missing or malformed is 400 1200; reused is 401 1002.
playerIdpathstringYes

Request body (application/json)

NameTypeRequiredDescription
operatorIdstringNoRequired for a Provider. Optional for an Operator Partner with exactly one Operator. The code of one of your Operators (otherwise 1100 operatorNotAllowed).

Responses

  • 204 Unblocked
  • 4XX Error
  • 5XX Error

Reconciliation

GET/v1/partner/reconciliation/{date}

Every round committed on a UTC date for one Operator

Authenticated by the silo and answered from the Reporting side (the silo asks the internal history reader); the Partner key stays in the silo. The file holds your own rounds only, in commit order, then the day's cancelled and voided bets with a zero win. Send `Accept: application/x-ndjson` (the default) for JSON lines or `Accept: text/csv` for CSV (a header line, then one line per bet; the carried bonus is spread over `carriedBonusId`, `carriedBonusAmount` and `carriedBonusOriginRoundId`). Amounts are in the currency's precision. A day with no rounds is an empty file. An Operator Partner with exactly one Operator may omit operatorId; a Provider must send it. The CSV columns are `status, betId, roundId, gameId, level, currency, amount, baseWin, progressiveWin, poolId, poolOwnerType, bonusId, carriedBonusId, carriedBonusAmount, carriedBonusOriginRoundId, win, committedAt, serverTime, lockedByPartner`; a cell that starts with `=`, `+`, `-` or `@` is prefixed with an apostrophe. The `date` must be `yyyy-MM-dd`, otherwise 1200 validationFailed. The file is streamed: if our history reader fails part-way, the response is cut off rather than ended cleanly, so treat a failed or truncated transfer as an incomplete file and fetch it again.

Parameters

NameInTypeRequiredDescription
datepathstring (date)Yes
operatorIdquerystringNoRequired for a Provider. Optional for an Operator Partner with exactly one Operator. The code of one of your Operators (otherwise 1100 operatorNotAllowed).

Responses

  • 200 One round per line
  • 4XX Error
  • 5XX Error

Operations

GET/v1/partner/status

Service status and planned maintenance

`status` is `maintenance` while a planned maintenance window is running for any game of any of your Partner's Operators, otherwise `operational`. Each entry of `maintenance` is a window that is running now: `from` is the time of the call, `to` the end of the window and `description` the game code.

Responses

  • 200 Status
  • 4XX Error
  • 5XX Error