Introduce
This document is intended to provide integration guidelines for the Game API service, helping establish a stable and seamless connection mechanism between the Licensee and the Game provider.
Terminology Reference
To ensure consistent understanding of technical terms and avoid ambiguity during collaboration, this document standardizes the definitions of core terminology. In the following sections, terms within the defined scope will be indicated in italics for identification.
Identity-Related
| Term | Description |
|---|---|
| Licensee | Also referred to as Operator. Responsible for managing Player accounts, safeguarding funds, and handling final settlement. Under the One Wallet architecture, the Licensee system controls real-time debits and credits of the Player wallet and must ensure high availability of API responses. |
| Player | Refers to the end user registered in the Licensee system with a unique identifier (Player ID). Within the system architecture, the Player is the entity of all transactions and gameplay activities. Compliance checks (e.g., age verification, regional restrictions), account permissions, and final balance management are all handled and maintained by the Licensee. |
| Game Provider | Responsible for developing and operating game products and maintaining game logic. Connects with the Licensee platform via APIs and sends transaction requests (e.g., bets, payouts, cancellations). In non-transfer models, it does not directly manage Player funds. |
Wallet-Related
| Term | Description |
|---|---|
| Seamless Wallet | Also known as Single Wallet. The Player holds a single balance managed by the Licensee, and all gameplay actions access the main wallet in real time via APIs. This model does NOT REQUIRE manual fund transfers to start playing. |
| Transfer Wallet | Also known as Multi Wallet. The Game Provider creates a separate "sub-wallet" for the Player within its own system. The Player must manually or via interface transfer funds from the main account to the sub-wallet before playing. All transactions and settlements on the game side occur within this sub-wallet. |
| Withdrawal | The operation where a Player transfers funds from the Game Provider wallet back to the Licensee. |
| Deposit | The operation where a Player transfers funds from the Licensee wallet to the Game Provider. |
Game-Related
| Term | Description |
|---|---|
| Main Bet | Refers to the primary wager in the core game logic. For example, in "Baccarat", it includes Banker, Player, and Tie; in "Slot-Machine", it refers to the base bet for each spin. |
| Side Bet | Additional betting options beyond the main game, typically with higher odds. Examples include "Pair", "Big/Small", or "Perfect Pair" in Baccarat. |
| Demo Mode | A mode that allows the Player to play using virtual funds. In this mode, no actual debit requests are sent to the Licensee. |
| Jackpot | A large prize pool accumulated by taking a portion of Player bets. It can be either fixed or progressive, and is calculated and triggered by the Game Provider. |
| Session | The active period from when a Player enters a game until they leave. Each Session is typically associated with a unique ID used to track all Transactions and gameplay activities during that period, and serves as a basis for security validation. |
| Transaction | The smallest unit of fund movement, including Debit (deduction), Credit (payout), and Cancel (reversal) operations. |
| Payout | A request initiated by the Game Provider to return winnings to the Licensee main wallet after a game result is determined. This represents the player’s winning outcome, including standard payouts, multiplier rewards, and refunds of unused bets. |
| Promo Payout | Additional credits granted based on marketing campaigns, promotional rules, or incentive mechanisms defined by the Licensee or Game Provider. It does not represent game outcomes and is independent of betting logic, and is accounted for separately from standard Payout. |
Getting Started
Please review and confirm the process described in S2S Authentication first, and align with the Game Provider on the following implementation details:
- Use of One Wallet or Multi Wallet architecture
- Authentication method (JWT / signature algorithm / key exchange)
- Currency and precision settings
- Supported languages and game modes
Pre-Integration Preparation
Before entering the testing environment, ensure the following have been completed:
- API Endpoint configuration
- IP Address whitelist setup
- Public/private key exchange or Client Secret configuration