Turnkeyxgaming

Documentation

Turnkeyxgaming API documentation

This is the public casino aggregator API documentation overview: what each endpoint group does, how requests are authenticated and how the operator API and the seamless wallet fit together.

  • authentication
  • game list
  • launch
  • wallet
  • encrypted callbacks
  • errors

01

Casino API authentication

Full schemas, error codes and test cases ship with sandbox credentials in the docs pack.

Casino API authentication uses per-environment operator keys, timestamps and IP allowlists, all three together. Requests you send carry your operator ID and a timestamp. Wallet callbacks we send are AES-encrypted with the key issued for your environment, and a payload that fails to decrypt is rejected before any wallet movement. The cipher and key handling for your account are stated in your credentials pack.

Your docs pack specifies the encryption scheme and how keys are issued and rotated per environment. Do not implement from a public example before you have the pack; key handling, not the cipher, is where most callback-security mistakes happen.

02

Casino game list API

The casino game catalogue API returns every title enabled for your brand and market. Paginate the call, cache the response and refresh it daily or when a catalogue webhook arrives.

GET /v1/games?brand=main&market=MT&page=1
{
  "page": 1,
  "total": 12408,
  "games": [
    {
      "id": "evo_crazy_time",
      "name": "Crazy Time",
      "studio": "Evolution",
      "category": "live_game_show",
      "demo": false,
      "devices": ["desktop", "mobile"]
    }
  ]
}
Illustrative response. The real schema is in the docs pack.

03

Casino game launch API: demo and real gameplay

One call covers both modes. The demo and real gameplay API differs only in the mode flag. Demo sessions never call your wallet. The response is a game launch URL the aggregator API generates for this session only.

POST /v1/sessions
{
  "player_id": "p_82731",
  "game_id": "evo_crazy_time",
  "mode": "real",
  "currency": "EUR",
  "language": "en",
  "device": "mobile",
  "return_url": "https://your-casino.example/lobby"
}

201 Created
{ "launch_url": "https://…/play?session=…", "expires_in": 60 }
Illustrative. Launch creates a server-side session; it is not a read-only call. URLs are single-use and short-lived.

What the full docs pack adds

The public examples above are illustrative and deliberately incomplete. The versioned docs pack issued with sandbox credentials adds: a protocol version on every callback, credential-free JSON schemas for each request and response, the exact error-code table with HTTP status and retry guidance, decryption examples in several languages, and the retry bounds your agreement sets. Without those, treat a route name here as a description of intent, not an executable contract.

04

Seamless wallet API documentation

The operator API seamless wallet contract is four endpoints on your side: balance, debit, credit and rollback. The casino wallet API page walks through payloads, idempotency and retries. The docs pack adds the full error-code table and the test cases your wallet must pass before production access.

05

Operator API vs supplier API in an aggregator

Aggregator documentation describes two interfaces, and only one of them is yours to build against.

Operator APISupplier API
Who uses itYou, the operatorStudios connecting to the aggregator
What it coversCatalogue, launch, bonuses, reporting and your wallet callbacksGame registration, round reporting and studio-side settlement
Your concern?Yes, this is the integrationNo, we maintain it for every studio

Getting the full game aggregator API docs

The complete game aggregator API docs include the endpoint reference, error codes, callback decryption examples in several languages and the wallet test suite. They are issued with sandbox access, because the base URLs and keys are tied to your account. To request them, contact sales with your company name and target markets.

If you are still evaluating, the integration guide and how a casino API works explain the architecture without credentials. Together with this overview, they are the iGaming API documentation most teams read before a technical call.

Access

What is public here and what ships with sandbox credentials

The split is deliberate: everything account-independent is public, everything tied to your keys is issued with them.

