JRGS Casino API

Jackpots, history and replay

How a jackpot win reaches your wallet, what round history you can see today, and what does not exist yet.

Jackpot wins

The shared jackpot service is not yet running in production. This section describes the protocol as built, ahead of its rollout.

Some games feed jackpot pools. A jackpot is held by the RGS jackpot service, not by the round, so a win reaches your wallet as its own credit, made by that service, never as part of the round's credit.

{
  "transactionId": "0193a5c2-7a1e-7c3b-9f00-2b1d4e6a8c10:jackpot:grand-gbp:major:0",
  "roundId": "0193a5c2-7a1e-7c3b-9f00-2b1d4e6a8c10",
  "playerId": "p-1001",
  "gameId": "slots",
  "gameVersion": "1.4.0",
  "variant": "965",
  "currency": "GBP",
  "amount": 125000000
}

The body is an ordinary credit, to POST /credit, signed the same way. What is different:

  • The id is {roundId}:jackpot:{pool}:{level}:{index}. It is fixed when the win is recorded, and every retry, from any replica of the service, sends the same one. Pool and level names contain no colon.
  • It is a second credit on the same roundId. The round's own credit, {roundId}:credit, carries the round's payout without the jackpot. Your wallet must accept a further credit for a round, under a different id.
  • It usually arrives after the round is closed. With the default setting, a pool pays a win only once the RGS journal shows the round closed, which is after its own credit succeeded (or after the RGS team marked that credit settled by hand). A pool configured not to wait pays as soon as the win is recorded, which can be before the round's own credit. Accept both orders.
  • It does not depend on the player's state, like every credit.

Retries and refusals of a jackpot credit

The jackpot service follows the same rules as the round's credit, with its own schedule:

Your answerWhat the service does
status: ok, or alreadyProcessed: trueThe win is paid.
Unknown outcome: timeout, a non-2xx status other than 401/403, a bad signature on your answer, an unlisted code, DUPLICATERetries with the same id, waiting 1 s, doubling to at most 5 min between attempts, without end. A win unpaid for over 5 minutes raises an alert at the RGS.
A listed code, or HTTP 401/403Stops, and the win waits for a person, as the round's own credit does. The RGS team can Retry, which sends the same id again, or Mark paid with your reference and a comment once you have paid it by hand.

A win whose round was rolled back is not paid, and no credit for it reaches your wallet: the amount goes back to the pool and level it was won from, and the win shows as Returned to the pool. A win your wallet was already credited for, by a pool that does not wait for the round to close, stays paid.

Contributions are not wallet calls

A bet's contribution to a pool is part of the bet the round already debited. The RGS makes no separate debit for it, and your wallet sees no contribution transaction. Jackpot wins appear in your ledger only as the credits above.

Only a round that does not buy a feature contributes and can win a jackpot. A bonus-buy round (a mode that buys a feature, such as a bonus bought at 36 times the bet) contributes nothing to any pool and wins no jackpot, and a gamble step, which moves no new money, neither contributes nor wins. The RGS decides this from the game's certified modes, not from anything the game client sends.

Jackpots in reconciliation

A casino's export lists jackpot credits as type: credit. Reconciliation matches them by their id; it does not require them, because when a win is paid is the jackpot service's business. See Reconciliation.

The conformance suite does not yet check that your wallet accepts a second credit on a round. Make sure it does before you offer a game with jackpots.

Round history

What exists today is a screen in the backoffice. There is no casino-facing API for round history.

Rounds (in the backoffice) finds a player's rounds by your casino and your own player id, the playerId the wallet calls carry, optionally narrowed to one game. It lists the newest first, in pages, each round with:

  • its roundId, game, market, mode, variant and the setup it ran on;
  • its status: open, uncertain, closing, voided, rolled_back or closed, and whether it was settled by hand;
  • bet and win, in integer micro-units, and the currency;
  • when it started and closed;
  • its jackpot wins and what it contributed to jackpot levels;
  • how long your wallet took to answer its debit, and the credit or rollback that ended it, in milliseconds (last attempt only).

The same screen shows the player's totals per currency over closed rounds, and opens a single round's journal events, with the game's own data decoded. Events of recent rounds come from the journal; older ones from the archive.

You need the player id to find a round: there is no lookup by roundId alone. Take the roundId from the wallet call in your ledger and search for the player it belongs to.

Who can see it

A backoffice account sees only the casinos it is bound to. The See round history permission is required; the support, tenant admin and group admin roles start with it. The same permission shows Problem rounds and Reconciliation.

Replay

A replay of a round for disputes (rebuilding the round and showing it in the game client, behind a signed link) is planned and not built. There is no replay link and no replay service you can call. Until it exists, a dispute is answered from the round's journal events on the Rounds screen, which hold the round's seed, outcome and every money event.

Not built yet

Also not available today: exports of round history (CSV, scheduled, or to storage), and a notification when a reconciliation period is ready.

On this page