TopicPublic on this pageIn the docs pack
Endpoint groupsCatalogue, launch and wallet, with the shape of eachFull schemas, field-by-field, per version
AuthenticationThe model: operator keys, timestamps, IP allowlistsYour keys, per environment, and the rotation procedure
CallbacksThat wallet callbacks are AES-encryptedThe protocol version, key handling and decryption examples in several languages
ErrorsThat unreadable and wrong-environment payloads are rejectedThe complete error-code table and what each one asks you to do
Wallet contractThe four endpoints and their rolesThe wallet test suite your implementation must pass before production

Reading order

Reading order for an engineer picking this up

About two hours of reading puts a backend engineer in a position to build against the sandbox the day credentials arrive.

  1. 0120 minutes

    This overview, top to bottom

    It gives the endpoint groups and the authentication model. Skip the code samples' details; they are illustrative and the schemas come later.

  2. 0220 minutes

    How a casino API works

    The architecture guide explains who calls whom and where the balance lives. Read it before the integration guide, not after.

  3. 0330 minutes

    The integration guide

    The integration page lays out the phases and what each one needs finished before the next starts.

  4. 0430 minutes

    The wallet pages

    The casino wallet API page is the one to read twice: the four wallet calls are the core contract, and everything else in the integration is easier than they are.

  5. 05After access

    Request credentials, then run the wallet test suite

    Sandbox access issues the pack. Build the four wallet endpoints first, run the suite, and treat a failure there as blocking — it is the same gate production access uses.

Core contract

The four wallet endpoints, as the part to build first

Catalogue and launch are straightforward HTTP. The wallet is where the work is, and the order below is the one that avoids rework.

  • Balance first: return the spendable balance for the session currency, and make it correct before anything else, because every later call is measured against it
  • Debit with a transaction UUID from the start: retries are normal on money movement, and idempotency is designed in, not patched on
  • Credit exactly once per transaction UUID, including zero-win settlements, which fire and are easy to miss in testing
  • Rollback refunds the original debit once and treats an unknown original as already reversed — the parity check between debit and rollback catches most ledger bugs
  • Reject unreadable, stale or wrong-environment callbacks rather than defaulting them through, and log each rejection with enough detail to diagnose from the record alone
  • Only then build the lobby: catalogue caching, launch URLs and demo mode are a day or two of work each once the wallet holds

FAQ

Questions operators ask

Is the full casino API documentation public?

This overview is public. The full casino API docs are shared with sandbox credentials because they contain account-specific URLs and keys.

How are wallet callbacks secured?

Callbacks are AES-encrypted with keys issued per environment. The cipher, protocol version, key distribution and rotation are described in your credentials pack; do not guess from a public example.

Can we start building before sandbox credentials exist?

Yes. The wallet shape, the authentication model and the endpoint groups are public, so a backend engineer can build a wallet implementation while the paperwork for credentials runs. The full schemas and error codes arrive with the pack.

Which endpoint group should we build first?

The wallet. The catalogue call is read-only; the launch call creates a short-lived session and is easy to iterate on; the wallet moves money and is the contract your ledger signs. The production gate is a wallet test suite, so build it first and test it early.

What does the wallet test suite check?

It exercises the four wallet endpoints the way production traffic will: retries with the same transaction UUID, zero-win credits, rollbacks of known and unknown debits, and responses your ledger should reject. The suite ships with the docs pack, and passing it is required before production access.

Keep reading

Related pages

  • IntegrationIntegrationSandbox keys, AES-encrypted wallet callbacks and the four wallet endpoints, then a 24–72 hour go-live once decryption and retries pass.Read
  • Product · WalletWalletBalance, bet, win and rollback on one seamless wallet: idempotent transaction ids shared by casino games and sportsbook alike.Read
  • Product · Casino APICasino APIThe casino API is one contract — a catalogue, a launch call and wallet callbacks — built once and reused for every studio we connect.Read
  • Guide · ArchitectureHow a casino API worksOne casino round traced end to end: catalogue, launch, wallet callbacks, settlement and the report line the next morning.Read

Get a written quote and sandbox access

Tell us your licence, target markets and products. You get the GGR rate in writing, the studio list for your markets and sandbox credentials.

Telegram @turnkeyxhub WhatsApp Email Contact form