# Table of Contents - [Welcome | Casino API](#welcome-casino-api) - [Quickstart | Casino API](#quickstart-casino-api) - [Call Manage | Casino API](#call-manage-casino-api) - [Back Office | Casino API](#back-office-casino-api) - [API Types | Casino API](#api-types-casino-api) - [Onboarding Sub-Agents | Casino API](#onboarding-sub-agents-casino-api) - [IP Whitelist | Casino API](#ip-whitelist-casino-api) - [Sportsbook | Casino API](#sportsbook-casino-api) - [Statistics | Casino API](#statistics-casino-api) - [Control RTP | Casino API](#control-rtp-casino-api) - [Seamless | Casino API](#seamless-casino-api) - [Game API | Casino API](#game-api-casino-api) - [Transfer | Casino API](#transfer-casino-api) - [Provider List | Casino API](#provider-list-casino-api) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Game Launch | Casino API](#game-launch-casino-api) - [Unknown](#unknown) - [Game List | Casino API](#game-list-casino-api) - [Unknown](#unknown) - [Unknown](#unknown) - [FreeSpin Tour API | Casino API](#freespin-tour-api-casino-api) - [Seamless API | Casino API](#seamless-api-casino-api) - [Transfer API | Casino API](#transfer-api-casino-api) - [RTP API | Casino API](#rtp-api-casino-api) - [User Balance (Site Endpoint) | Casino API](#user-balance-site-endpoint-casino-api) - [Rate Limit | Casino API](#rate-limit-casino-api) - [Providers | Casino API](#providers-casino-api) - [Transfer Status | Casino API](#transfer-status-casino-api) - [Control Users RTP | Casino API](#control-users-rtp-casino-api) - [Reset User Balance | Casino API](#reset-user-balance-casino-api) - [Cancel Tour | Casino API](#cancel-tour-casino-api) - [Agent & User Info | Casino API](#agent-user-info-casino-api) - [Control User RTP | Casino API](#control-user-rtp-casino-api) - [CALL API | Casino API](#call-api-casino-api) - [Call Cancel | Casino API](#call-cancel-casino-api) - [Call List | Casino API](#call-list-casino-api) - [Currencies | Casino API](#currencies-casino-api) - [In-Game History | Casino API](#in-game-history-casino-api) - [Create Tour | Casino API](#create-tour-casino-api) - [Deposit / Withdraw User Balance | Casino API](#deposit-withdraw-user-balance-casino-api) - [Transaction (Site Endpoint) | Casino API](#transaction-site-endpoint-casino-api) - [Call History | Casino API](#call-history-casino-api) - [Game Log | Casino API](#game-log-casino-api) - [Current Playing Users | Casino API](#current-playing-users-casino-api) - [Call Apply | Casino API](#call-apply-casino-api) - [Languages | Casino API](#languages-casino-api) - [TopTrend | Casino API](#toptrend-casino-api) - [Joker Gaming | Casino API](#joker-gaming-casino-api) - [FaChai | Casino API](#fachai-casino-api) - [Evolution | Casino API](#evolution-casino-api) - [Evoplay | Casino API](#evoplay-casino-api) - [Sportsbook | Casino API](#sportsbook-casino-api) - [Habanero | Casino API](#habanero-casino-api) - [Playson | Casino API](#playson-casino-api) - [Spribe | Casino API](#spribe-casino-api) - [Amusnet | Casino API](#amusnet-casino-api) - [DreamTech | Casino API](#dreamtech-casino-api) - [EGT | Casino API](#egt-casino-api) - [FastSpin | Casino API](#fastspin-casino-api) - [CQ9 | Casino API](#cq9-casino-api) - [Hacksaw | Casino API](#hacksaw-casino-api) - [Booongo | Casino API](#booongo-casino-api) - [Spadegaming | Casino API](#spadegaming-casino-api) - [PGSoft | Casino API](#pgsoft-casino-api) - [Play'n GO | Casino API](#play-n-go-casino-api) - [Pragmatic Play | Casino API](#pragmatic-play-casino-api) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Providers | Casino API](#providers-casino-api) --- # Welcome | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/readme.md) . We're excited to have you here! In this documentation, you'll get a complete overview of all the incredible features that we offer to help you integrate our API into your casino platform effortlessly. Start exploring now and unlock the full potential of your gaming platform with **Casino API**! ### Jump right in[](https://ggr.gitbook.io/docs#jump-right-in) [](https://ggr.gitbook.io/docs/getting-started/quickstart) **Getting Started** Quickstart [](https://ggr.gitbook.io/docs/getting-started/back-office/ip-whitelist) IP **Whitelist** WAF Restriction [](https://ggr.gitbook.io/docs/appendix/languages) **Languages** Provider Languages [NextQuickstart](https://ggr.gitbook.io/docs/getting-started/quickstart) Last updated 8 months ago Was this helpful? --- # Quickstart | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/getting-started/quickstart.md) . ![](https://ggr.gitbook.io/docs/~gitbook/image?url=https%3A%2F%2F1723341361-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FGudIGoyLBIBfEiRAAJp7%252Fuploads%252FLOENHIQ7kU4ryG7oXh3p%252F%257BDB4AA8ED-AD5C-4565-9D22-7D8FDB7610F0%257D.png.jpg%3Falt%3Dmedia%26token%3D159904f8-30cf-46ea-91b8-9fd222bccfba&width=768&dpr=3&quality=100&sign=79e15b4cb805abd21581955a3df9afa6&sv=3) Introduction[](https://ggr.gitbook.io/docs/getting-started/quickstart#introduction) ------------------------------------------------------------------------------------ Our Casino API delivers a comprehensive and scalable gaming solution with seamless integration across a diverse portfolio of premium casino content. Operators gain instant access to **300+ Live Casino Games**, **2,860+ Slot Games**, **9 Spribe Mini Games**, and a fully featured **Sportsbook**, enabling a complete entertainment ecosystem through a single integration. ### Supported Providers[](https://ggr.gitbook.io/docs/getting-started/quickstart#supported-providers) * Live Casino * Slot Games * Sportsbook (FeedConstruct-style platform) * Mini Games ### Game Library[](https://ggr.gitbook.io/docs/getting-started/quickstart#game-library) **Game List:** [View Complete Game Library](https://bit.ly/casinogamelist?utm_source=chatgpt.com) Our extensive slot portfolio includes thousands of popular and high-performing titles from globally recognized providers. Players can enjoy premium graphics, innovative game mechanics, engaging bonus features, and optimized performance across desktop and mobile devices. The live casino portfolio combines industry-leading providers to deliver a realistic casino environment with professional dealers, real-time video streaming, and interactive gameplay. From classic table games to modern game-show experiences, operators can offer a world-class live gaming experience to their players. ### Key Features[](https://ggr.gitbook.io/docs/getting-started/quickstart#key-features) #### Comprehensive Content Portfolio[](https://ggr.gitbook.io/docs/getting-started/quickstart#comprehensive-content-portfolio) * 300+ Live Casino Games * 9 Spribe Mini Games * 2,860+ Slot Games * Full Sportsbook Integration * Single API Integration #### High Performance Infrastructure[](https://ggr.gitbook.io/docs/getting-started/quickstart#high-performance-infrastructure) * Low-latency game delivery * Stable and scalable architecture * High availability infrastructure * Global accessibility * Real-time transaction processing #### Easy Integration[](https://ggr.gitbook.io/docs/getting-started/quickstart#easy-integration) * Simple REST API implementation * Unified wallet support * Seamless user authentication * Fast onboarding process * Comprehensive developer documentation #### Security & Reliability[](https://ggr.gitbook.io/docs/getting-started/quickstart#security-and-reliability) * Secure transaction handling * Reliable balance management * Stable gameplay experience * Enterprise-grade infrastructure * Continuous monitoring and support ### Why Choose Our Casino API[](https://ggr.gitbook.io/docs/getting-started/quickstart#why-choose-our-casino-api) Our platform is designed to help operators launch and scale their gaming business efficiently. With a single integration, partners gain access to a broad range of casino products, premium game content, and a reliable backend infrastructure. Whether you are launching a new gaming platform or expanding an existing operation, our Casino API provides the flexibility, stability, and content diversity required to deliver an exceptional player experience. By combining premium live casino content, a vast slot game library, engaging mini games, and a complete sportsbook solution, our API enables operators to build a competitive and feature-rich gaming platform with minimal development effort. Unfamiliar with the Casino API? Start by understanding the [GGR percentage](https://ggr.gitbook.io/docs/getting-started/quickstart#explaining-ggr) . Explaining GGR %[](https://ggr.gitbook.io/docs/getting-started/quickstart#explaining-ggr) ------------------------------------------------------------------------------------------ An **agent** (which can be an API reseller or an online casino operator) is required to purchase an **API balance** from us to facilitate game operations. For example, if **Agent A** has a revenue share of **10%**, they can purchase an API balance of **$1,000** by paying only **$100** in real cash. This allows Agent A to generate up to **$1,000** in revenue from user gameplay using our games. > At a 10% GGR rate, if an agent deposits 100 USDT and their currency is IDR, with the USD to IDR exchange rate set at 16,000, the calculation for the API balance in IDR would be: > > **API Balance (IDR) = (Deposit Amount / GGR Rate) \* 100 \* (USD to IDR Rate)** > > Using the given values: > > **API Balance (IDR) = (100 / 10) \* 100 \* 16,000 = 16,000,000 IDR.** > > Thus, the agent would receive a balance of 16 million IDR in the API. Agents also have the ability to create **sub-agents** for their clients. Sub-agents will purchase API balance directly from the agent, and their **GGR (Gross Gaming Revenue) percentage** will typically be higher than the agent's percentage, creating an additional profit margin. The **GGR percentage** can be adjusted dynamically based on ongoing performance and business needs, allowing for flexible revenue management and strategic growth. ### **API Balance Calculation**[](https://ggr.gitbook.io/docs/getting-started/quickstart#api-balance-calculation) As users engage with the games, the API balance will decrease based on the formula: **User Total Bet – User Total Win = Agent Win** For example: * If the total bet from users is 1000 BRL and the total win is 800 BRL, the API balance will be decreased by 200 BRL. * This means you earned 200 BRL from the users. ### **GGR Share**[](https://ggr.gitbook.io/docs/getting-started/quickstart#ggr-share) Based on the 200 BRL earned, the GGR share percentage will apply. If the share is 8%, you will pay 8% for API usage. Agent Jackpot Mechanism[](https://ggr.gitbook.io/docs/getting-started/quickstart#agent-jackpot-mechanism) ---------------------------------------------------------------------------------------------------------- The Agent Jackpot is designed to regulate and balance the agent’s Return to Player (**Agent RTP**) by distributing winnings to randomly selected players. This system helps ensure that the agent's overall RTP target is maintained, even if individual player outcomes vary. ### **How It Works:**[](https://ggr.gitbook.io/docs/getting-started/quickstart#how-it-works) 1. **Current RTP Logic Issue**: In the standard RTP model, if all users lose consistently, the site retains the balance, and no players are able to withdraw their winnings. 2. **Agent Jackpot Adjustment**: The Agent Jackpot System ensures that the agent's overall RTP (based on total user bets and total user wins) is balanced. 3. **Reward Distribution**: * If individual user wins are too low to meet the agent’s RTP target, selected users may receive large rewards drawn from the total pool of user bets. * This mechanism increases the agent's RTP by ensuring that some players win substantial amounts, thereby balancing the overall payout rate. **The higher** the agent RTP relative to the user RTP, **the more frequently** users will receive jackpot winnings. ### Dynamic RTP Range: 1 ~ 999%[](https://ggr.gitbook.io/docs/getting-started/quickstart#dynamic-rtp-range-1-999) Agent-oriented RTP means that the system strictly maintains the agent RTP as a fixed benchmark. Accordingly, the total turnover generated from users is aligned with the agent RTP value. For example, if the agent RTP is set to 95% and the total user betting volume reaches 1M USD, the expected turnover would be approximately 5% (i.e., 50K USD). After this, user RTP can be configured within a range of 1 to 999, allowing certain users to have higher RTP values, which enables them to achieve withdrawals after gameplay. However, if all user RTP values are set above 100, it will not produce the intended operational effect. _**The optimal strategy is to maintain most user RTP values below the agent RTP**_, while selectively assigning higher RTP values (above 100) to specific users. The global user RTP setting can be managed via the top bar in the API panel. ### Standard Configuration:[](https://ggr.gitbook.io/docs/getting-started/quickstart#standard-configuration) * **Agent RTP:** 95% * **Default RTP for All Users:** Up to 90% * **Custom RTP for Selected Users:** Can be configured to exceed 100%, based on your requirements. [PreviousWelcome](https://ggr.gitbook.io/docs) [NextBack Office](https://ggr.gitbook.io/docs/getting-started/back-office) Last updated 1 month ago Was this helpful? --- # Call Manage | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/getting-started/back-office/call-manage.md) . **Overview:**[](https://ggr.gitbook.io/docs/getting-started/back-office/call-manage#overview) ---------------------------------------------------------------------------------------------- Free spins can be awarded to specific users, available only for slot games. Agents can select from the list of current players and grant them bonus spins through the following process. **Accessing the List of Users:**[](https://ggr.gitbook.io/docs/getting-started/back-office/call-manage#accessing-the-list-of-users) ------------------------------------------------------------------------------------------------------------------------------------ Agents can view the list of active players on the following page: `_https://{SERVER}/app/call_` **Important RTP Notes:**[](https://ggr.gitbook.io/docs/getting-started/back-office/call-manage#important-rtp-notes) -------------------------------------------------------------------------------------------------------------------- * When playing our games, users will always lose as part of the game’s design. * If the **target RTP** is set at 95%, the user’s **actual RTP** will attempt to stay below this value, but never exceed it. * To enhance the player experience, free spins can be provided to users via the API panel by you or site managers. * The betting amount during a bonus call is factored into the RTP (Return to Player) calculations, ensuring that the overall RTP remains unaffected by the bonus call transactions. **Granting Free Spins:**[](https://ggr.gitbook.io/docs/getting-started/back-office/call-manage#granting-free-spins) -------------------------------------------------------------------------------------------------------------------- 1. **Via API access**: You can assign free spins directly to users from the site backend through the `**call_apply**` API. 2. On the API Panel: * Navigate to **"Call & RTP -> Call Manage"** to view the list of users. * Select a free spin pattern from the available list and assign it to the desired user. * **Note:** Call spins are only available after the user has made at least one spin. **Types of Calls:**[](https://ggr.gitbook.io/docs/getting-started/back-office/call-manage#types-of-calls) ---------------------------------------------------------------------------------------------------------- * **Normal Call**: Applies to regular user spins. * **Buy Call**: Refers to bonus spins that a user purchases as part of a promotional feature (buying free spins). **Free Spin Conditions:**[](https://ggr.gitbook.io/docs/getting-started/back-office/call-manage#free-spin-conditions) ---------------------------------------------------------------------------------------------------------------------- * The **Free Spin** feature is only available after the user has completed at least one spin. * If the user changes their bet amount after a free spin is granted, the free spin will be invalidated and fail to apply. * Only the **win amount** can be defined when applying a free spin; the number of spins is fixed. [PreviousStatistics](https://ggr.gitbook.io/docs/getting-started/back-office/statistics) [NextIP Whitelist](https://ggr.gitbook.io/docs/getting-started/back-office/ip-whitelist) Last updated 7 months ago Was this helpful? --- # Back Office | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/getting-started/back-office.md) . [Onboarding Sub-Agents](https://ggr.gitbook.io/docs/getting-started/back-office/onboarding-sub-agents) [Statistics](https://ggr.gitbook.io/docs/getting-started/back-office/statistics) [Call Manage](https://ggr.gitbook.io/docs/getting-started/back-office/call-manage) [IP Whitelist](https://ggr.gitbook.io/docs/getting-started/back-office/ip-whitelist) [Control RTP](https://ggr.gitbook.io/docs/getting-started/back-office/control-rtp) [Sportsbook](https://ggr.gitbook.io/docs/getting-started/back-office/sportsbook) [PreviousQuickstart](https://ggr.gitbook.io/docs/getting-started/quickstart) [NextOnboarding Sub-Agents](https://ggr.gitbook.io/docs/getting-started/back-office/onboarding-sub-agents) Last updated 8 months ago Was this helpful? --- # API Types | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/getting-started/api-types.md) . [Seamless](https://ggr.gitbook.io/docs/getting-started/api-types/seamless) [Transfer](https://ggr.gitbook.io/docs/getting-started/api-types/transfer) [PreviousSportsbook](https://ggr.gitbook.io/docs/getting-started/back-office/sportsbook) [NextSeamless](https://ggr.gitbook.io/docs/getting-started/api-types/seamless) Last updated 1 year ago Was this helpful? --- # Onboarding Sub-Agents | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/getting-started/back-office/onboarding-sub-agents.md) . Sub-Agent Registration[](https://ggr.gitbook.io/docs/getting-started/back-office/onboarding-sub-agents#sub-agent-registration) ------------------------------------------------------------------------------------------------------------------------------- You are allowed to create one sub-agent per site. To initiate the process, click the \+ Create button located in the top-right corner of the page: `_https://{SERVER}/app/agent_` Field Overview Agent Code A unique identifier used by the agent to log into the API panel. Password The agent’s login credentials. Percent Displays the revenue share for the parent agent’s account. Memo Reserved. [Agent Type](https://ggr.gitbook.io/docs/getting-started/back-office/onboarding-sub-agents#agent-type) The dropdown menu provides various options. [API Type](https://ggr.gitbook.io/docs/getting-started/back-office/onboarding-sub-agents#api-type) Specifies the method used for handling player funds and game sessions. [Site Endpoint](https://ggr.gitbook.io/docs/getting-started/back-office/onboarding-sub-agents#site-endpoint) Defines the agent's backend callback URL used to handle requests from the `/gold_api` endpoint ### Agent Type[](https://ggr.gitbook.io/docs/getting-started/back-office/onboarding-sub-agents#agent-type) * **Point Manager**: The Point Manager role is responsible for creating sub-agents and allocating API points to their downline. However, this role does not have access to operate or manage the casino site. * **Both Manager**: The Both Manager role combines the responsibilities of both the Point Manager and Site Manager. This role can create sub-agents, allocate API points to the downline, and manage casino site operations, offering full access to both agent network management and casino operations. * **Site Manager**: The Site Manager role is focused solely on operating the casino site. While this role can manage site operations, it does not have the ability to create sub-agents or manage the agent network. ### API Type[](https://ggr.gitbook.io/docs/getting-started/back-office/onboarding-sub-agents#api-type) * [**Seamless**](https://ggr.gitbook.io/docs/getting-started/api-types/seamless) The player’s balance remains in the casino wallet. The system communicates directly with the game provider during gameplay to update the balance in real-time without requiring manual transfers. * Example: When a player starts a game, the balance is checked and updated directly from the casino wallet without moving funds. * [**Transfer**](https://ggr.gitbook.io/docs/getting-started/api-types/transfer) The player’s balance is transferred from the casino wallet to the game provider's wallet when the game starts, and any winnings or remaining balance are transferred back when the session ends. * Example: When a player launches a slot game, 100 USDT is deducted from the casino wallet and moved to the game wallet. After the session, the remaining balance and winnings are transferred back to the casino wallet. ### Site Endpoint[](https://ggr.gitbook.io/docs/getting-started/back-office/onboarding-sub-agents#site-endpoint) The Site Endpoint is used exclusively for the Seamless API. This allows the system to communicate with the agent’s platform for tasks such as balance updates, game results, and transaction handling. * Example: When a player completes a bet, the system sends a `/gold_api` request to the specified Site Endpoint to update the player’s balance and record the game outcome. When entering the Site Endpoint in profile page, ensure that it is an `https` domain and does not include `/gold_api` at the end, as `/gold_api` will be appended automatically when sending API requests. Please note that the API panel is limited to creating sub-agents only. To create user accounts in Transfer mode, please utilize the `user_create` API request. Deposit & Withdrawal[](https://ggr.gitbook.io/docs/getting-started/back-office/onboarding-sub-agents#deposit-and-withdrawal) ----------------------------------------------------------------------------------------------------------------------------- To deposit or withdraw API balance to a sub-agent, click the Exchange button in the Action field. ![](https://ggr.gitbook.io/docs/~gitbook/image?url=https%3A%2F%2F1723341361-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FGudIGoyLBIBfEiRAAJp7%252Fuploads%252F4sV2qX13ZQDuYhR7Mnm0%252Fimage.png%3Falt%3Dmedia%26token%3Dc4713ee7-1746-4e47-b14a-5ab18e7197e6&width=768&dpr=3&quality=100&sign=b58ce6560b13424d9a2b09c719ecf976&sv=3) Agent Manage **Agent Jackpot Config**[](https://ggr.gitbook.io/docs/getting-started/back-office/onboarding-sub-agents#agent-jackpot-config) ------------------------------------------------------------------------------------------------------------------------------- To set the Agent Jackpot, click the Config button in the Action field. ![](https://ggr.gitbook.io/docs/~gitbook/image?url=https%3A%2F%2F1723341361-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FGudIGoyLBIBfEiRAAJp7%252Fuploads%252FwbSD7myWlG32KCG6pLSX%252Fimage.png%3Falt%3Dmedia%26token%3D95c8b46c-a001-4a10-b832-eac48b43abf0&width=768&dpr=3&quality=100&sign=b3c3aaddabbd267e1bf85d8dcf3382f2&sv=3) Agent Manage **Deleting an Agent**[](https://ggr.gitbook.io/docs/getting-started/back-office/onboarding-sub-agents#deleting-an-agent) ------------------------------------------------------------------------------------------------------------------------- To delete an agent, click the last button in the Action field. Before deleting a sub-agent, ensure that all their balance is transferred to your main account, _as any remaining balance will be_ _**lost upon deletion**__._ [PreviousBack Office](https://ggr.gitbook.io/docs/getting-started/back-office) [NextStatistics](https://ggr.gitbook.io/docs/getting-started/back-office/statistics) Last updated 3 months ago Was this helpful? --- # IP Whitelist | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/getting-started/back-office/ip-whitelist.md) . **Overview**[](https://ggr.gitbook.io/docs/getting-started/back-office/ip-whitelist#overview) ---------------------------------------------------------------------------------------------- The **IP Whitelist** is a security feature that ensures only authorized backend IP addresses are allowed to access the casino API. To ensure secure communication, agents must register their backend IP addresses into the IP Whitelist page. This process allows the **Web Application Firewall (WAF)** rule to validate and approve access to the API server from those specific IP addresses. `_https://{SERVER}/app/cloudflare_` **How it Works:**[](https://ggr.gitbook.io/docs/getting-started/back-office/ip-whitelist#how-it-works) ------------------------------------------------------------------------------------------------------- 1. **Agent IP Registration**: Agents need to register their backend IP (either **IPv4** or **IPv6**) on the IP Whitelist page in the API panel to enable access to the casino API. 2. **WAF Validation**: The **Web Application Firewall (WAF)** will verify the registered IP address. Once validated, the agent's backend can successfully communicate with the API server. 3. **Duplicate IP Handling**: If an agent tries to register an IP address that is already whitelisted, an error message will appear indicating the IP is duplicated. In this case, no further registration is necessary. 4. **IPv4/IPv6 Requirement**: It is mandatory that the agent's backend IP is either **IPv4** or **IPv6**. Agents can obtain their server’s IP by running one the following commands in the CLI of their server system: Copy curl ifconfig.me curl ipinfo.io/ip curl api.ipify.org curl icanhazip.com This command will return the server’s **IPv4** or **IPv6** address, which should then be registered on the whitelist. [PreviousCall Manage](https://ggr.gitbook.io/docs/getting-started/back-office/call-manage) [NextControl RTP](https://ggr.gitbook.io/docs/getting-started/back-office/control-rtp) Last updated 3 months ago Was this helpful? --- # Sportsbook | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/getting-started/back-office/sportsbook.md) . This section explains how to configure the sportsbook behavior and integration points from the Backoffice. These settings control the visual appearance, user redirection, and betting logic of the sportsbook. `_https://{SERVER}/app/agent_` To configure sportsbook, click the "Edit" button. ![](https://ggr.gitbook.io/docs/~gitbook/image?url=https%3A%2F%2F1723341361-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FGudIGoyLBIBfEiRAAJp7%252Fuploads%252FgMxhcWgSzmP3b7Dl9gkr%252Fimage.png%3Falt%3Dmedia%26token%3Dcaec548d-d405-4cb2-85d2-d0c8a54a1d1b&width=768&dpr=3&quality=100&sign=5ed4621af77fdd7b1951e1dc08d2ee5a&sv=3) If the edit modal is opened, you can change sportsbook settings. ![](https://ggr.gitbook.io/docs/~gitbook/image?url=https%3A%2F%2F1723341361-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FGudIGoyLBIBfEiRAAJp7%252Fuploads%252FcLGVyk3nghSja4uDIwdd%252Fimage.png%3Falt%3Dmedia%26token%3Deeef0c4b-ade8-4021-b10a-912ed34076c6&width=768&dpr=3&quality=100&sign=e26effeb444e306f101bc4a36917da38&sv=3) * * * #### **Theme**[](https://ggr.gitbook.io/docs/getting-started/back-office/sportsbook#theme) The **Theme** setting controls the visual appearance of the sportsbook interface. **Purpose** * Match the sportsbook UI with your brand identity * Ensure consistent styling when embedded via iframe or opened directly **What it affects** * Color scheme (primary / secondary colors) * Buttons, backgrounds, and UI accents * Overall look & feel of the sportsbook **Usage** * Select a predefined theme from the dropdown * Themes are managed by the system and cannot be edited by partners. (Theme editor will be added soon.) **Recommendation** * Choose the same theme used by your main website for a seamless user experience * * * #### Cashout RTP[](https://ggr.gitbook.io/docs/getting-started/back-office/sportsbook#cashout-rtp) The **Cashout RTP** defines the return-to-player percentage applied when users request a **cashout before the event is settled**. **Purpose** * Control cashout profitability * Manage risk and exposure on early settlements **How it works** * Higher RTP → better cashout value for players * Lower RTP → more conservative cashout offers **Example** * Cashout RTP: `92%` * If the calculated fair value is `100.00`, the offered cashout will be `92.00` **Notes** * This setting applies only to **cashout bets** * It does not affect normal bet settlement RTP * * * #### Login URL[](https://ggr.gitbook.io/docs/getting-started/back-office/sportsbook#login-url) The **Login URL** defines where users are redirected when authentication is required. **Purpose** * Integrate the sportsbook with your existing user system * Redirect unauthenticated users to your platform login page **Usage** * Enter the full URL of your login page * The sportsbook will redirect users automatically if they are not logged in **Example** Copy https://partner-website.com/login || sendPostMessage **Best Practices** * Ensure the login page supports redirect-back after successful login * Use HTTPS only * * * #### Deposit URL[](https://ggr.gitbook.io/docs/getting-started/back-office/sportsbook#deposit-url) The **Deposit URL** specifies where users are redirected when they attempt to place a bet without sufficient balance. **Purpose** * Seamless redirection to your payment or wallet system * Improve conversion by guiding users directly to deposit **Usage** * Enter the full URL of your deposit or cashier page **Example** Copy https://partner-website.com/deposit **When it is triggered** * User clicks “Place Bet” with insufficient balance * User explicitly selects a deposit action inside the sportsbook * * * #### Integration[](https://ggr.gitbook.io/docs/getting-started/back-office/sportsbook#integration) Sportsbook is available through the "game\_launch" API using the provider\_code and game\_code parameters. "provider\_code": "SPORTSBOOK" "game\_code": "" [PreviousControl RTP](https://ggr.gitbook.io/docs/getting-started/back-office/control-rtp) [NextAPI Types](https://ggr.gitbook.io/docs/getting-started/api-types) Last updated 5 months ago Was this helpful? --- # Statistics | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/getting-started/back-office/statistics.md) . Agent Statistics[](https://ggr.gitbook.io/docs/getting-started/back-office/statistics#agent-statistics) -------------------------------------------------------------------------------------------------------- On the Agent Statistics page, you can view the API balance consumption of direct sub-agents on an hourly or daily basis within a specified date range in chart format. `_https://{SERVER}/app/agent_statistics_` User Staticstics[](https://ggr.gitbook.io/docs/getting-started/back-office/statistics#user-staticstics) -------------------------------------------------------------------------------------------------------- On the User Statistics page, you can view the bet summary of users from selected agents within a specified date range. `_https://{SERVER}/app/user_statistics_` To export the data in Excel format, click the buttons located at the top left of the table. [PreviousOnboarding Sub-Agents](https://ggr.gitbook.io/docs/getting-started/back-office/onboarding-sub-agents) [NextCall Manage](https://ggr.gitbook.io/docs/getting-started/back-office/call-manage) Last updated 8 months ago Was this helpful? --- # Control RTP | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/getting-started/back-office/control-rtp.md) . Agents can view and update the RTP (Return to Player) for users on the following page: `_https://{SERVER}/app/control_rtp_` **What is RTP?**[](https://ggr.gitbook.io/docs/getting-started/back-office/control-rtp#what-is-rtp) ---------------------------------------------------------------------------------------------------- RTP is the percentage of the total bet that a player is expected to win back over time. For example, if the RTP is set at 90% and the user bets 100, the user can win a maximum of 90. * **Note:** RTP is not related to the GGR (Gross Gaming Revenue) share percentage. Even if the RTP is set to 90%, the user's **real RTP** may fluctuate and will attempt to reach the target RTP while the game is played. [PreviousIP Whitelist](https://ggr.gitbook.io/docs/getting-started/back-office/ip-whitelist) [NextSportsbook](https://ggr.gitbook.io/docs/getting-started/back-office/sportsbook) Last updated 8 months ago Was this helpful? --- # Seamless | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/getting-started/api-types/seamless.md) . Our API offers a **seamless integration solution**, enabling direct management of user balances with enhanced flexibility and security. With **Seamless Mode**, each time a user initiates a spin, the API retrieves the user's balance from your platform and transmits the spin results accordingly. This ensures real-time synchronization between your system and the API, requiring your backend to handle **user balance requests and transaction processing** efficiently. **Key Advantages**[](https://ggr.gitbook.io/docs/getting-started/api-types/seamless#key-advantages) ---------------------------------------------------------------------------------------------------- * ✅ **Full Control Over User Balances** – Your platform manages deposits, withdrawals, transaction logs, and statistical data independently. * ✅ **Enhanced Security** – User balances remain within your system, mitigating risks associated with potential malicious activities from third-party API providers. * ✅ **Multi-API Compatibility** – Integrate multiple APIs without conflicts, ensuring smooth operation across different providers. * ✅ **Real-Time Transaction Processing** – The API communicates directly with your backend to retrieve user balances, verify authority, and update transactions based on betting outcomes. By leveraging this **Seamless Integration**, your casino can efficiently manage user balances across various gaming providers, ensuring a **secure, flexible, and uninterrupted gaming experience**. [PreviousAPI Types](https://ggr.gitbook.io/docs/getting-started/api-types) [NextTransfer](https://ggr.gitbook.io/docs/getting-started/api-types/transfer) Last updated 1 year ago Was this helpful? --- # Game API | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/integration/game-api.md) . API access[](https://ggr.gitbook.io/docs/integration/game-api#api-access) -------------------------------------------------------------------------- `_https://{SERVER}/app/profile_` All agent information can be retrieved from the profile page, including the following details: * API Endpoint * Agent Token * Agent Secret * Site Endpoint Please refer to the profile page whenever you need to review or verify your integration settings. Ensure that these credentials are stored securely and are not shared with unauthorized parties. [PreviousTransfer](https://ggr.gitbook.io/docs/getting-started/api-types/transfer) [NextProvider List](https://ggr.gitbook.io/docs/integration/game-api/provider-list) Last updated 3 months ago Was this helpful? --- # Transfer | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/getting-started/api-types/transfer.md) . **What is Transfer API?**[](https://ggr.gitbook.io/docs/getting-started/api-types/transfer#what-is-transfer-api) ----------------------------------------------------------------------------------------------------------------- **Transfer API** is a streamlined integration method where player funds are transferred to our system, and we manage their balances directly. It simplifies transaction handling by offloading balance management to our API, making the process more efficient and reducing backend complexity. * * * 🚀 **How It Works:**[](https://ggr.gitbook.io/docs/getting-started/api-types/transfer#how-it-works) ---------------------------------------------------------------------------------------------------- 1. **API User Creation:** * You create an **API user** linked to the player’s account on your platform. * This API user acts as the player’s wallet within our system. 2. **Balance Transfer:** * Before starting a game, the player transfers a portion of their site balance to their **API user account**. * When a user transfers **X** balance to their API account, the agent supplies **X** from their **remaining API balance** to the player’s API account. * This means: ➔ **Agent balance** = Agent’s own balance + Total user balances 3. **Game Play:** * Once the player starts a game, your platform **does not track** the balance changes from the player’s spins — we handle that directly. * All in-game balance adjustments happen within the API environment. 4. **Settlement:** * After the game session ends, the updated balance can be retrieved from the API and settled accordingly. * * * 🆚 **How is it Different from Seamless Integration?**[](https://ggr.gitbook.io/docs/getting-started/api-types/transfer#how-is-it-different-from-seamless-integration) ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- **Feature** **Transfer API** **Seamless Integration** **Funds Management** Funds are transferred to our API and managed by us. Funds remain in your system and are managed through your backend. **Deposits/Withdrawals** Funds are stored in our database. Funds are stored in your database. **Balance Changes During Play** No need to track balance changes during play — we handle it. Balance changes are reported back to your system for processing. **API Complexity** Direct API call — quick and simple. API call + backend interaction — more complex. * * * ✅ **Why Use Transfer API?**[](https://ggr.gitbook.io/docs/getting-started/api-types/transfer#why-use-transfer-api) ------------------------------------------------------------------------------------------------------------------- ✔️ **Simplified Setup:** Just create an API user and transfer funds — no complex backend tracking needed. ✔️ **Fast Transactions:** Direct communication with our system ensures quicker response times. ✔️ **Reduced Backend Load:** Offloads balance management to our system, reducing server stress. ✔️ **Accurate Balancing:** Agent balances are automatically adjusted based on user transfers. * * * **Transfer API** makes managing player funds easier, faster, and more secure — giving you a hassle-free way to handle game balances! [PreviousSeamless](https://ggr.gitbook.io/docs/getting-started/api-types/seamless) [NextGame API](https://ggr.gitbook.io/docs/integration/game-api) Last updated 1 year ago Was this helpful? * [What is Transfer API?](https://ggr.gitbook.io/docs/getting-started/api-types/transfer#what-is-transfer-api) * [🚀 How It Works:](https://ggr.gitbook.io/docs/getting-started/api-types/transfer#how-it-works) * [🆚 How is it Different from Seamless Integration?](https://ggr.gitbook.io/docs/getting-started/api-types/transfer#how-is-it-different-from-seamless-integration) * [✅ Why Use Transfer API?](https://ggr.gitbook.io/docs/getting-started/api-types/transfer#why-use-transfer-api) Was this helpful? --- # Provider List | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/integration/game-api/provider-list.md) . **Endpoint**[](https://ggr.gitbook.io/docs/integration/game-api/provider-list#endpoint) ---------------------------------------------------------------------------------------- Copy POST https://{API_SERVER} **Request Body**[](https://ggr.gitbook.io/docs/integration/game-api/provider-list#request-body) ------------------------------------------------------------------------------------------------ Copy { "method": "provider_list", "agent_code": "testAgent", "agent_token": "41f5cc794aef2b138c715cf25f767cc1" } Key Type Description method string The method type ( `provider_list`) agent\_code string The agent's code agent\_token string The agent's authentication token **Success Response Example**[](https://ggr.gitbook.io/docs/integration/game-api/provider-list#success-response-example) ------------------------------------------------------------------------------------------------------------------------ Copy { "status": 1, "msg": "SUCCESS", "providers": [\ {\ "code": "PRAGMATIC",\ "name": "Pragmatic Play",\ "status": 1\ }\ ] } Key Type Description status integer (32bit) `1` – Success, `0` – Failure msg string Response message providers array List of available providers code string Provider code name string Provider name status integer (32bit) `1` – Open, `0` – Maintenance * * * **Failure Response Example**[](https://ggr.gitbook.io/docs/integration/game-api/provider-list#failure-response-example) ------------------------------------------------------------------------------------------------------------------------ Key Type Description status integer (32bit) `0` – Failure msg string Error message [PreviousGame API](https://ggr.gitbook.io/docs/integration/game-api) [NextGame List](https://ggr.gitbook.io/docs/integration/game-api/game-list) Last updated 2 months ago Was this helpful? * [Endpoint](https://ggr.gitbook.io/docs/integration/game-api/provider-list#endpoint) * [Request Body](https://ggr.gitbook.io/docs/integration/game-api/provider-list#request-body) * [Success Response Example](https://ggr.gitbook.io/docs/integration/game-api/provider-list#success-response-example) * [Failure Response Example](https://ggr.gitbook.io/docs/integration/game-api/provider-list#failure-response-example) Was this helpful? Copy { "status": 0, "msg": "INTERNAL_ERROR" } --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/getting-started/api-types/seamless.md). # Seamless Our API offers a \*\*seamless integration solution\*\*, enabling direct management of user balances with enhanced flexibility and security. With \*\*Seamless Mode\*\*, each time a user initiates a spin, the API retrieves the user's balance from your platform and transmits the spin results accordingly. This ensures real-time synchronization between your system and the API, requiring your backend to handle \*\*user balance requests and transaction processing\*\* efficiently. ## \*\*Key Advantages\*\* \* ✅ \*\*Full Control Over User Balances\*\* – Your platform manages deposits, withdrawals, transaction logs, and statistical data independently. \* ✅ \*\*Enhanced Security\*\* – User balances remain within your system, mitigating risks associated with potential malicious activities from third-party API providers. \* ✅ \*\*Multi-API Compatibility\*\* – Integrate multiple APIs without conflicts, ensuring smooth operation across different providers. \* ✅ \*\*Real-Time Transaction Processing\*\* – The API communicates directly with your backend to retrieve user balances, verify authority, and update transactions based on betting outcomes. By leveraging this \*\*Seamless Integration\*\*, your casino can efficiently manage user balances across various gaming providers, ensuring a \*\*secure, flexible, and uninterrupted gaming experience\*\*. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/getting-started/api-types/seamless.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/getting-started/quickstart.md). # Quickstart ![](https://1723341361-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGudIGoyLBIBfEiRAAJp7%2Fuploads%2FLOENHIQ7kU4ryG7oXh3p%2F%7BDB4AA8ED-AD5C-4565-9D22-7D8FDB7610F0%7D.png.jpg?alt=media&token=159904f8-30cf-46ea-91b8-9fd222bccfba) \## Introduction Our Casino API delivers a comprehensive and scalable gaming solution with seamless integration across a diverse portfolio of premium casino content. Operators gain instant access to \*\*300+ Live Casino Games\*\*, \*\*2,860+ Slot Games\*\*, \*\*9 Spribe Mini Games\*\*, and a fully featured \*\*Sportsbook\*\*, enabling a complete entertainment ecosystem through a single integration. ### Supported Providers \* Live Casino \* Slot Games \* Sportsbook (FeedConstruct-style platform) \* Mini Games ### Game Library \*\*Game List:\*\*\\ \[View Complete Game Library\](https://bit.ly/casinogamelist?utm\_source=chatgpt.com) Our extensive slot portfolio includes thousands of popular and high-performing titles from globally recognized providers. Players can enjoy premium graphics, innovative game mechanics, engaging bonus features, and optimized performance across desktop and mobile devices. The live casino portfolio combines industry-leading providers to deliver a realistic casino environment with professional dealers, real-time video streaming, and interactive gameplay. From classic table games to modern game-show experiences, operators can offer a world-class live gaming experience to their players. ### Key Features #### Comprehensive Content Portfolio \* 300+ Live Casino Games \* 9 Spribe Mini Games \* 2,860+ Slot Games \* Full Sportsbook Integration \* Single API Integration #### High Performance Infrastructure \* Low-latency game delivery \* Stable and scalable architecture \* High availability infrastructure \* Global accessibility \* Real-time transaction processing #### Easy Integration \* Simple REST API implementation \* Unified wallet support \* Seamless user authentication \* Fast onboarding process \* Comprehensive developer documentation #### Security & Reliability \* Secure transaction handling \* Reliable balance management \* Stable gameplay experience \* Enterprise-grade infrastructure \* Continuous monitoring and support ### Why Choose Our Casino API Our platform is designed to help operators launch and scale their gaming business efficiently. With a single integration, partners gain access to a broad range of casino products, premium game content, and a reliable backend infrastructure. Whether you are launching a new gaming platform or expanding an existing operation, our Casino API provides the flexibility, stability, and content diversity required to deliver an exceptional player experience. By combining premium live casino content, a vast slot game library, engaging mini games, and a complete sportsbook solution, our API enables operators to build a competitive and feature-rich gaming platform with minimal development effort. {% hint style="success" %} Unfamiliar with the Casino API? Start by understanding the \[GGR percentage\](#explaining-ggr). {% endhint %} ## Explaining GGR % An \*\*agent\*\* (which can be an API reseller or an online casino operator) is required to purchase an \*\*API balance\*\* from us to facilitate game operations. For example, if \*\*Agent A\*\* has a revenue share of \*\*10%\*\*, they can purchase an API balance of \*\*$1,000\*\* by paying only \*\*$100\*\* in real cash. This allows Agent A to generate up to \*\*$1,000\*\* in revenue from user gameplay using our games. > At a 10% GGR rate, if an agent deposits 100 USDT and their currency is IDR, with the USD to IDR exchange rate set at 16,000, the calculation for the API balance in IDR would be: > > \*\*API Balance (IDR) = (Deposit Amount / GGR Rate) \\\* 100 \\\* (USD to IDR Rate)\*\* > > Using the given values: > > \*\*API Balance (IDR) = (100 / 10) \\\* 100 \\\* 16,000 = 16,000,000 IDR.\*\* > > Thus, the agent would receive a balance of 16 million IDR in the API. Agents also have the ability to create \*\*sub-agents\*\* for their clients. Sub-agents will purchase API balance directly from the agent, and their \*\*GGR (Gross Gaming Revenue) percentage\*\* will typically be higher than the agent's percentage, creating an additional profit margin. The \*\*GGR percentage\*\* can be adjusted dynamically based on ongoing performance and business needs, allowing for flexible revenue management and strategic growth. ### \*\*API Balance Calculation\*\* As users engage with the games, the API balance will decrease based on the formula:\\ \*\*User Total Bet – User Total Win = Agent Win\*\* For example: \* If the total bet from users is 1000 BRL and the total win is 800 BRL, the API balance will be decreased by 200 BRL. \* This means you earned 200 BRL from the users. ### \*\*GGR Share\*\* Based on the 200 BRL earned, the GGR share percentage will apply. If the share is 8%, you will pay 8% for API usage. ## Agent Jackpot Mechanism The Agent Jackpot is designed to regulate and balance the agent’s Return to Player (\*\*Agent RTP\*\*) by distributing winnings to randomly selected players. This system helps ensure that the agent's overall RTP target is maintained, even if individual player outcomes vary. ### \*\*How It Works:\*\* 1. \*\*Current RTP Logic Issue\*\*: In the standard RTP model, if all users lose consistently, the site retains the balance, and no players are able to withdraw their winnings. 2. \*\*Agent Jackpot Adjustment\*\*: The Agent Jackpot System ensures that the agent's overall RTP (based on total user bets and total user wins) is balanced. 3. \*\*Reward Distribution\*\*: \* If individual user wins are too low to meet the agent’s RTP target, selected users may receive large rewards drawn from the total pool of user bets. \* This mechanism increases the agent's RTP by ensuring that some players win substantial amounts, thereby balancing the overall payout rate. {% hint style="info" %} \*\*The higher\*\* the \[agent RTP\](#user-content-fn-1)\[^1\] relative to the \[user RTP\](#user-content-fn-1)\[^1\], \*\*the more frequently\*\* users will receive jackpot winnings. {% endhint %} ### Dynamic RTP Range: 1 \\~ 999% Agent-oriented RTP means that the system strictly maintains the agent RTP as a fixed benchmark. \\ Accordingly, the total turnover generated from users is aligned with the agent RTP value. \\ For example, if the agent RTP is set to 95% and the total user betting volume reaches 1M USD, the expected turnover would be approximately 5% (i.e., 50K USD). After this, user RTP can be configured within a range of 1 to 999, allowing certain users to have higher RTP values, which enables them to achieve withdrawals after gameplay. \\ However, if all user RTP values are set above 100, it will not produce the intended operational effect. {% hint style="success" %} \*\*\*The optimal strategy is to maintain most user RTP values below the agent RTP\*\*\*, while selectively assigning higher RTP values (above 100) to specific users. \\ The global user RTP setting can be managed via the top bar in the API panel. {% endhint %} ### Standard Configuration: \* \*\*Agent RTP:\*\* 95% \* \*\*Default RTP for All Users:\*\* Up to 90% \* \*\*Custom RTP for Selected Users:\*\* Can be configured to exceed 100%, based on your requirements. \[^1\]: This parameter can be adjusted directly through the top bar in the agent panel. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/getting-started/quickstart.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/getting-started/api-types/transfer.md). # Transfer ## \*\*What is Transfer API?\*\* \*\*Transfer API\*\* is a streamlined integration method where player funds are transferred to our system, and we manage their balances directly. It simplifies transaction handling by offloading balance management to our API, making the process more efficient and reducing backend complexity. \*\*\* ## 🚀 \*\*How It Works:\*\* 1. \*\*API User Creation:\*\* \* You create an \*\*API user\*\* linked to the player’s account on your platform. \* This API user acts as the player’s wallet within our system. 2. \*\*Balance Transfer:\*\* \* Before starting a game, the player transfers a portion of their site balance to their \*\*API user account\*\*. \* When a user transfers \*\*X\*\* balance to their API account, the agent supplies \*\*X\*\* from their \*\*remaining API balance\*\* to the player’s API account. \* This means:\\ ➔ \*\*Agent balance\*\* = Agent’s own balance + Total user balances 3. \*\*Game Play:\*\* \* Once the player starts a game, your platform \*\*does not track\*\* the balance changes from the player’s spins — we handle that directly. \* All in-game balance adjustments happen within the API environment. 4. \*\*Settlement:\*\* \* After the game session ends, the updated balance can be retrieved from the API and settled accordingly. \*\*\* ## 🆚 \*\*How is it Different from Seamless Integration?\*\* | \*\*Feature\*\* | \*\*Transfer API\*\* | \*\*Seamless Integration\*\* | | ------------------------------- | ------------------------------------------------------------ | ----------------------------------------------------------------- | | \*\*Funds Management\*\* | Funds are transferred to our API and managed by us. | Funds remain in your system and are managed through your backend. | | \*\*Deposits/Withdrawals\*\* | Funds are stored in our database. | Funds are stored in your database. | | \*\*Balance Changes During Play\*\* | No need to track balance changes during play — we handle it. | Balance changes are reported back to your system for processing. | | \*\*API Complexity\*\* | Direct API call — quick and simple. | API call + backend interaction — more complex. | \*\*\* ## ✅ \*\*Why Use Transfer API?\*\* ✔️ \*\*Simplified Setup:\*\* Just create an API user and transfer funds — no complex backend tracking needed.\\ ✔️ \*\*Fast Transactions:\*\* Direct communication with our system ensures quicker response times.\\ ✔️ \*\*Reduced Backend Load:\*\* Offloads balance management to our system, reducing server stress.\\ ✔️ \*\*Accurate Balancing:\*\* Agent balances are automatically adjusted based on user transfers. \*\*\* \*\*Transfer API\*\* makes managing player funds easier, faster, and more secure — giving you a hassle-free way to handle game balances! --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/getting-started/api-types/transfer.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/getting-started/back-office/control-rtp.md). # Control RTP Available for Slot Games Only Agents can view and update the RTP (Return to Player) for users on the following page: \*\`https://{SERVER}/app/control\_rtp\`\* ## \*\*What is RTP?\*\* RTP is the percentage of the total bet that a player is expected to win back over time. For example, if the RTP is set at 90% and the user bets 100, the user can win a maximum of 90. \* \*\*Note:\*\* RTP is not related to the GGR (Gross Gaming Revenue) share percentage. Even if the RTP is set to 90%, the user's \*\*real RTP\*\* may fluctuate and will attempt to reach the target RTP while the game is played. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/getting-started/back-office/control-rtp.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \# Casino API ## Docs - \[Welcome\](https://ggr.gitbook.io/docs/readme.md) - \[Quickstart\](https://ggr.gitbook.io/docs/getting-started/quickstart.md) - \[Back Office\](https://ggr.gitbook.io/docs/getting-started/back-office.md) - \[Onboarding Sub-Agents\](https://ggr.gitbook.io/docs/getting-started/back-office/onboarding-sub-agents.md) - \[Statistics\](https://ggr.gitbook.io/docs/getting-started/back-office/statistics.md) - \[Call Manage\](https://ggr.gitbook.io/docs/getting-started/back-office/call-manage.md) - \[IP Whitelist\](https://ggr.gitbook.io/docs/getting-started/back-office/ip-whitelist.md) - \[Control RTP\](https://ggr.gitbook.io/docs/getting-started/back-office/control-rtp.md): Available for Slot Games Only - \[Sportsbook\](https://ggr.gitbook.io/docs/getting-started/back-office/sportsbook.md) - \[API Types\](https://ggr.gitbook.io/docs/getting-started/api-types.md) - \[Seamless\](https://ggr.gitbook.io/docs/getting-started/api-types/seamless.md) - \[Transfer\](https://ggr.gitbook.io/docs/getting-started/api-types/transfer.md) - \[Game API\](https://ggr.gitbook.io/docs/integration/game-api.md) - \[Provider List\](https://ggr.gitbook.io/docs/integration/game-api/provider-list.md): This is an API endpoint for retrieving a list of game providers assigned to an agent. - \[Game List\](https://ggr.gitbook.io/docs/integration/game-api/game-list.md): This is an API endpoint for retrieving a list of games associated with a specific provider. - \[Game Launch\](https://ggr.gitbook.io/docs/integration/game-api/game-launch.md): This is an API used to retrieve the launch link for a casino player. - \[Agent & User Info\](https://ggr.gitbook.io/docs/integration/game-api/agent-and-user-info.md): This is an API endpoint used to retrieve the balance information for a specific agent. - \[Game Log\](https://ggr.gitbook.io/docs/integration/game-api/game-log.md): This is an API used to retrieve the game log for a specific user or agent, including transaction details for a specified time range. - \[In-Game History\](https://ggr.gitbook.io/docs/integration/game-api/in-game-history.md): Returns a provider-hosted URL where you can view a player's game history for a specific game. - \[Transfer API\](https://ggr.gitbook.io/docs/integration/transfer-api.md) - \[Deposit / Withdraw User Balance\](https://ggr.gitbook.io/docs/integration/transfer-api/deposit-withdraw-user-balance.md) - \[Reset User Balance\](https://ggr.gitbook.io/docs/integration/transfer-api/reset-user-balance.md): Withdraws the full balance from a user (or all users) and returns it to the agent. Used in Transfer mode. - \[Transfer Status\](https://ggr.gitbook.io/docs/integration/transfer-api/transfer-status.md): Checks the status of a previous deposit or withdraw transaction by \\\`agent\\\_sign\\\`. - \[Seamless API\](https://ggr.gitbook.io/docs/integration/seamless-api.md) - \[User Balance (Site Endpoint)\](https://ggr.gitbook.io/docs/integration/seamless-api/user-balance-site-endpoint.md): Called to retrieve the current balance for a user before or during gameplay. - \[Transaction (Site Endpoint)\](https://ggr.gitbook.io/docs/integration/seamless-api/transaction-site-endpoint.md): Called when a bet or win occurs. Your backend must update the user balance and return the updated value. - \[CALL API\](https://ggr.gitbook.io/docs/integration/call-api.md) - \[Current Playing Users\](https://ggr.gitbook.io/docs/integration/call-api/current-playing-users.md): Returns users currently playing slot games under your agent. - \[Call List\](https://ggr.gitbook.io/docs/integration/call-api/call-list.md): Returns available call (free spin) options for a specific provider and game. - \[Call Apply\](https://ggr.gitbook.io/docs/integration/call-api/call-apply.md): Applies a call (bonus) to a user in a specific game. Use call\\\_rtp from the Get Call List response. - \[Call Cancel\](https://ggr.gitbook.io/docs/integration/call-api/call-cancel.md): Cancels a waiting call. Use call\\\_id from the Get Call History response. - \[Call History\](https://ggr.gitbook.io/docs/integration/call-api/call-history.md): Returns paginated call history for your agent. - \[FreeSpin Tour API\](https://ggr.gitbook.io/docs/integration/freespin-tour-api.md) - \[Create Tour\](https://ggr.gitbook.io/docs/integration/freespin-tour-api/create-tour.md) - \[Cancel Tour\](https://ggr.gitbook.io/docs/integration/freespin-tour-api/cancel-tour.md) - \[RTP API\](https://ggr.gitbook.io/docs/integration/rtp-api.md) - \[Control Users RTP\](https://ggr.gitbook.io/docs/integration/rtp-api/control-users-rtp.md): Sets the target RTP for multiple users in one request. - \[Control User RTP\](https://ggr.gitbook.io/docs/integration/rtp-api/control-user-rtp.md): Sets the target RTP for a specific user on a provider. - \[Rate Limit\](https://ggr.gitbook.io/docs/integration/rate-limit.md) - \[Providers\](https://ggr.gitbook.io/docs/appendix/providers.md) - \[Languages\](https://ggr.gitbook.io/docs/appendix/languages.md) - \[Pragmatic Play\](https://ggr.gitbook.io/docs/appendix/languages/pragmatic-play.md): These language codes are available for both slot and live casino games. - \[Evolution\](https://ggr.gitbook.io/docs/appendix/languages/evolution.md) - \[Sportsbook\](https://ggr.gitbook.io/docs/appendix/languages/sportsbook.md): Additional languages can be added upon request for valuable clients. - \[Spribe\](https://ggr.gitbook.io/docs/appendix/languages/spribe.md) - \[PGSoft\](https://ggr.gitbook.io/docs/appendix/languages/pgsoft.md) - \[Habanero\](https://ggr.gitbook.io/docs/appendix/languages/habanero.md) - \[Booongo\](https://ggr.gitbook.io/docs/appendix/languages/booongo.md) - \[Playson\](https://ggr.gitbook.io/docs/appendix/languages/playson.md) - \[CQ9\](https://ggr.gitbook.io/docs/appendix/languages/cq9.md) - \[Evoplay\](https://ggr.gitbook.io/docs/appendix/languages/evoplay.md) - \[TopTrend\](https://ggr.gitbook.io/docs/appendix/languages/toptrend.md) - \[DreamTech\](https://ggr.gitbook.io/docs/appendix/languages/dreamtech.md) - \[Hacksaw\](https://ggr.gitbook.io/docs/appendix/languages/hacksaw.md) - \[FaChai\](https://ggr.gitbook.io/docs/appendix/languages/fachai.md) - \[Play'n GO\](https://ggr.gitbook.io/docs/appendix/languages/playn-go.md) - \[Amusnet\](https://ggr.gitbook.io/docs/appendix/languages/amusnet.md) - \[EGT\](https://ggr.gitbook.io/docs/appendix/languages/egt.md) - \[Spadegaming\](https://ggr.gitbook.io/docs/appendix/languages/spadegaming.md) - \[FastSpin\](https://ggr.gitbook.io/docs/appendix/languages/fastspin.md) - \[Joker Gaming\](https://ggr.gitbook.io/docs/appendix/languages/joker-gaming.md): Most games are primarily built in English, with some supporting multiple languages. - \[Currencies\](https://ggr.gitbook.io/docs/appendix/currencies.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on a page URL with the \`ask\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/readme.md?ask= \`\`\` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/getting-started/api-types.md). # API Types - \[Seamless\](https://ggr.gitbook.io/docs/getting-started/api-types/seamless.md) - \[Transfer\](https://ggr.gitbook.io/docs/getting-started/api-types/transfer.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/getting-started/api-types.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/integration/game-api.md). # Game API ## API access \*\`https://{SERVER}/app/profile\`\* All agent information can be retrieved from the profile page, including the following details: \* API Endpoint \* Agent Token \* Agent Secret \* Site Endpoint Please refer to the profile page whenever you need to review or verify your integration settings. {% hint style="danger" %} Ensure that these credentials are stored securely and are not shared with unauthorized parties. {% endhint %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/integration/game-api.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/integration/game-api/provider-list.md). # Provider List This is an API endpoint for retrieving a list of game providers assigned to an agent. ## \*\*Endpoint\*\* \`\`\` POST https://{API\_SERVER} \`\`\` ## \*\*Request Body\*\* {% code fullWidth="false" %} \`\`\`json { "method": "provider\_list", "agent\_code": "testAgent", "agent\_token": "41f5cc794aef2b138c715cf25f767cc1" } \`\`\` {% endcode %} | Key | Type | Description | | --- | --- | --- | | method | string | The method type ( `provider_list`) | | agent\_code | string | The agent's code | | agent\_token | string | The agent's authentication token | \## \*\*Success Response Example\*\* \`\`\`json { "status": 1, "msg": "SUCCESS", "providers": \[ { "code": "PRAGMATIC", "name": "Pragmatic Play", "status": 1 } \] } \`\`\` | Key | Type | Description | | --------- | --------------- | ----------------------------- | | status | integer (32bit) | \`1\` – Success, \`0\` – Failure | | msg | string | Response message | | providers | array | List of available providers | | code | string | Provider code | | name | string | Provider name | | status | integer (32bit) | \`1\` – Open, \`0\` – Maintenance | \*\*\* ## \*\*Failure Response Example\*\* \`\`\`json { "status": 0, "msg": "INTERNAL\_ERROR" } \`\`\` | Key | Type | Description | | ------ | --------------- | ------------- | | status | integer (32bit) | \`0\` – Failure | | msg | string | Error message | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/integration/game-api/provider-list.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/getting-started/back-office/sportsbook.md). # Sportsbook This section explains how to configure the sportsbook behavior and integration points from the Backoffice. These settings control the visual appearance, user redirection, and betting logic of the sportsbook. \*\`https://{SERVER}/app/agent\`\* To configure sportsbook, click the "Edit" button. ![](https://1723341361-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGudIGoyLBIBfEiRAAJp7%2Fuploads%2FgMxhcWgSzmP3b7Dl9gkr%2Fimage.png?alt=media&token=caec548d-d405-4cb2-85d2-d0c8a54a1d1b) If the edit modal is opened, you can change sportsbook settings. ![](https://1723341361-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGudIGoyLBIBfEiRAAJp7%2Fuploads%2FcLGVyk3nghSja4uDIwdd%2Fimage.png?alt=media&token=eeef0c4b-ade8-4021-b10a-912ed34076c6) \*\*\* #### \*\*Theme\*\* The \*\*Theme\*\* setting controls the visual appearance of the sportsbook interface. \*\*Purpose\*\* \* Match the sportsbook UI with your brand identity \* Ensure consistent styling when embedded via iframe or opened directly \*\*What it affects\*\* \* Color scheme (primary / secondary colors) \* Buttons, backgrounds, and UI accents \* Overall look & feel of the sportsbook \*\*Usage\*\* \* Select a predefined theme from the dropdown \* Themes are managed by the system and cannot be edited by partners.\\ (Theme editor will be added soon.) \*\*Recommendation\*\* \* Choose the same theme used by your main website for a seamless user experience \*\*\* #### Cashout RTP The \*\*Cashout RTP\*\* defines the return-to-player percentage applied when users request a \*\*cashout before the event is settled\*\*. \*\*Purpose\*\* \* Control cashout profitability \* Manage risk and exposure on early settlements \*\*How it works\*\* \* Higher RTP → better cashout value for players \* Lower RTP → more conservative cashout offers \*\*Example\*\* \* Cashout RTP: \`92%\` \* If the calculated fair value is \`100.00\`, the offered cashout will be \`92.00\` \*\*Notes\*\* \* This setting applies only to \*\*cashout bets\*\* \* It does not affect normal bet settlement RTP \*\*\* #### Login URL The \*\*Login URL\*\* defines where users are redirected when authentication is required. \*\*Purpose\*\* \* Integrate the sportsbook with your existing user system \* Redirect unauthenticated users to your platform login page \*\*Usage\*\* \* Enter the full URL of your login page \* The sportsbook will redirect users automatically if they are not logged in \*\*Example\*\* \`\`\` https://partner-website.com/login || sendPostMessage \`\`\` \*\*Best Practices\*\* \* Ensure the login page supports redirect-back after successful login \* Use HTTPS only \*\*\* #### Deposit URL The \*\*Deposit URL\*\* specifies where users are redirected when they attempt to place a bet without sufficient balance. \*\*Purpose\*\* \* Seamless redirection to your payment or wallet system \* Improve conversion by guiding users directly to deposit \*\*Usage\*\* \* Enter the full URL of your deposit or cashier page \*\*Example\*\* \`\`\` https://partner-website.com/deposit \`\`\` \*\*When it is triggered\*\* \* User clicks “Place Bet” with insufficient balance \* User explicitly selects a deposit action inside the sportsbook \*\*\* #### Integration Sportsbook is available through the "game\\\_launch" API using the provider\\\_code and game\\\_code parameters. "provider\\\_code": "SPORTSBOOK"\\ "game\\\_code": "" --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/getting-started/back-office/sportsbook.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/getting-started/back-office/onboarding-sub-agents.md). # Onboarding Sub-Agents ## Sub-Agent Registration You are allowed to create one sub-agent per site. To initiate the process, click the \+ Create button located in the top-right corner of the page: \*\`https://{SERVER}/app/agent\`\* | Field | Overview | | --- | --- | | Agent Code | A unique identifier used by the agent to log into the API panel. | | Password | The agent’s login credentials. | | Percent | Displays the revenue share for the parent agent’s account. | | Memo | Reserved. | | [Agent Type](https://ggr.gitbook.io/docs/getting-started/back-office/onboarding-sub-agents.md#agent-type) | The dropdown menu provides various options. | | [API Type](https://ggr.gitbook.io/docs/getting-started/back-office/onboarding-sub-agents.md#api-type) | Specifies the method used for handling player funds and game sessions. | | [Site Endpoint](https://ggr.gitbook.io/docs/getting-started/back-office/onboarding-sub-agents.md#site-endpoint) | Defines the agent's backend callback URL used to handle requests from the `/gold_api` endpoint | \### Agent Type \* \*\*Point Manager\*\*:\\ The Point Manager role is responsible for creating sub-agents and allocating API points to their downline. However, this role does not have access to operate or manage the casino site. \* \*\*Both Manager\*\*:\\ The Both Manager role combines the responsibilities of both the Point Manager and Site Manager. This role can create sub-agents, allocate API points to the downline, and manage casino site operations, offering full access to both agent network management and casino operations. \* \*\*Site Manager\*\*:\\ The Site Manager role is focused solely on operating the casino site. While this role can manage site operations, it does not have the ability to create sub-agents or manage the agent network. ### API Type \* \[\*\*Seamless\*\*\](/docs/getting-started/api-types/seamless.md)\\ The player’s balance remains in the casino wallet. The system communicates directly with the game provider during gameplay to update the balance in real-time without requiring manual transfers. \* Example: When a player starts a game, the balance is checked and updated directly from the casino wallet without moving funds. \* \[\*\*Transfer\*\*\](/docs/getting-started/api-types/transfer.md)\\ The player’s balance is transferred from the casino wallet to the game provider's wallet when the game starts, and any winnings or remaining balance are transferred back when the session ends. \* Example: When a player launches a slot game, 100 USDT is deducted from the casino wallet and moved to the game wallet. After the session, the remaining balance and winnings are transferred back to the casino wallet. ### Site Endpoint The Site Endpoint is used exclusively for the Seamless API. \\ This allows the system to communicate with the agent’s platform for tasks such as balance updates, game results, and transaction handling. \* Example: When a player completes a bet, the system sends a \`/gold\_api\` request to the specified Site Endpoint to update the player’s balance and record the game outcome. {% hint style="danger" %} When entering the Site Endpoint in profile page, ensure that it is an \`https\` domain and does not include \`/gold\_api\` at the end, as \`/gold\_api\` will be appended automatically when sending API requests. {% endhint %} Please note that the API panel is limited to creating sub-agents only. To create user accounts in Transfer mode, please utilize the \`user\_create\` API request. ## Deposit & Withdrawal To deposit or withdraw API balance to a sub-agent, click the Exchange button in the Action field. ![](https://1723341361-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGudIGoyLBIBfEiRAAJp7%2Fuploads%2F4sV2qX13ZQDuYhR7Mnm0%2Fimage.png?alt=media&token=c4713ee7-1746-4e47-b14a-5ab18e7197e6) Agent Manage \## \*\*Agent Jackpot Config\*\* To set the Agent Jackpot, click the Config button in the Action field. ![](https://1723341361-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGudIGoyLBIBfEiRAAJp7%2Fuploads%2FwbSD7myWlG32KCG6pLSX%2Fimage.png?alt=media&token=95c8b46c-a001-4a10-b832-eac48b43abf0) Agent Manage \## \*\*Deleting an Agent\*\* To delete an agent, click the last button in the Action field. {% hint style="warning" %} Before deleting a sub-agent, ensure that all their balance is transferred to your main account, \*as any remaining balance will be \*\*lost upon deletion\*\*.\* {% endhint %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/getting-started/back-office/onboarding-sub-agents.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/getting-started/back-office/ip-whitelist.md). # IP Whitelist ## \*\*Overview\*\* The \*\*IP Whitelist\*\* is a security feature that ensures only authorized backend IP addresses are allowed to access the casino API. To ensure secure communication, agents must register their backend IP addresses into the IP Whitelist page. This process allows the \*\*Web Application Firewall (WAF)\*\* rule to validate and approve access to the API server from those specific IP addresses. \*\`https://{SERVER}/app/cloudflare\`\* ## \*\*How it Works:\*\* 1. \*\*Agent IP Registration\*\*:\\ Agents need to register their backend IP (either \*\*IPv4\*\* or \*\*IPv6\*\*) on the IP Whitelist page in the API panel to enable access to the casino API. 2. \*\*WAF Validation\*\*:\\ The \*\*Web Application Firewall (WAF)\*\* will verify the registered IP address. Once validated, the agent's backend can successfully communicate with the API server. 3. \*\*Duplicate IP Handling\*\*:\\ If an agent tries to register an IP address that is already whitelisted, an error message will appear indicating the IP is duplicated. In this case, no further registration is necessary. 4. \*\*IPv4/IPv6 Requirement\*\*:\\ It is mandatory that the agent's backend IP is either \*\*IPv4\*\* or \*\*IPv6\*\*. \\ Agents can obtain their server’s IP by running one the following commands in the CLI of their server system: \`\`\`bash curl ifconfig.me curl ipinfo.io/ip curl api.ipify.org curl icanhazip.com \`\`\` \\ This command will return the server’s \*\*IPv4\*\* or \*\*IPv6\*\* address, which should then be registered on the whitelist. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/getting-started/back-office/ip-whitelist.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/readme.md). # Welcome We're excited to have you here! In this documentation, you'll get a complete overview of all the incredible features that we offer to help you integrate our API into your casino platform effortlessly. Start exploring now and unlock the full potential of your gaming platform with \*\*Casino API\*\*! ### Jump right in | | | | | | | --- | --- | --- | --- | --- | | **Getting Started** | Quickstart | | | [Quickstart](https://ggr.gitbook.io/docs/getting-started/quickstart.md) | | IP **Whitelist** | WAF Restriction | | | [IP Whitelist](https://ggr.gitbook.io/docs/getting-started/back-office/ip-whitelist.md) | | **Languages** | Provider Languages | | | [Languages](https://ggr.gitbook.io/docs/appendix/languages.md) | \--- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/readme.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/getting-started/back-office/call-manage.md). # Call Manage ## \*\*Overview:\*\* Free spins can be awarded to specific users, available only for slot games. Agents can select from the list of current players and grant them bonus spins through the following process. ## \*\*Accessing the List of Users:\*\* Agents can view the list of active players on the following page:\\ \*\`https://{SERVER}/app/call\`\* ## \*\*Important RTP Notes:\*\* \* When playing our games, users will always lose as part of the game’s design. \* If the \*\*target RTP\*\* is set at 95%, the user’s \*\*actual RTP\*\* will attempt to stay below this value, but never exceed it. \* To enhance the player experience, free spins can be provided to users via the API panel by you or site managers. \* The betting amount during a bonus call is factored into the RTP (Return to Player) calculations, ensuring that the overall RTP remains unaffected by the bonus call transactions. ## \*\*Granting Free Spins:\*\* 1. \*\*Via API access\*\*:\\ You can assign free spins directly to users from the site backend through the \*\*\`call\_apply\`\*\* API. 2. On the API Panel: \* Navigate to \*\*"Call & RTP -> Call Manage"\*\* to view the list of users. \* Select a free spin pattern from the available list and assign it to the desired user. \* \*\*Note:\*\* Call spins are only available after the user has made at least one spin. ## \*\*Types of Calls:\*\* \* \*\*Normal Call\*\*: Applies to regular user spins. \* \*\*Buy Call\*\*: Refers to bonus spins that a user purchases as part of a promotional feature (buying free spins). ## \*\*Free Spin Conditions:\*\* \* The \*\*Free Spin\*\* feature is only available after the user has completed at least one spin. \* If the user changes their bet amount after a free spin is granted, the free spin will be invalidated and fail to apply. \* Only the \*\*win amount\*\* can be defined when applying a free spin; the number of spins is fixed. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/getting-started/back-office/call-manage.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Game Launch | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/integration/game-api/game-launch.md) . Launch Game[](https://ggr.gitbook.io/docs/integration/game-api/game-launch#launch-game) ---------------------------------------------------------------------------------------- Launches a slot or live game and returns a URL for the player. ### Endpoint[](https://ggr.gitbook.io/docs/integration/game-api/game-launch#endpoint) Copy POST https://{API_SERVER} **Content-Type:** `application/json` ### Request[](https://ggr.gitbook.io/docs/integration/game-api/game-launch#request) **Method:** `game_launch` #### Slot game[](https://ggr.gitbook.io/docs/integration/game-api/game-launch#slot-game) Copy { "method": "game_launch", "agent_code": "your_agent_code", "agent_token": "your_agent_token", "user_code": "test", "provider_code": "PRAGMATIC", "game_code": "vs20doghouse", "lang": "en", "rtp": 92, "lobby_url": "https://your-site.com/lobby" } #### Live game[](https://ggr.gitbook.io/docs/integration/game-api/game-launch#live-game) > For live games, `game_code` is optional. When empty, a lobby URL is returned. Field Type Required Description `method` string Yes Must be `game_launch` `agent_code` string Yes Your agent code `agent_token` string Yes Your agent API token `user_code` string Yes Player identifier `provider_code` string Yes Provider code `game_code` string Optional Game code (optional for live lobby) `lang` string Yes Language code (e.g. `en`) `rtp` number No Target RTP for this launch. If omitted, the user's configured RTP is used `lobby_url` string No URL to redirect the player when they exit the game. Defaults to empty string ### Response[](https://ggr.gitbook.io/docs/integration/game-api/game-launch#response) #### Success[](https://ggr.gitbook.io/docs/integration/game-api/game-launch#success) #### Failure[](https://ggr.gitbook.io/docs/integration/game-api/game-launch#failure) [PreviousGame List](https://ggr.gitbook.io/docs/integration/game-api/game-list) [NextAgent & User Info](https://ggr.gitbook.io/docs/integration/game-api/agent-and-user-info) Last updated 2 months ago Was this helpful? * [Launch Game](https://ggr.gitbook.io/docs/integration/game-api/game-launch#launch-game) * [Endpoint](https://ggr.gitbook.io/docs/integration/game-api/game-launch#endpoint) * [Request](https://ggr.gitbook.io/docs/integration/game-api/game-launch#request) * [Response](https://ggr.gitbook.io/docs/integration/game-api/game-launch#response) Was this helpful? Copy { "method": "game_launch", "agent_code": "your_agent_code", "agent_token": "your_agent_token", "user_code": "test", "provider_code": "EVOLUTION", "game_code": "nxpkul2hgclallno", "lang": "en", "lobby_url": "https://your-site.com/lobby" } Copy { "status": 1, "msg": "SUCCESS", "launch_url": "http://pragmaticplay.oaxznmnojw.net/..." } Copy { "status": 0, "msg": "INVALID_PROVIDER" } --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/getting-started/back-office/statistics.md). # Statistics ## Agent Statistics On the Agent Statistics page, you can view the API balance consumption of direct sub-agents on an hourly or daily basis within a specified date range in chart format. \*\`https://{SERVER}/app/agent\_statistics\`\* ## User Staticstics On the User Statistics page, you can view the bet summary of users from selected agents within a specified date range. \\ \*\`https://{SERVER}/app/user\_statistics\`\* To export the data in Excel format, click the buttons located at the top left of the table. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/getting-started/back-office/statistics.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Game List | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/integration/game-api/game-list.md) . ### Endpoint[](https://ggr.gitbook.io/docs/integration/game-api/game-list#endpoint) Copy POST https://{API_SERVER} **Content-Type:** `application/json` ### Request[](https://ggr.gitbook.io/docs/integration/game-api/game-list#request) #### game\_list (v1)[](https://ggr.gitbook.io/docs/integration/game-api/game-list#game_list-v1) **Method:** `game_list` Copy { "method": "game_list", "agent_code": "your_agent_code", "agent_token": "your_agent_token", "provider_code": "PRAGMATIC" } **Supported providers for** `**game_list**`**:** Copy All providers #### game\_list\_v2 (v2)[](https://ggr.gitbook.io/docs/integration/game-api/game-list#game_list_v2-v2) **Method:** `game_list_v2` Copy { "method": "game_list_v2", "agent_code": "your_agent_code", "agent_token": "your_agent_token", "provider_code": "PRAGMATIC" } **Supported providers for** `**game_list_v2**`**:** Field Type Required Description `method` string Yes `game_list` or `game_list_v2` `agent_code` string Yes Your agent code `agent_token` string Yes Your agent API token `provider_code` string Yes Provider code ### Response[](https://ggr.gitbook.io/docs/integration/game-api/game-list#response) #### Success — v1[](https://ggr.gitbook.io/docs/integration/game-api/game-list#success-v1) #### Success — v2[](https://ggr.gitbook.io/docs/integration/game-api/game-list#success-v2) #### `bet_levels`[](https://ggr.gitbook.io/docs/integration/game-api/game-list#bet_levels) The bets the game offers, as `level number` → `stake of one spin`. Level `1` is always the smallest bet, and the levels go up from there. Part Meaning Key The bet level, counting from `1` Value What one spin at that level costs, in **your** currency The values are worked out for the agent making the request, from your currency and your bet range, so two agents can get different numbers for the same game. How many levels a game has differs per game as well — read the list, don't assume a fixed length. Use the key as the `bet_level` of **Create Free Tour**. With `"bet_levels": { "3": 0.75 }`, sending `"bet_level": 3` stakes each of that tour's free rounds at 0.75. > `**PRAGMATIC**` **only for now.** `bet_levels` is the one provider that exposes its bet range so far. Every other provider leaves the field out of the game object entirely, so treat it as optional and do not build a UI that expects it everywhere. More providers are planned. #### Failure[](https://ggr.gitbook.io/docs/integration/game-api/game-list#failure) [PreviousProvider List](https://ggr.gitbook.io/docs/integration/game-api/provider-list) [NextGame Launch](https://ggr.gitbook.io/docs/integration/game-api/game-launch) Last updated 16 days ago Was this helpful? * [Endpoint](https://ggr.gitbook.io/docs/integration/game-api/game-list#endpoint) * [Request](https://ggr.gitbook.io/docs/integration/game-api/game-list#request) * [Response](https://ggr.gitbook.io/docs/integration/game-api/game-list#response) Was this helpful? Copy PRAGMATIC, PGSOFT, REELKINGDOM, FATPANDA, HABANERO, CQ9 Copy { "status": 1, "msg": "SUCCESS", "games": [\ {\ "game_code": "vs243mwarrior",\ "game_name": "Monkey Warrior",\ "banner": "https://.../vs243mwarrior.png",\ "status": 1,\ "bet_levels": {\ "1": 0.25,\ "2": 0.5,\ "3": 0.75,\ "4": 1,\ "5": 2.5,\ "6": 5,\ "7": 12.5,\ "8": 25,\ "9": 50,\ "10": 125\ }\ }\ ] } Copy { "status": 1, "msg": "SUCCESS", "games": [\ {\ "id": 1,\ "game_code": "vs243mwarrior",\ "game_name": {\ "hi": "मंकी वारियर™",\ "vi": "Chiến Binh Khỉ",\ "ko": "몽키 워리어",\ "th": "นักรบลิง",\ "zh-hant": "酷猴戰士",\ "zh-hans": "酷猴战士"\ },\ "bet_levels": {\ "1": 0.25,\ "2": 0.5,\ "3": 0.75,\ "4": 1,\ "5": 2.5,\ "6": 5,\ "7": 12.5,\ "8": 25,\ "9": 50,\ "10": 125\ }\ }\ ] } Copy { "status": 0, "msg": "INTERNAL_ERROR" } --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/getting-started/back-office.md). # Back Office - \[Onboarding Sub-Agents\](https://ggr.gitbook.io/docs/getting-started/back-office/onboarding-sub-agents.md) - \[Statistics\](https://ggr.gitbook.io/docs/getting-started/back-office/statistics.md) - \[Call Manage\](https://ggr.gitbook.io/docs/getting-started/back-office/call-manage.md) - \[IP Whitelist\](https://ggr.gitbook.io/docs/getting-started/back-office/ip-whitelist.md) - \[Control RTP\](https://ggr.gitbook.io/docs/getting-started/back-office/control-rtp.md): Available for Slot Games Only - \[Sportsbook\](https://ggr.gitbook.io/docs/getting-started/back-office/sportsbook.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/getting-started/back-office.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/integration/game-api/game-launch.md). # Game Launch This is an API used to retrieve the launch link for a casino player. ## Launch Game Launches a slot or live game and returns a URL for the player. ### Endpoint \`\`\` POST https://{API\_SERVER} \`\`\` \*\*Content-Type:\*\* \`application/json\` ### Request \*\*Method:\*\* \`game\_launch\` #### Slot game \`\`\`json { "method": "game\_launch", "agent\_code": "your\_agent\_code", "agent\_token": "your\_agent\_token", "user\_code": "test", "provider\_code": "PRAGMATIC", "game\_code": "vs20doghouse", "lang": "en", "rtp": 92, "lobby\_url": "https://your-site.com/lobby" } \`\`\` #### Live game \`\`\`json { "method": "game\_launch", "agent\_code": "your\_agent\_code", "agent\_token": "your\_agent\_token", "user\_code": "test", "provider\_code": "EVOLUTION", "game\_code": "nxpkul2hgclallno", "lang": "en", "lobby\_url": "https://your-site.com/lobby" } \`\`\` > For live games, \`game\_code\` is optional. When empty, a lobby URL is returned. | Field | Type | Required | Description | | --- | --- | --- | --- | | `method` | string | Yes | Must be `game_launch` | | `agent_code` | string | Yes | Your agent code | | `agent_token` | string | Yes | Your agent API token | | `user_code` | string | Yes | Player identifier | | `provider_code` | string | Yes | Provider code | | `game_code` | string | Optional | Game code (optional for live lobby) | | `lang` | string | Yes | Language code (e.g. `en`) | | `rtp` | number | No | Target RTP for this launch. If omitted, the user's configured RTP is used | | `lobby_url` | string | No | URL to redirect the player when they exit the game. Defaults to empty string | \### Response #### Success \`\`\`json { "status": 1, "msg": "SUCCESS", "launch\_url": "http://pragmaticplay.oaxznmnojw.net/..." } \`\`\` #### Failure \`\`\`json { "status": 0, "msg": "INVALID\_PROVIDER" } \`\`\` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/integration/game-api/game-launch.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # FreeSpin Tour API | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/integration/freespin-tour-api.md) . [Create Tour](https://ggr.gitbook.io/docs/integration/freespin-tour-api/create-tour) [Cancel Tour](https://ggr.gitbook.io/docs/integration/freespin-tour-api/cancel-tour) [PreviousCall History](https://ggr.gitbook.io/docs/integration/call-api/call-history) [NextCreate Tour](https://ggr.gitbook.io/docs/integration/freespin-tour-api/create-tour) Last updated 27 days ago Was this helpful? Was this helpful? --- # Seamless API | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/integration/seamless-api.md) . Your site must implement this callback APIs. It is **required** for Seamless mode only. The platform sends requests to your configured site endpoint (e.g. `https://your-backend.com/gold_api`). When entering the Site Endpoint in profile page, ensure that it is an `https` domain and does not include `/gold_api` at the end, as `/gold_api` will be appended automatically when sending API requests. [PreviousTransfer Status](https://ggr.gitbook.io/docs/integration/transfer-api/transfer-status) [NextUser Balance (Site Endpoint)](https://ggr.gitbook.io/docs/integration/seamless-api/user-balance-site-endpoint) Last updated 3 months ago Was this helpful? Was this helpful? --- # Transfer API | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/integration/transfer-api.md) . [Deposit / Withdraw User Balance](https://ggr.gitbook.io/docs/integration/transfer-api/deposit-withdraw-user-balance) [Reset User Balance](https://ggr.gitbook.io/docs/integration/transfer-api/reset-user-balance) [Transfer Status](https://ggr.gitbook.io/docs/integration/transfer-api/transfer-status) [PreviousIn-Game History](https://ggr.gitbook.io/docs/integration/game-api/in-game-history) [NextDeposit / Withdraw User Balance](https://ggr.gitbook.io/docs/integration/transfer-api/deposit-withdraw-user-balance) Last updated 3 months ago Was this helpful? Was this helpful? --- # RTP API | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/integration/rtp-api.md) . [Control Users RTP](https://ggr.gitbook.io/docs/integration/rtp-api/control-users-rtp) [Control User RTP](https://ggr.gitbook.io/docs/integration/rtp-api/control-user-rtp) [PreviousCancel Tour](https://ggr.gitbook.io/docs/integration/freespin-tour-api/cancel-tour) [NextControl Users RTP](https://ggr.gitbook.io/docs/integration/rtp-api/control-users-rtp) Last updated 27 days ago Was this helpful? Was this helpful? --- # User Balance (Site Endpoint) | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/integration/seamless-api/user-balance-site-endpoint.md) . ### Endpoint[](https://ggr.gitbook.io/docs/integration/seamless-api/user-balance-site-endpoint#endpoint) Copy POST https://{YOUR_SITE}/gold_api **Content-Type:** `application/json` **Method:** `user_balance` ### Request[](https://ggr.gitbook.io/docs/integration/seamless-api/user-balance-site-endpoint#request) Copy { "method": "user_balance", "agent_code": "your_agent_code", "agent_secret": "your_agent_secret", "user_code": "test", "user_token": "c3041c6d9146a164387fa454eff7b432", "game_code": "vs20olympgate" } Field Type Required Description `method` string Yes Must be `user_balance` `agent_code` string Yes Agent code `agent_secret` string Yes Agent secret key `user_code` string Yes User identifier `user_token` string Yes User session token `game_code` string Yes Game being played ### Response[](https://ggr.gitbook.io/docs/integration/seamless-api/user-balance-site-endpoint#response) #### Success[](https://ggr.gitbook.io/docs/integration/seamless-api/user-balance-site-endpoint#success) Return balance even if it is `0`: #### Failure[](https://ggr.gitbook.io/docs/integration/seamless-api/user-balance-site-endpoint#failure) [PreviousSeamless API](https://ggr.gitbook.io/docs/integration/seamless-api) [NextTransaction (Site Endpoint)](https://ggr.gitbook.io/docs/integration/seamless-api/transaction-site-endpoint) Last updated 2 months ago Was this helpful? * [Endpoint](https://ggr.gitbook.io/docs/integration/seamless-api/user-balance-site-endpoint#endpoint) * [Request](https://ggr.gitbook.io/docs/integration/seamless-api/user-balance-site-endpoint#request) * [Response](https://ggr.gitbook.io/docs/integration/seamless-api/user-balance-site-endpoint#response) Was this helpful? Copy { "status": 1, "user_balance": 0 } Copy { "status": 0, "user_balance": 0, "msg": "INTERNAL_ERROR" } --- # Rate Limit | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/integration/rate-limit.md) . The following APIs are subject to usage limits: * **user\_withdraw\_reset** (when "all\_users" is set to true): Once per minute * **get\_game\_log**: Once per 2 seconds * **game\_list**: Once per second * **provider\_list**: Once per second * **agent\_statistics**: Once every 5 minutes [PreviousControl User RTP](https://ggr.gitbook.io/docs/integration/rtp-api/control-user-rtp) [NextProviders](https://ggr.gitbook.io/docs/appendix/providers) Last updated 8 months ago Was this helpful? Was this helpful? --- # Providers | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/appendix/providers.md) . No Provider Code Provider Name Type Status 1 EVOLUTION Evolution Live live Maintenance 2 **PP\_LIVE\_PRO** Pragmatic Play Live live Online 3 SPORTSBOOK Nexustrike SB Online 4 **PRAGMATIC** Pragmatic Slot slot Online 5 **PGSOFT** PGSoft slot Online 6 **HABANERO** Habanero slot Online 7 **BOOONGO** Booongo slot Online 8 **PLAYSON** Playson slot Online 9 **CQ9** CQ9 slot Online 10 **EVOPLAY** Evoplay slot Online 11 **TOPTREND** TopTrend slot Online 12 **DREAMTECH** DreamTech slot Online 13 **SPRIBE** Spribe MN Online 14 **HACKSAW** Hacksaw slot Online 15 FACHAI FaChai slot Online 16 PLAYNGO Play'n Go slot Online 17 AMUSNET Amusnet slot Online 18 EGT EGT Digital slot Online 19 SPADEGAMING Spadegaming slot Online 20 FASTSPIN FastSpin slot Online 21 JOKERGAMING Joker Gaming slot Online 22 RUBYPLAY RubyPlay slot Online 23 AMATIC Amatic slot Online 24 FISHHUNTER Fish Hunter FH Online 25 NEXTSPIN Next Spin slot Online [PreviousRate Limit](https://ggr.gitbook.io/docs/integration/rate-limit) [NextLanguages](https://ggr.gitbook.io/docs/appendix/languages) Last updated 27 days ago Was this helpful? Was this helpful? --- # Transfer Status | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/integration/transfer-api/transfer-status.md) . ### Endpoint[](https://ggr.gitbook.io/docs/integration/transfer-api/transfer-status#endpoint) Copy POST https://{API_SERVER} **Content-Type:** `application/json` ### Request[](https://ggr.gitbook.io/docs/integration/transfer-api/transfer-status#request) **Method:** `transfer_status` Copy { "method": "transfer_status", "agent_code": "your_agent_code", "agent_token": "your_agent_token", "user_code": "test", "agent_sign": "UNIQUE_ID" } Field Type Required Description `method` string Yes Must be `transfer_status` `agent_code` string Yes Your agent code `agent_token` string Yes Your agent API token `user_code` string Yes Target user `agent_sign` string Yes Unique ID from the original deposit/withdraw request ### Response[](https://ggr.gitbook.io/docs/integration/transfer-api/transfer-status#response) #### Success[](https://ggr.gitbook.io/docs/integration/transfer-api/transfer-status#success) #### Failure[](https://ggr.gitbook.io/docs/integration/transfer-api/transfer-status#failure) [PreviousReset User Balance](https://ggr.gitbook.io/docs/integration/transfer-api/reset-user-balance) [NextSeamless API](https://ggr.gitbook.io/docs/integration/seamless-api) Last updated 2 months ago Was this helpful? * [Endpoint](https://ggr.gitbook.io/docs/integration/transfer-api/transfer-status#endpoint) * [Request](https://ggr.gitbook.io/docs/integration/transfer-api/transfer-status#request) * [Response](https://ggr.gitbook.io/docs/integration/transfer-api/transfer-status#response) Was this helpful? Copy { "status": 1, "msg": "SUCCESS", "amount": 10000, "agent_balance": 990000, "user_balance": 10000, "type": "user_deposit" } Copy { "status": 0, "msg": "NOT FOUND" } --- # Control Users RTP | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/integration/rtp-api/control-users-rtp.md) . ### Endpoint[](https://ggr.gitbook.io/docs/integration/rtp-api/control-users-rtp#endpoint) Copy POST https://{API_SERVER} **Content-Type:** `application/json` ### Request[](https://ggr.gitbook.io/docs/integration/rtp-api/control-users-rtp#request) **Method:** `control_users_rtp` Copy { "method": "control_users_rtp", "agent_code": "your_agent_code", "agent_token": "your_agent_token", "user_codes": "[\"test1\",\"test2\"]", "rtp": 92 } Field Type Required Description `method` string Yes Must be `control_users_rtp` `agent_code` string Yes Your agent code `agent_token` string Yes Your agent API token `user_codes` string Yes Stringified JSON array of user codes `rtp` number Yes Target RTP value (0 ~ 999) > `user_codes` must be a **stringified JSON array**, not a native JSON array. ### Response[](https://ggr.gitbook.io/docs/integration/rtp-api/control-users-rtp#response) #### Success[](https://ggr.gitbook.io/docs/integration/rtp-api/control-users-rtp#success) #### Failure[](https://ggr.gitbook.io/docs/integration/rtp-api/control-users-rtp#failure) [PreviousRTP API](https://ggr.gitbook.io/docs/integration/rtp-api) [NextControl User RTP](https://ggr.gitbook.io/docs/integration/rtp-api/control-user-rtp) Last updated 2 months ago Was this helpful? * [Endpoint](https://ggr.gitbook.io/docs/integration/rtp-api/control-users-rtp#endpoint) * [Request](https://ggr.gitbook.io/docs/integration/rtp-api/control-users-rtp#request) * [Response](https://ggr.gitbook.io/docs/integration/rtp-api/control-users-rtp#response) Was this helpful? Copy { "status": 1, "changed_rtp": 92 } Copy { "status": 0, "msg": "Invalid JSON" } --- # Reset User Balance | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/integration/transfer-api/reset-user-balance.md) . ### Endpoint[](https://ggr.gitbook.io/docs/integration/transfer-api/reset-user-balance#endpoint) Copy POST https://{API_SERVER} **Content-Type:** `application/json` ### Request[](https://ggr.gitbook.io/docs/integration/transfer-api/reset-user-balance#request) **Method:** `user_withdraw_reset` #### Single user[](https://ggr.gitbook.io/docs/integration/transfer-api/reset-user-balance#single-user) Copy { "method": "user_withdraw_reset", "agent_code": "your_agent_code", "agent_token": "your_agent_token", "user_code": "test" } #### All users[](https://ggr.gitbook.io/docs/integration/transfer-api/reset-user-balance#all-users) Copy { "method": "user_withdraw_reset", "agent_code": "your_agent_code", "agent_token": "your_agent_token", "all_users": true } Field Type Required Description `method` string Yes Must be `user_withdraw_reset` `agent_code` string Yes Your agent code `agent_token` string Yes Your agent API token `user_code` string Conditional Required when resetting a single user `all_users` boolean No When `true`, resets all users ### Response[](https://ggr.gitbook.io/docs/integration/transfer-api/reset-user-balance#response) #### Success — single user[](https://ggr.gitbook.io/docs/integration/transfer-api/reset-user-balance#success-single-user) #### Success — all users[](https://ggr.gitbook.io/docs/integration/transfer-api/reset-user-balance#success-all-users) #### Failure[](https://ggr.gitbook.io/docs/integration/transfer-api/reset-user-balance#failure) [PreviousDeposit / Withdraw User Balance](https://ggr.gitbook.io/docs/integration/transfer-api/deposit-withdraw-user-balance) [NextTransfer Status](https://ggr.gitbook.io/docs/integration/transfer-api/transfer-status) Last updated 2 months ago Was this helpful? * [Endpoint](https://ggr.gitbook.io/docs/integration/transfer-api/reset-user-balance#endpoint) * [Request](https://ggr.gitbook.io/docs/integration/transfer-api/reset-user-balance#request) * [Response](https://ggr.gitbook.io/docs/integration/transfer-api/reset-user-balance#response) Was this helpful? Copy { "status": 1, "msg": "SUCCESS", "agent": { "agent_code": "your_agent_code", "balance": 1000000 }, "user": { "user_code": "test", "withdraw_amount": 5600, "balance": 0 } } Copy { "status": 1, "msg": "SUCCESS", "agent": { "agent_code": "your_agent_code", "balance": 1076850 }, "user_list": [\ {\ "user_code": "test",\ "withdraw_amount": 20000,\ "balance": 0\ },\ {\ "user_code": "test2",\ "withdraw_amount": 56850,\ "balance": 0\ }\ ] } Copy { "status": 0, "msg": "INVALID_PARAMETER" } --- # Cancel Tour | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/integration/freespin-tour-api/cancel-tour.md) . Ends a running free tour early. Use the `tour_id` you sent to **Create Free Tour**. > `**PRAGMATIC**` **only for now**, like **Create Free Tour** — there are no tours on other providers to cancel. ### Endpoint[](https://ggr.gitbook.io/docs/integration/freespin-tour-api/cancel-tour#endpoint) Copy POST https://{API_SERVER} **Content-Type:** `application/json` ### Request[](https://ggr.gitbook.io/docs/integration/freespin-tour-api/cancel-tour#request) **Method:** `tour_cancel` Copy { "method": "tour_cancel", "agent_code": "your_agent_code", "agent_token": "your_agent_token", "tour_id": "free_tour_777" } Field Type Required Description `method` string Yes Must be `tour_cancel` `agent_code` string Yes Your agent code `agent_token` string Yes Your agent API token `tour_id` string Yes The `tour_id` of the tour to cancel ### Response[](https://ggr.gitbook.io/docs/integration/freespin-tour-api/cancel-tour#response) #### Success[](https://ggr.gitbook.io/docs/integration/freespin-tour-api/cancel-tour#success) Field Type Description `rest_count` integer Free rounds the user never got to play `total_win` number What the tour had already paid the user `canceled_money` number Returned to your agent balance: `real_win` − `total_win` The user keeps what the tour already paid. Only the part that was never played is given back. #### Failure[](https://ggr.gitbook.io/docs/integration/freespin-tour-api/cancel-tour#failure) `detail` Description `TOUR_NOT_FOUND` The game server has no such tour, or it already ended `TOUR_IN_PROGRESS` A free round is being played right now. Cancelling mid-round would turn it into a paid one — retry once the round is over A tour can only be canceled once. `There is no running tour.` also comes back for a tour that was already canceled. [PreviousCreate Tour](https://ggr.gitbook.io/docs/integration/freespin-tour-api/create-tour) [NextRTP API](https://ggr.gitbook.io/docs/integration/rtp-api) Last updated 16 days ago Was this helpful? * [Endpoint](https://ggr.gitbook.io/docs/integration/freespin-tour-api/cancel-tour#endpoint) * [Request](https://ggr.gitbook.io/docs/integration/freespin-tour-api/cancel-tour#request) * [Response](https://ggr.gitbook.io/docs/integration/freespin-tour-api/cancel-tour#response) Was this helpful? Copy { "status": 1, "tour_id": "free_tour_777", "user_code": "test", "provider_code": "PRAGMATIC", "game_code": "vs20doghouse", "rest_count": 6, "total_win": 21400, "canceled_money": 42950, "msg": "SUCCESS" } Copy { "status": 0, "msg": "There is no running tour." } Copy { "status": 0, "msg": "External Error", "detail": "TOUR_IN_PROGRESS" } --- # Agent & User Info | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/integration/game-api/agent-and-user-info.md) . **Endpoint**[](https://ggr.gitbook.io/docs/integration/game-api/agent-and-user-info#endpoint) ---------------------------------------------------------------------------------------------- Copy POST https://{API_SERVER} **Agent Info**[](https://ggr.gitbook.io/docs/integration/game-api/agent-and-user-info#agent-info) -------------------------------------------------------------------------------------------------- ### **Request Body**[](https://ggr.gitbook.io/docs/integration/game-api/agent-and-user-info#request-body) Copy { "method": "money_info", "agent_code": "testAgent", "agent_token": "41f5cc794aef2b138c715cf25f767cc1" } Key Type Description method string The method type (`money_info`) agent\_code string The agent's code agent\_token string The agent's authentication token ### **Success Response Example**[](https://ggr.gitbook.io/docs/integration/game-api/agent-and-user-info#success-response-example) Copy { "status": 1, "msg": "SUCCESS", "agent": { "agent_code": "testAgent", "balance": 1000000 } } ### **Failure Response Example**[](https://ggr.gitbook.io/docs/integration/game-api/agent-and-user-info#failure-response-example) * * * **User Info**[](https://ggr.gitbook.io/docs/integration/game-api/agent-and-user-info#user-info) ------------------------------------------------------------------------------------------------ ### **Request Body**[](https://ggr.gitbook.io/docs/integration/game-api/agent-and-user-info#request-body-1) Key Type Description method string The method type (`money_info`) agent\_code string The agent's code agent\_token string The agent's authentication token user\_code string The user's code ### **Success Response Example**[](https://ggr.gitbook.io/docs/integration/game-api/agent-and-user-info#success-response-example-1) ### **Failure Response Example**[](https://ggr.gitbook.io/docs/integration/game-api/agent-and-user-info#failure-response-example-1) * * * **All Users Info**[](https://ggr.gitbook.io/docs/integration/game-api/agent-and-user-info#all-users-info) ---------------------------------------------------------------------------------------------------------- ### **Request Body**[](https://ggr.gitbook.io/docs/integration/game-api/agent-and-user-info#request-body-2) Key Type Description method string The method type (`game_list`) agent\_code string The agent's code agent\_token string The agent's authentication token all\_users boolean `true` ### **Success Response Example**[](https://ggr.gitbook.io/docs/integration/game-api/agent-and-user-info#success-response-example-2) ### **Failure Response Example**[](https://ggr.gitbook.io/docs/integration/game-api/agent-and-user-info#failure-response-example-2) [PreviousGame Launch](https://ggr.gitbook.io/docs/integration/game-api/game-launch) [NextGame Log](https://ggr.gitbook.io/docs/integration/game-api/game-log) Last updated 2 months ago Was this helpful? * [Endpoint](https://ggr.gitbook.io/docs/integration/game-api/agent-and-user-info#endpoint) * [Agent Info](https://ggr.gitbook.io/docs/integration/game-api/agent-and-user-info#agent-info) * [Request Body](https://ggr.gitbook.io/docs/integration/game-api/agent-and-user-info#request-body) * [Success Response Example](https://ggr.gitbook.io/docs/integration/game-api/agent-and-user-info#success-response-example) * [Failure Response Example](https://ggr.gitbook.io/docs/integration/game-api/agent-and-user-info#failure-response-example) * [User Info](https://ggr.gitbook.io/docs/integration/game-api/agent-and-user-info#user-info) * [Request Body](https://ggr.gitbook.io/docs/integration/game-api/agent-and-user-info#request-body-1) * [Success Response Example](https://ggr.gitbook.io/docs/integration/game-api/agent-and-user-info#success-response-example-1) * [Failure Response Example](https://ggr.gitbook.io/docs/integration/game-api/agent-and-user-info#failure-response-example-1) * [All Users Info](https://ggr.gitbook.io/docs/integration/game-api/agent-and-user-info#all-users-info) * [Request Body](https://ggr.gitbook.io/docs/integration/game-api/agent-and-user-info#request-body-2) * [Success Response Example](https://ggr.gitbook.io/docs/integration/game-api/agent-and-user-info#success-response-example-2) * [Failure Response Example](https://ggr.gitbook.io/docs/integration/game-api/agent-and-user-info#failure-response-example-2) Was this helpful? Copy { "status": 0, "msg": "INVALID_PARAMETER" } Copy { "method": "money_info", "agent_code": "testAgent", "agent_token": "41f5cc794aef2b138c715cf25f767cc1", "user_code": "testUser" } Copy { "status": 1, "msg": "SUCCESS", "agent": { "agent_code": "testAgent", "balance": 1000000, }, "user": { "user_code": "testUser", "balance": 100000, } } Copy { "status": 0, "msg": "INVALID_PARAMETER" } Copy { "method": "money_info", "agent_code": "testAgent", "agent_token": "41f5cc794aef2b138c715cf25f767cc1", "all_users": true } Copy { "status": 1, "msg": "SUCCESS", "agent": { "agent_code": "testAgent", "balance": 99550000 }, "user_list": [\ {\ "user_code": "testUser1",\ "balance": 450000\ },\ {\ "user_code": "testUser2",\ "balance": 20000\ }\ ] } Copy { "status": 0, "msg": "INVALID_PARAMETER" } --- # Control User RTP | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/integration/rtp-api/control-user-rtp.md) . ### Endpoint[](https://ggr.gitbook.io/docs/integration/rtp-api/control-user-rtp#endpoint) Copy POST https://{API_SERVER} **Content-Type:** `application/json` ### Request[](https://ggr.gitbook.io/docs/integration/rtp-api/control-user-rtp#request) **Method:** `control_rtp` Copy { "method": "control_rtp", "agent_code": "your_agent_code", "agent_token": "your_agent_token", "provider_code": "PRAGMATIC", "user_code": "test", "rtp": 92 } Field Type Required Description `method` string Yes Must be `control_rtp` `agent_code` string Yes Your agent code `agent_token` string Yes Your agent API token `provider_code` string Yes Game provider code `user_code` string Yes Target user `rtp` number Yes Target RTP value (0 ~ 999) ### Response[](https://ggr.gitbook.io/docs/integration/rtp-api/control-user-rtp#response) #### Success[](https://ggr.gitbook.io/docs/integration/rtp-api/control-user-rtp#success) #### Failure[](https://ggr.gitbook.io/docs/integration/rtp-api/control-user-rtp#failure) [PreviousControl Users RTP](https://ggr.gitbook.io/docs/integration/rtp-api/control-users-rtp) [NextRate Limit](https://ggr.gitbook.io/docs/integration/rate-limit) Last updated 2 months ago Was this helpful? * [Endpoint](https://ggr.gitbook.io/docs/integration/rtp-api/control-user-rtp#endpoint) * [Request](https://ggr.gitbook.io/docs/integration/rtp-api/control-user-rtp#request) * [Response](https://ggr.gitbook.io/docs/integration/rtp-api/control-user-rtp#response) Was this helpful? Copy { "status": 1, "changed_rtp": 92 } Copy { "status": 0, "msg": "Invalid Parameter.", "detail": "rtp must be less than or equal to 999" } --- # CALL API | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/integration/call-api.md) . [Current Playing Users](https://ggr.gitbook.io/docs/integration/call-api/current-playing-users) [Call List](https://ggr.gitbook.io/docs/integration/call-api/call-list) [Call Apply](https://ggr.gitbook.io/docs/integration/call-api/call-apply) [Call Cancel](https://ggr.gitbook.io/docs/integration/call-api/call-cancel) [Call History](https://ggr.gitbook.io/docs/integration/call-api/call-history) [PreviousTransaction (Site Endpoint)](https://ggr.gitbook.io/docs/integration/seamless-api/transaction-site-endpoint) [NextCurrent Playing Users](https://ggr.gitbook.io/docs/integration/call-api/current-playing-users) Last updated 3 months ago Was this helpful? Was this helpful? --- # Call Cancel | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/integration/call-api/call-cancel.md) . ### Endpoint[](https://ggr.gitbook.io/docs/integration/call-api/call-cancel#endpoint) Copy POST https://{API_SERVER} **Content-Type:** `application/json` ### Request[](https://ggr.gitbook.io/docs/integration/call-api/call-cancel#request) **Method:** `call_cancel` Copy { "method": "call_cancel", "agent_code": "your_agent_code", "agent_token": "your_agent_token", "call_id": 109 } Field Type Required Description `method` string Yes Must be `call_cancel` `agent_code` string Yes Your agent code `agent_token` string Yes Your agent API token `call_id` number Yes Call ID from **Get Call History** ### Response[](https://ggr.gitbook.io/docs/integration/call-api/call-cancel#response) #### Success[](https://ggr.gitbook.io/docs/integration/call-api/call-cancel#success) #### Failure[](https://ggr.gitbook.io/docs/integration/call-api/call-cancel#failure) [PreviousCall Apply](https://ggr.gitbook.io/docs/integration/call-api/call-apply) [NextCall History](https://ggr.gitbook.io/docs/integration/call-api/call-history) Last updated 2 months ago Was this helpful? * [Endpoint](https://ggr.gitbook.io/docs/integration/call-api/call-cancel#endpoint) * [Request](https://ggr.gitbook.io/docs/integration/call-api/call-cancel#request) * [Response](https://ggr.gitbook.io/docs/integration/call-api/call-cancel#response) Was this helpful? Copy { "status": 1, "canceled_money": 720160, "msg": "SUCCESS" } Copy { "status": 0, "msg": "There is no waiting call." } --- # Call List | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/integration/call-api/call-list.md) . ### Endpoint[](https://ggr.gitbook.io/docs/integration/call-api/call-list#endpoint) Copy POST https://{API_SERVER} **Content-Type:** `application/json` ### Request[](https://ggr.gitbook.io/docs/integration/call-api/call-list#request) **Method:** `call_list` Copy { "method": "call_list", "agent_code": "your_agent_code", "agent_token": "your_agent_token", "provider_code": "PRAGMATIC", "game_code": "vs20doghouse" } Field Type Required Description `method` string Yes Must be `call_list` `agent_code` string Yes Your agent code `agent_token` string Yes Your agent API token `provider_code` string Yes Game provider code `game_code` string Yes Game identifier ### Response[](https://ggr.gitbook.io/docs/integration/call-api/call-list#response) #### Success[](https://ggr.gitbook.io/docs/integration/call-api/call-list#success) Field Description `rtp` RTP value — use this in **Call Apply** as `call_rtp` `call_type` Call type label #### Failure[](https://ggr.gitbook.io/docs/integration/call-api/call-list#failure) [PreviousCurrent Playing Users](https://ggr.gitbook.io/docs/integration/call-api/current-playing-users) [NextCall Apply](https://ggr.gitbook.io/docs/integration/call-api/call-apply) Last updated 2 months ago Was this helpful? * [Endpoint](https://ggr.gitbook.io/docs/integration/call-api/call-list#endpoint) * [Request](https://ggr.gitbook.io/docs/integration/call-api/call-list#request) * [Response](https://ggr.gitbook.io/docs/integration/call-api/call-list#response) Was this helpful? Copy { "status": 1, "calls": [\ {\ "rtp": 75615,\ "call_type": "Free"\ },\ {\ "rtp": 62185,\ "call_type": "Free"\ },\ {\ "rtp": 45010,\ "call_type": "Free"\ }\ ] } Copy { "status": 0, "msg": "External Error" } --- # Currencies | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/appendix/currencies.md) . * We support all types of fiat currencies and special currencies tailored to the agent's requirements. * Currency symbols may be hidden according to the request. * The bet range can be adjusted as needed. [PreviousJoker Gaming](https://ggr.gitbook.io/docs/appendix/languages/joker-gaming) Last updated 7 months ago Was this helpful? Was this helpful? --- # In-Game History | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/integration/game-api/in-game-history.md) . Unlike `get_game_log`, this does not return transaction records directly — it returns a link to the provider's history page. > **Availability:** Currently supported for **Pragmatic Play Slot** only (`provider_code`: `PRAGMATIC`). Other providers will return `INVALID_PROVIDER`. ### Endpoint[](https://ggr.gitbook.io/docs/integration/game-api/in-game-history#endpoint) Copy POST https://{API_SERVER} **Content-Type:** `application/json` ### Request[](https://ggr.gitbook.io/docs/integration/game-api/in-game-history#request) **Method:** `get_game_history` Copy { "method": "get_game_history", "agent_code": "your_agent_code", "agent_token": "your_agent_token", "user_code": "test", "provider_code": "PRAGMATIC", "game_code": "vs20doghouse" } Field Type Required Description `method` string Yes Must be `get_game_history` `agent_code` string Yes Your agent code `agent_token` string Yes Your agent API token `user_code` string Yes Player identifier `provider_code` string Yes Must be `PRAGMATIC` (Pragmatic Play Slot only) `game_code` string Yes Pragmatic Play slot game code (e.g. `vs20doghouse`) ### Response[](https://ggr.gitbook.io/docs/integration/game-api/in-game-history#response) #### Success[](https://ggr.gitbook.io/docs/integration/game-api/in-game-history#success) Field Description `history_url` URL to open the provider's game history page for the player #### Failure[](https://ggr.gitbook.io/docs/integration/game-api/in-game-history#failure) **Invalid provider (not Pragmatic Play Slot):** **External provider error:** **Internal error:** [PreviousGame Log](https://ggr.gitbook.io/docs/integration/game-api/game-log) [NextTransfer API](https://ggr.gitbook.io/docs/integration/transfer-api) Last updated 2 months ago Was this helpful? * [Endpoint](https://ggr.gitbook.io/docs/integration/game-api/in-game-history#endpoint) * [Request](https://ggr.gitbook.io/docs/integration/game-api/in-game-history#request) * [Response](https://ggr.gitbook.io/docs/integration/game-api/in-game-history#response) Was this helpful? Copy { "status": 1, "msg": "SUCCESS", "history_url": "https://game-server.example.com/gs2c/lastGameHistory.do?symbol=vs20doghouse&mgckey=..." } Copy { "status": 0, "msg": "INVALID_PROVIDER" } Copy { "status": 0, "msg": "EXTERNAL_ERROR : INVALID_GAME" } Copy { "status": 0, "msg": "INTERNAL_ERROR" } --- # Create Tour | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/integration/freespin-tour-api/create-tour.md) . Grants a user a bundle of free rounds (a "free tour") on one slot game. The whole tour is laid out in advance when it is created, so the response already tells you what it will pay. Only one tour can run per user and game at a time — the previous one has to finish, expire or be canceled first. > `**PRAGMATIC**` **only for now.** Free tours are supported on Pragmatic games and nowhere else yet. Sending `tour_create` for any other `provider_code` fails, since that provider's game server has no tour to create. More providers are planned. ### Endpoint[](https://ggr.gitbook.io/docs/integration/freespin-tour-api/create-tour#endpoint) Copy POST https://{API_SERVER} **Content-Type:** `application/json` ### Request[](https://ggr.gitbook.io/docs/integration/freespin-tour-api/create-tour#request) **Method:** `tour_create` Copy { "method": "tour_create", "agent_code": "your_agent_code", "agent_token": "your_agent_token", "user_code": "test", "provider_code": "PRAGMATIC", "game_code": "vs20doghouse", "bet_level": 1, "spin_count": 10, "amount": 70000, "expiration_time": "2026-02-26T06:46:04.000Z", "tour_id": "free_tour_777" } Field Type Required Description `method` string Yes Must be `tour_create` `agent_code` string Yes Your agent code `agent_token` string Yes Your agent API token `user_code` string Yes Target user `provider_code` string Yes Game provider code `game_code` string Yes Game identifier `bet_level` integer Yes Index into the game's bet range: `1` = minimum bet, `2` = the next one, and so on `spin_count` integer Yes Number of free rounds. `1` – `1000` `amount` number Yes Max win of the whole tour, in your currency. At least the equivalent of 7 USD at your currency rate `expiration_time` datetime Yes When the tour stops being playable. Must be in the future `tour_id` string Yes Your own identifier for the tour, 1 – 36 characters. It comes back in the later callbacks > `**amount**` **is a ceiling, not a target.** The tour is shaped like an ordinary session — only a few of its rounds pay — so what it really pays out is usually below `amount`. That figure comes back as `real_win`. ### Response[](https://ggr.gitbook.io/docs/integration/freespin-tour-api/create-tour#response) #### Success[](https://ggr.gitbook.io/docs/integration/freespin-tour-api/create-tour#success) Field Type Description `bet` number Coin bet of one line at `bet_level` `total_bet` number Bet of one free round (`bet` × the game's pay lines) `real_win` number What the prepared rounds actually pay, up to `amount` **Balance:** `real_win` is deducted from your agent balance the moment the tour is created, and the unplayed part comes back if you cancel it. Your balance still has to cover the full `amount` at creation time, before `real_win` is known. #### Failure[](https://ggr.gitbook.io/docs/integration/freespin-tour-api/create-tour#failure) `External Error` means the game server refused the tour. `detail` says why: `detail` Description `INVALID_GAME` The game does not exist or has no pay lines `PO_GAME` The game is switched off `INVALID_BET_LEVEL` `bet_level` is above the game's highest bet `INVALID_SPIN_COUNT` `spin_count` is outside `1` – `1000` `INVALID_AMOUNT` `amount` is below the 7 USD equivalent for your currency `INVALID_EXPIRATION_TIME` `expiration_time` is missing or already past `INVALID_TOUR_ID` `tour_id` is longer than 36 characters `DUPLICATED_TOUR_ID` The game server already knows this `tour_id` `TOUR_IN_PROGRESS` This user still has a playable tour on this game `NO_PATTERN_DATA` The game has no round data to build a tour from A refused tour is not recorded, so the same `tour_id` can be used again once the cause is fixed. [PreviousFreeSpin Tour API](https://ggr.gitbook.io/docs/integration/freespin-tour-api) [NextCancel Tour](https://ggr.gitbook.io/docs/integration/freespin-tour-api/cancel-tour) Last updated 16 days ago Was this helpful? * [Endpoint](https://ggr.gitbook.io/docs/integration/freespin-tour-api/create-tour#endpoint) * [Request](https://ggr.gitbook.io/docs/integration/freespin-tour-api/create-tour#request) * [Response](https://ggr.gitbook.io/docs/integration/freespin-tour-api/create-tour#response) Was this helpful? Copy { "status": 1, "tour_id": "free_tour_777", "user_code": "test", "provider_code": "PRAGMATIC", "game_code": "vs20doghouse", "bet_level": 1, "bet": 100, "total_bet": 2000, "spin_count": 10, "amount": 70000, "real_win": 64350, "expiration_time": "2026-02-26T06:46:04.000Z", "msg": "SUCCESS" } Copy { "status": 0, "msg": "Duplicated Tour Id." } Copy { "status": 0, "msg": "External Error", "detail": "INVALID_BET_LEVEL" } --- # Deposit / Withdraw User Balance | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/integration/transfer-api/deposit-withdraw-user-balance.md) . End**point**[](https://ggr.gitbook.io/docs/integration/transfer-api/deposit-withdraw-user-balance#endpoint) ------------------------------------------------------------------------------------------------------------ Copy POST https://{API_SERVER} **Request Body**[](https://ggr.gitbook.io/docs/integration/transfer-api/deposit-withdraw-user-balance#request-body) -------------------------------------------------------------------------------------------------------------------- Copy { "method": "user_deposit", "agent_code": "testAgent", "agent_token": "c3041c6d9146a164387fa454eff7b432", "user_code": "test", "amount": 10000.00, "agent_sign"："UNIQUE_ID" // Optional to prevent duplicated } Copy { "method": "user_withdraw", "agent_code": "testAgent", "agent_token": "c3041c6d9146a164387fa454eff7b432", "user_code": "test", "amount": 10000.00, "agent_sign"："UNIQUE_ID" // Optional to prevent duplicated } Key Type Description `method` string API method name. For balance transfer to a user game wallet, the value must be `user_deposit` or `user_withdraw`. `agent_code` string Unique agent identifier provided by NEXUS. Used to identify which agent is sending the request. `agent_token` string Secret authentication token assigned to the agent. Used for API authentication and request validation. `user_code` string Unique user identifier within the agent’s platform. This user will receive the transferred balance. `amount` double Amount to transfer from the agent balance to the user API balance. Supports up to 2 digits after the decimal point. Example: `10000.00` `agent_sign` string Optional unique request identifier used to prevent duplicated requests. Recommended for transaction safety and idempotency handling. Example: UUID, hash string, timestamp-based unique value. **Response Example**[](https://ggr.gitbook.io/docs/integration/transfer-api/deposit-withdraw-user-balance#response-example) ---------------------------------------------------------------------------------------------------------------------------- Field Type Description `status` int Request processing status. `1` indicates success, while `0` indicates failure. `msg` string Response message describing the result of the request. Example: `SUCCESS: "INSUFFICIENT_AGENT_FUNDS"`. `agent_balance` double Remaining balance of the agent after the transaction has been processed successfully. Supports up to 2 digits after the decimal point. `user_balance` double Updated API balance of the user after the transaction has been completed successfully. Supports up to 2 digits after the decimal point. [PreviousTransfer API](https://ggr.gitbook.io/docs/integration/transfer-api) [NextReset User Balance](https://ggr.gitbook.io/docs/integration/transfer-api/reset-user-balance) Last updated 2 months ago Was this helpful? * [Endpoint](https://ggr.gitbook.io/docs/integration/transfer-api/deposit-withdraw-user-balance#endpoint) * [Request Body](https://ggr.gitbook.io/docs/integration/transfer-api/deposit-withdraw-user-balance#request-body) * [Response Example](https://ggr.gitbook.io/docs/integration/transfer-api/deposit-withdraw-user-balance#response-example) Was this helpful? Copy { "status": 1, "msg": "SUCCESS", "agent_balance": 990000, "user_balance": 10000 } Copy { "status": 0, "msg": "INSUFFICIENT_AGENT_FUNDS" / "INSUFFICIENT_USER_FUNDS" } --- # Transaction (Site Endpoint) | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/integration/seamless-api/transaction-site-endpoint.md) . Endpoint[](https://ggr.gitbook.io/docs/integration/seamless-api/transaction-site-endpoint#endpoint) ---------------------------------------------------------------------------------------------------- Copy POST https://{YOUR_SITE}/gold_api **Content-Type:** `application/json` **Method:** `transaction` Request[](https://ggr.gitbook.io/docs/integration/seamless-api/transaction-site-endpoint#request) -------------------------------------------------------------------------------------------------- ### Slot transaction[](https://ggr.gitbook.io/docs/integration/seamless-api/transaction-site-endpoint#slot-transaction) Copy { "method": "transaction", "agent_code": "your_agent_code", "agent_secret": "your_agent_secret", "agent_balance": 10000000, "user_code": "test", "user_token": "c3041c6d9146a164387fa454eff7b432", "user_balance": 99200, "game_type": "slot", "slot": { "provider_code": "PRAGMATIC", "game_code": "vs20midas", "type": "BASE", "bet_money": 1000, "win_money": 200, "round_id": 63792613432127, "txn_id": "63792613432127", "txn_id_v2": "64a83f2fc597acc9004eec52c3f84c30", "txn_type": "debit_credit" } } ### Live transaction[](https://ggr.gitbook.io/docs/integration/seamless-api/transaction-site-endpoint#live-transaction) ### Sportsbook transaction[](https://ggr.gitbook.io/docs/integration/seamless-api/transaction-site-endpoint#sportsbook-transaction) ### Mini game (MN) transaction[](https://ggr.gitbook.io/docs/integration/seamless-api/transaction-site-endpoint#mini-game-mn-transaction) ### Game object fields[](https://ggr.gitbook.io/docs/integration/seamless-api/transaction-site-endpoint#game-object-fields) **Important:** The game detail object key **must match** the `game_type` value. > Example: if `"game_type": "slot"`, the payload must include a `"slot": { ... }` object. If `"game_type": "SB"`, use `"SB": { ... }`. game\_type Provider Type `slot` Slot `live` Live Casino `SB` Sportsbook `MN` Mini Game `FT` Fish Fields inside the game object (`slot` / `live` / `SB` / `MN`): Field Type Required Description `provider_code` string Yes Game provider code `game_code` string Yes Game identifier `type` string Yes Bet/round type (e.g. `BASE`, `baccarat`) `bet_money` number Yes Bet amount `win_money` number Yes Win amount `round_id` integer Yes Unique ID for one bet. Every transaction the bet produces shares it `txn_id` string Yes The `round_id` as a string. Starting October 15, 2026 (UTC): `txn_id` will use the same value as `txn_id_v2`. `txn_id_v2` string Yes Unique per inner spin of one bet. Deduplicate on this field. `txn_id_v2` will be deprecated on October 31, 2026 (UTC). `txn_type` string Yes `debit`, `credit`, or `debit_credit` > `**round_id**` **and** `**txn_id_v2**` > > One bet is not always one payout. A bet can play out over several **inner spins** — tumbling wins, free game rounds, the closing collect — and every one of them is sent as its own transaction. > > * `round_id` — one bet (integer). Every transaction that bet produces carries the same value. > > * `txn_id_v2` — unique per inner spin (string). No two transactions ever share it. > > > **Deduplicate on** `**txn_id_v2**`**.** `round_id` is unique per _bet_, not per transaction, so treating it as an idempotency key makes your site drop the win of a round it already booked the bet for. ### Live / Sportsbook `info` field[](https://ggr.gitbook.io/docs/integration/seamless-api/transaction-site-endpoint#live-sportsbook-info-field) The `info` field (top-level, for live and sportsbook) is a **stringified JSON** object with bet/result details. **Sportsbook** `**info**` **fields:** Field Description `couponCode` Bet coupon code `status` `pending`, `won`, `lost`, `cashedout`, or `canceled` `totalOdds` Combined odds `potentialWin` Potential payout `stake` Bet stake `payout` Actual payout `betslips` Array of `{ id, sportName, countryName, leagueName, matchName, homeTeam, awayTeam, marketName, oddName, oddRate, oddPoint }` `settlementData` Settlement details object Transaction Type Reference[](https://ggr.gitbook.io/docs/integration/seamless-api/transaction-site-endpoint#transaction-type-reference) ---------------------------------------------------------------------------------------------------------------------------------------- `txn_type` values: `debit`, `credit`, `debit_credit` Type Description `bet_money` `win_money` `debit` Only send bet amount Valid Invalid (don't use) `credit` Only send win amount Invalid (don't use) Valid `debit_credit` Send bet and win amount Valid Valid ### Txn examples[](https://ggr.gitbook.io/docs/integration/seamless-api/transaction-site-endpoint#txn-examples) One bet (`round_id`, and the `txn_id` mirroring it) can produce several transactions, each with its own `txn_id_v2`. Response[](https://ggr.gitbook.io/docs/integration/seamless-api/transaction-site-endpoint#response) ---------------------------------------------------------------------------------------------------- ### Success[](https://ggr.gitbook.io/docs/integration/seamless-api/transaction-site-endpoint#success) Must return the updated user balance: ### Failure[](https://ggr.gitbook.io/docs/integration/seamless-api/transaction-site-endpoint#failure) [PreviousUser Balance (Site Endpoint)](https://ggr.gitbook.io/docs/integration/seamless-api/user-balance-site-endpoint) [NextCALL API](https://ggr.gitbook.io/docs/integration/call-api) Last updated 2 days ago Was this helpful? * [Endpoint](https://ggr.gitbook.io/docs/integration/seamless-api/transaction-site-endpoint#endpoint) * [Request](https://ggr.gitbook.io/docs/integration/seamless-api/transaction-site-endpoint#request) * [Slot transaction](https://ggr.gitbook.io/docs/integration/seamless-api/transaction-site-endpoint#slot-transaction) * [Live transaction](https://ggr.gitbook.io/docs/integration/seamless-api/transaction-site-endpoint#live-transaction) * [Sportsbook transaction](https://ggr.gitbook.io/docs/integration/seamless-api/transaction-site-endpoint#sportsbook-transaction) * [Mini game (MN) transaction](https://ggr.gitbook.io/docs/integration/seamless-api/transaction-site-endpoint#mini-game-mn-transaction) * [Game object fields](https://ggr.gitbook.io/docs/integration/seamless-api/transaction-site-endpoint#game-object-fields) * [Live / Sportsbook info field](https://ggr.gitbook.io/docs/integration/seamless-api/transaction-site-endpoint#live-sportsbook-info-field) * [Transaction Type Reference](https://ggr.gitbook.io/docs/integration/seamless-api/transaction-site-endpoint#transaction-type-reference) * [Txn examples](https://ggr.gitbook.io/docs/integration/seamless-api/transaction-site-endpoint#txn-examples) * [Response](https://ggr.gitbook.io/docs/integration/seamless-api/transaction-site-endpoint#response) * [Success](https://ggr.gitbook.io/docs/integration/seamless-api/transaction-site-endpoint#success) * [Failure](https://ggr.gitbook.io/docs/integration/seamless-api/transaction-site-endpoint#failure) Was this helpful? Copy { "method": "transaction", "agent_code": "your_agent_code", "agent_secret": "your_agent_secret", "agent_balance": 10000000, "user_code": "test", "user_token": "c3041c6d9146a164387fa454eff7b432", "user_balance": 102000, "game_type": "live", "info": "{\"gameresult\":{\"pp\":\"0.0\",\"bb\":\"0.0\",\"gameType\":\"baccarat\",\"perfectPair\":\"false\",\"banker_pair\":\"false\",\"code\":\"0\",\"bighand\":\"false\",\"bg\":\"0.0\",\"player_pair\":\"false\",\"bp\":\"0.0\",\"result\":\"player\",\"score\":\"8\",\"bnc\":\"0.0\",\"sm\":\"2.5\",\"id\":\"15676627318\",\"table\":\"pwnhicogrzeodk79\",\"eitherPair\":\"false\",\"gameId\":\"15676627318\",\"b\":\"0.0\",\"s6\":\"0.0\",\"natural\":\"true\",\"playerBonus\":\"true\",\"pnc\":\"2.0\",\"ep\":\"0.0\",\"bankerBonus\":\"false\",\"prp\":\"0.0\",\"p\":\"2.0\",\"pb\":\"2.0\",\"t\":\"0.0\",\"super6\":\"false\",\"time\":\"00:40:15\",\"smallhand\":\"true\",\"seq\":2304,\"value\":\"player\"}}", "live": { "provider_code": "EVOLUTION", "game_code": "100", "type": "baccarat", "bet_money": 2000, "win_money": 4000, "round_id": 15676627318, "txn_id": "15676627318", "txn_id_v2": "b7e12d4a8f0c4519a2d6e3b81f5c9047", "txn_type": "debit_credit" } } Copy { "method": "transaction", "agent_code": "your_agent_code", "agent_secret": "your_agent_secret", "agent_balance": 10000000, "user_code": "test", "user_token": "c3041c6d9146a164387fa454eff7b432", "user_balance": 102000, "game_type": "SB", "info": "{\"couponCode\":\"000000561435\",\"status\":\"pending\",\"totalOdds\":3.73,\"potentialWin\":18.64,\"stake\":5,\"payout\":0,\"betslips\":[{\"id\":120,\"sportName\":\"Football\",\"countryName\":\"World\",\"leagueName\":\"Club Friendlies\",\"matchName\":\"Odds - Stromsgodset\",\"homeTeam\":\"Odds\",\"awayTeam\":\"Stromsgodset\",\"marketName\":\"1X2\",\"oddName\":\"W1\",\"oddRate\":1.46,\"oddPoint\":\"696729566|1|1|0\"}],\"settlementData\":{}}", "SB": { "provider_code": "SPORTSBOOK", "game_code": "SPORTSBOOK", "type": "accumulator", "bet_money": 5, "win_money": 0, "round_id": 561435, "txn_id": "561435", "txn_id_v2": "44097c196a8b59b7371ee2ca6fe83999", "txn_type": "debit" } } Copy { "method": "transaction", "agent_code": "your_agent_code", "agent_secret": "your_agent_secret", "agent_balance": 10000000, "user_code": "test", "user_token": "c3041c6d9146a164387fa454eff7b432", "user_balance": 99200, "game_type": "MN", "MN": { "provider_code": "SPRIBE", "game_code": "minigame_01", "type": "BASE", "bet_money": 1000, "win_money": 200, "round_id": 123456789, "txn_id": "123456789", "txn_id_v2": "3f0a6c1de95b47829c04a7be2d18f635", "txn_type": "debit_credit" } } Copy // debit — bet only { "txn_type": "debit", "bet_money": 2000, "win_money": 0, "round_id": 123456789, "txn_id": "123456789", "txn_id_v2": "64a83f2fc597acc9004eec52c3f84c30" } // credit — win of an inner spin (same round_id and txn_id, new txn_id_v2) { "txn_type": "credit", "bet_money": 0, "win_money": 1500, "round_id": 123456789, "txn_id": "123456789", "txn_id_v2": "5c81b0af73e2496db1fa08c6d437e9a2" } // credit — win of the next inner spin of that same bet { "txn_type": "credit", "bet_money": 0, "win_money": 400, "round_id": 123456789, "txn_id": "123456789", "txn_id_v2": "e04fd920a1b74c8fb2c3576ad8e1490f" } // debit_credit — the next bet, settled in one transaction { "txn_type": "debit_credit", "bet_money": 2000, "win_money": 1500, "round_id": 123456790, "txn_id": "123456790", "txn_id_v2": "a1b2c3d4e5f6789012345678abcdef01" } Copy { "status": 1, "user_balance": 1000 } Copy { "status": 0, "msg": "INSUFFICIENT_USER_FUNDS" } --- # Call History | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/integration/call-api/call-history.md) . ### Endpoint[](https://ggr.gitbook.io/docs/integration/call-api/call-history#endpoint) Copy POST https://{API_SERVER} **Content-Type:** `application/json` ### Request[](https://ggr.gitbook.io/docs/integration/call-api/call-history#request) **Method:** `call_history` Copy { "method": "call_history", "agent_code": "your_agent_code", "agent_token": "your_agent_token", "offset": 0, "limit": 100 } Field Type Required Description `method` string Yes Must be `call_history` `agent_code` string Yes Your agent code `agent_token` string Yes Your agent API token `offset` number Yes Pagination offset (starting index) `limit` number Yes Number of records to return ### Response[](https://ggr.gitbook.io/docs/integration/call-api/call-history#response) #### Success[](https://ggr.gitbook.io/docs/integration/call-api/call-history#success) #### Failure[](https://ggr.gitbook.io/docs/integration/call-api/call-history#failure) ### Call Status Reference[](https://ggr.gitbook.io/docs/integration/call-api/call-history#call-status-reference) Status Meaning `0` Waiting `1` Processing `2` Finished `3` Rejected by game server (bet amount changed) `4` Canceled (via Cancel API or back-office button) ### Expect, Missed, and Real Money[](https://ggr.gitbook.io/docs/integration/call-api/call-history#expect-missed-and-real-money) Field Description `expect` Amount reserved when the admin applies the call (e.g. 1000) `real` Amount the user actually received (e.g. 800) `missed` Difference returned to the admin (`expect − real`, e.g. 200) #### Why missed money?[](https://ggr.gitbook.io/docs/integration/call-api/call-history#why-missed-money) Some Pragmatic Play games with free-option mechanics (e.g. 5 Lions Megaways, The Dog House Megaways, Wild Booster) may not deliver the full expected payout. Unused funds are returned to the agent. ### Status Examples[](https://ggr.gitbook.io/docs/integration/call-api/call-history#status-examples) #### Waiting (`status: 0`)[](https://ggr.gitbook.io/docs/integration/call-api/call-history#waiting-status-0) #### Processing (`status: 1`)[](https://ggr.gitbook.io/docs/integration/call-api/call-history#processing-status-1) #### Finished (`status: 2`)[](https://ggr.gitbook.io/docs/integration/call-api/call-history#finished-status-2) #### Rejected — bet changed (`status: 3`)[](https://ggr.gitbook.io/docs/integration/call-api/call-history#rejected-bet-changed-status-3) #### Canceled (`status: 4`)[](https://ggr.gitbook.io/docs/integration/call-api/call-history#canceled-status-4) [PreviousCall Cancel](https://ggr.gitbook.io/docs/integration/call-api/call-cancel) [NextFreeSpin Tour API](https://ggr.gitbook.io/docs/integration/freespin-tour-api) Last updated 2 months ago Was this helpful? * [Endpoint](https://ggr.gitbook.io/docs/integration/call-api/call-history#endpoint) * [Request](https://ggr.gitbook.io/docs/integration/call-api/call-history#request) * [Response](https://ggr.gitbook.io/docs/integration/call-api/call-history#response) * [Call Status Reference](https://ggr.gitbook.io/docs/integration/call-api/call-history#call-status-reference) * [Expect, Missed, and Real Money](https://ggr.gitbook.io/docs/integration/call-api/call-history#expect-missed-and-real-money) * [Status Examples](https://ggr.gitbook.io/docs/integration/call-api/call-history#status-examples) Was this helpful? Copy { "status": 1, "data": [\ {\ "id": 93,\ "agent_code": "your_agent_code",\ "user_code": "test",\ "provider_code": "PRAGMATIC",\ "game_code": "vs20doghouse",\ "bet": 1600,\ "user_prev": null,\ "user_after": null,\ "agent_prev": 901200,\ "agent_after": 181040,\ "expect": 720160,\ "missed": 720160,\ "real": 0,\ "rtp": 45010,\ "type": "common",\ "status": 0,\ "msg": null,\ "created_at": "2023-02-23T04:02:45.000Z",\ "updated_at": "2023-02-23T04:02:46.000Z"\ }\ ] } Copy { "status": 0, "msg": "Invalid Agent." } Copy { "id": 93, "status": 0, "expect": 720160, "missed": 720160, "real": 0, "msg": null } Copy { "id": 94, "status": 1, "msg": "Processing" } Copy { "id": 95, "status": 2, "expect": 2000, "missed": 0, "real": 2000, "msg": "Finished" } Copy { "id": 106, "status": 3, "msg": "Rejected (callBet = 2000, currentBet = 1600)}" } Copy { "id": 107, "status": 4, "msg": "Canceled by User" } --- # Game Log | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/integration/game-api/game-log.md) . End**point**[](https://ggr.gitbook.io/docs/integration/game-api/game-log#endpoint) ----------------------------------------------------------------------------------- Copy POST https://{API_SERVER} **Request Body**[](https://ggr.gitbook.io/docs/integration/game-api/game-log#request-body) ------------------------------------------------------------------------------------------- Copy { "method": "get_game_log", "agent_code": "testAgent", "agent_token": "41f5cc794aef2b138c715cf25f767cc1", "user_code": "tsetAgent", "game_type": "slot", "start": "2021-09-17 00:00:00", "end": "2021-09-17 23:59:00", "page": 0, "perPage": 1000 } Key Type Description **method** string The method type(`get_game_log`) **agent\_code** string The agent's code **agent\_token** string The agent's authentication token **user\_code** string The user's code **game\_type** string The type of game for which the log is being retrieved. **start** string The start date and time for the search in the format `yyyy-MM-dd HH:mm:ss`. **end** string The end date and time for the search in the format `yyyy-MM-dd HH:mm:ss`. **page** integer The page number for pagination (used for multiple results). **perPage** integer The number of records to return per page (maximum 1,000,000). **Success Response**[](https://ggr.gitbook.io/docs/integration/game-api/game-log#success-response) --------------------------------------------------------------------------------------------------- Key Type Description **status** integer (32-bit) The response status. `1` means success. **total\_count** integer (32-bit) The total number of logs that match the query criteria. **page** integer (32-bit) The current page number of the results. **perPage** integer (32-bit) The number of records returned per page (as per the request). **slot** array A list of game transaction logs matching the request, with each log entry containing transaction details. **Transaction Log Details (Inside** `**slot**` **array):** Key Type Description **history\_id** integer (64-bit) The unique ID of the transaction history entry. **agent\_code** string The code of the agent who processed the transaction. **user\_code** string The code of the user who made the transaction. **provider\_code** string The code of the game provider. **game\_code** string The unique game identifier (e.g., `vs20doghouse`). **type** string The type of transaction (e.g., `BASE`, `FREE`). **bet\_money** double The amount of money bet by the user. **win\_money** double The amount of money won by the user. **txn\_id** string The unique transaction ID. **txn\_type** string The type of transaction (e.g., `debit_credit`) **user\_start\_balance** double The user's balance before the transaction. **user\_end\_balance** double The user's balance after the transaction. **agent\_start\_balance** double The agent's balance before the transaction. **agent\_end\_balance** double The agent's balance after the transaction. **created\_at** string The date and time when the transaction was created. ### **Example Success Response**[](https://ggr.gitbook.io/docs/integration/game-api/game-log#example-success-response) ### **Failure Response Example**[](https://ggr.gitbook.io/docs/integration/game-api/game-log#failure-response-example) #### **Explanation:**[](https://ggr.gitbook.io/docs/integration/game-api/game-log#explanation) Key Type Description **status** integer (32-bit) Indicates the response status. A value of `0` indicates a failure. **msg** string A brief message describing the error. In this case, `Invalid Parameter.` indicates an invalid parameter was provided. **detail** string A more detailed message explaining the specific issue. [PreviousAgent & User Info](https://ggr.gitbook.io/docs/integration/game-api/agent-and-user-info) [NextIn-Game History](https://ggr.gitbook.io/docs/integration/game-api/in-game-history) Last updated 2 months ago Was this helpful? * [Endpoint](https://ggr.gitbook.io/docs/integration/game-api/game-log#endpoint) * [Request Body](https://ggr.gitbook.io/docs/integration/game-api/game-log#request-body) * [Success Response](https://ggr.gitbook.io/docs/integration/game-api/game-log#success-response) * [Example Success Response](https://ggr.gitbook.io/docs/integration/game-api/game-log#example-success-response) * [Failure Response Example](https://ggr.gitbook.io/docs/integration/game-api/game-log#failure-response-example) Was this helpful? Copy { "status": 1, "total_count": 340, "page": 0, "perPage": 1000, "slot": [\ {\ "history_id": 777,\ "agent_code": "admin",\ "user_code": "test",\ "provider_code": "PRAGMATIC",\ "game_code": "vs20doghouse",\ "type": "BASE",\ "bet_money": 2000,\ "win_money": 0,\ "txn_id": "64a83f2fc597acc9004eec52c3f84c30",\ "txn_type": "debit_credit",\ "user_start_balance": 230500,\ "user_end_balance": 228500,\ "agent_start_balance": 22092000,\ "agent_end_balance": 22092000,\ "created_at": "2021-09-17T12:50:42.000Z"\ },\ ...\ ] } Copy { "status": 0, "msg": "Invalid Parameter.", "detail": "perPage must be less than or equal to 1000000" } --- # Current Playing Users | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/integration/call-api/current-playing-users.md) . ### Endpoint[](https://ggr.gitbook.io/docs/integration/call-api/current-playing-users#endpoint) Copy POST https://{API_SERVER} **Content-Type:** `application/json` ### Request[](https://ggr.gitbook.io/docs/integration/call-api/current-playing-users#request) **Method:** `call_players` Copy { "method": "call_players", "agent_code": "your_agent_code", "agent_token": "your_agent_token" } Field Type Required Description `method` string Yes Must be `call_players` `agent_code` string Yes Your agent code `agent_token` string Yes Your agent API token ### Response[](https://ggr.gitbook.io/docs/integration/call-api/current-playing-users#response) #### Success[](https://ggr.gitbook.io/docs/integration/call-api/current-playing-users#success) Copy { "status": 1, "data": [\ {\ "user_code": "test",\ "provider_code": "PRAGMATIC",\ "game_code": "vs20doghouse",\ "bet": 1600,\ "balance": 11804848.2,\ "total_debit": 1271837.75,\ "total_credit": 3383894.16,\ "target_rtp": 92,\ "real_rtp": 266.06\ }\ ] } Field Description `user_code` User identifier `provider_code` Game provider code `game_code` Game identifier `bet` Current bet amount `balance` User balance `total_debit` Total debited amount `total_credit` Total credited amount `target_rtp` Target RTP for the user `real_rtp` Actual RTP for the user #### Failure[](https://ggr.gitbook.io/docs/integration/call-api/current-playing-users#failure) [PreviousCALL API](https://ggr.gitbook.io/docs/integration/call-api) [NextCall List](https://ggr.gitbook.io/docs/integration/call-api/call-list) Last updated 2 months ago Was this helpful? * [Endpoint](https://ggr.gitbook.io/docs/integration/call-api/current-playing-users#endpoint) * [Request](https://ggr.gitbook.io/docs/integration/call-api/current-playing-users#request) * [Response](https://ggr.gitbook.io/docs/integration/call-api/current-playing-users#response) Was this helpful? Copy { "status": 0, "msg": "Invalid Agent." } --- # Call Apply | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/integration/call-api/call-apply.md) . Endpoint[](https://ggr.gitbook.io/docs/integration/call-api/call-apply#endpoint) --------------------------------------------------------------------------------- Copy POST https://{API_SERVER} **Content-Type:** `application/json` ### Request[](https://ggr.gitbook.io/docs/integration/call-api/call-apply#request) **Method:** `call_apply` Copy { "method": "call_apply", "agent_code": "your_agent_code", "agent_token": "your_agent_token", "provider_code": "PRAGMATIC", "game_code": "vs20doghouse", "user_code": "test", "call_rtp": 45010, "call_type": 1 } Field Type Required Description `method` string Yes Must be `call_apply` `agent_code` string Yes Your agent code `agent_token` string Yes Your agent API token `provider_code` string Yes Game provider code `game_code` string Yes Game identifier `user_code` string Yes Target user `call_rtp` number Yes RTP value from **Get Call List** `call_type` number Yes `1` = Common Free, `2` = Buy Bonus Free ### Response[](https://ggr.gitbook.io/docs/integration/call-api/call-apply#response) #### Success[](https://ggr.gitbook.io/docs/integration/call-api/call-apply#success) `called_money` is calculated as: #### Failure[](https://ggr.gitbook.io/docs/integration/call-api/call-apply#failure) [PreviousCall List](https://ggr.gitbook.io/docs/integration/call-api/call-list) [NextCall Cancel](https://ggr.gitbook.io/docs/integration/call-api/call-cancel) Last updated 2 months ago Was this helpful? * [Endpoint](https://ggr.gitbook.io/docs/integration/call-api/call-apply#endpoint) * [Request](https://ggr.gitbook.io/docs/integration/call-api/call-apply#request) * [Response](https://ggr.gitbook.io/docs/integration/call-api/call-apply#response) Was this helpful? Copy { "status": 1, "called_money": 720160, "msg": "SUCCESS" } Copy called_money = bet × (rtp / 100) Copy { "status": 0, "msg": "Processing call is existed." } --- # Languages | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/appendix/languages.md) . [🎲Pragmatic Play](https://ggr.gitbook.io/docs/appendix/languages/pragmatic-play) [🎲Evolution](https://ggr.gitbook.io/docs/appendix/languages/evolution) [Sportsbook](https://ggr.gitbook.io/docs/appendix/languages/sportsbook) [Spribe](https://ggr.gitbook.io/docs/appendix/languages/spribe) [PGSoft](https://ggr.gitbook.io/docs/appendix/languages/pgsoft) [Habanero](https://ggr.gitbook.io/docs/appendix/languages/habanero) [Booongo](https://ggr.gitbook.io/docs/appendix/languages/booongo) [Playson](https://ggr.gitbook.io/docs/appendix/languages/playson) [CQ9](https://ggr.gitbook.io/docs/appendix/languages/cq9) [Evoplay](https://ggr.gitbook.io/docs/appendix/languages/evoplay) [TopTrend](https://ggr.gitbook.io/docs/appendix/languages/toptrend) [DreamTech](https://ggr.gitbook.io/docs/appendix/languages/dreamtech) [Hacksaw](https://ggr.gitbook.io/docs/appendix/languages/hacksaw) [FaChai](https://ggr.gitbook.io/docs/appendix/languages/fachai) [Play'n GO](https://ggr.gitbook.io/docs/appendix/languages/playn-go) [Amusnet](https://ggr.gitbook.io/docs/appendix/languages/amusnet) [EGT](https://ggr.gitbook.io/docs/appendix/languages/egt) [Spadegaming](https://ggr.gitbook.io/docs/appendix/languages/spadegaming) [FastSpin](https://ggr.gitbook.io/docs/appendix/languages/fastspin) [Joker Gaming](https://ggr.gitbook.io/docs/appendix/languages/joker-gaming) [PreviousProviders](https://ggr.gitbook.io/docs/appendix/providers) [NextPragmatic Play](https://ggr.gitbook.io/docs/appendix/languages/pragmatic-play) Was this helpful? Was this helpful? --- # TopTrend | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/appendix/languages/toptrend.md) . Language Parameter English en Chinese (Simplified) cn, zh Indonesian id Japanese ja Korean ko Thai th Chinese (Traditional) tw Vietnamese vi [PreviousEvoplay](https://ggr.gitbook.io/docs/appendix/languages/evoplay) [NextDreamTech](https://ggr.gitbook.io/docs/appendix/languages/dreamtech) Last updated 1 year ago Was this helpful? Was this helpful? --- # Joker Gaming | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/appendix/languages/joker-gaming.md) . Language Parameter English en Chinese zh Indonesian id Thai th [PreviousFastSpin](https://ggr.gitbook.io/docs/appendix/languages/fastspin) [NextCurrencies](https://ggr.gitbook.io/docs/appendix/currencies) Last updated 3 months ago Was this helpful? Was this helpful? --- # FaChai | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/appendix/languages/fachai.md) . Language Parameter English en Chinese zh Portuguese pt Thai th Vietnamese vi Burmese my Japanese ja Korean ko Indonesian id Spanish es Turkish tr Russian ru [PreviousHacksaw](https://ggr.gitbook.io/docs/appendix/languages/hacksaw) [NextPlay'n GO](https://ggr.gitbook.io/docs/appendix/languages/playn-go) Last updated 7 months ago Was this helpful? Was this helpful? --- # Evolution | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/appendix/languages/evolution.md) . Language Parameter English en Russian ru Dutch nl French fr German de Italian it Spanish es Danish da Korean ko Turkish tr Japanese ja Vietnamese vi Thai th Romanian ro Traditional Chinese zh Polish pl Bulgarian bg Lithuanian lt Latvian lv Swedish sv Finnish fi Norwegian no Indonesian id Serbian sr Czech cs Slovak sk Estonian et Greek el Hungarian hu Portuguese pt Malaysian ms [PreviousPragmatic Play](https://ggr.gitbook.io/docs/appendix/languages/pragmatic-play) [NextSportsbook](https://ggr.gitbook.io/docs/appendix/languages/sportsbook) Last updated 3 months ago Was this helpful? Was this helpful? --- # Evoplay | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/appendix/languages/evoplay.md) . Language Parameter Chinese (Traditional) zhtw Chinese zh Ukrainian uk Turkish tr Thai th Swedish sv Russian ru Romanian ro Portuguese pt Portuguese (Portugal) pt-pt Polish pl Lithuanian lt Japanese ja Italian it Hungarian hu Croatian hr French fr Finnish fi Spanish es English (US) ens English en German de Czech cs Bulgarian bg [PreviousCQ9](https://ggr.gitbook.io/docs/appendix/languages/cq9) [NextTopTrend](https://ggr.gitbook.io/docs/appendix/languages/toptrend) Last updated 1 year ago Was this helpful? Was this helpful? --- # Sportsbook | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/appendix/languages/sportsbook.md) . Language Parameter English en Portuguese pt Turkish tr Thai th Filipino tl Indonesian id Russian ru Spanish es Albanian al [PreviousEvolution](https://ggr.gitbook.io/docs/appendix/languages/evolution) [NextSpribe](https://ggr.gitbook.io/docs/appendix/languages/spribe) Last updated 3 months ago Was this helpful? Was this helpful? --- # Habanero | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/appendix/languages/habanero.md) . Language Parameter Bulgarian bg Burmese my Chinese (Simplified) zh-CN, zh Chinese (Traditional) zh-TW Croatian hr Danish da Dutch nl English en Estonian et Finnish fi French fr German de Greek el Hebrew he Hungarian hu Indonesian id Italian it Japanese ja Korean ko Latvian lv Lithuanian lt Malay ms Norwegian no Portuguese pt Romanian ro Russian ru Serbian sr Spanish es Swahili sw Swedish sv Thai th Turkish tr Vietnamese vi [PreviousPGSoft](https://ggr.gitbook.io/docs/appendix/languages/pgsoft) [NextBooongo](https://ggr.gitbook.io/docs/appendix/languages/booongo) Last updated 3 months ago Was this helpful? Was this helpful? --- # Playson | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/appendix/languages/playson.md) . Language Parameter Portuguese (Brazil) pt\_br, pt English (US) en\_s English en Danish da German de Greek el Spanish es Finnish fi French fr Indonesian id Italian it Japanese ja Korean ko Norwegian no Portuguese pt Romanian ro Russian ru Serbian sr Swedish sv Thai th Turkish tr Vietnamese vi Chinese zh Czech cs Bulgarian bg Croatian hr Ukrainian ua Slovak sk Dutch nl Hungarian hu Latvian lv Macedonian mk Kazakh kk [PreviousBooongo](https://ggr.gitbook.io/docs/appendix/languages/booongo) [NextCQ9](https://ggr.gitbook.io/docs/appendix/languages/cq9) Last updated 1 year ago Was this helpful? Was this helpful? --- # Spribe | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/appendix/languages/spribe.md) . Language Parameter German de English en Spanish es Finnish fi French fr Hindi hi Hungarian hu Armenian hy Indonesian id Italian it Japanese ja Georgian ka Korean ko Lithuanian lt Norwegian no Polish pl Portuguese pt Portuguese (Brazil) pt-br Romanian ro Russian ru Serbian sr Swedish sv Swahili sw Thai th Turkish tr Ukrainian uk Vietnamese vi Chinese (Simplified) zh Chinese (Traditional) zh-tw [PreviousSportsbook](https://ggr.gitbook.io/docs/appendix/languages/sportsbook) [NextPGSoft](https://ggr.gitbook.io/docs/appendix/languages/pgsoft) Last updated 3 months ago Was this helpful? Was this helpful? --- # Amusnet | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/appendix/languages/amusnet.md) . Language Parameter English en Bulgarian bg Italian it Spanish es Russian ru French fr Dutch nl Macedonian mk Romanian ro Portuguese pt Croatian hr Danish da Hungarian hu Swedish sv German de Czech cs Greek el Ukrainian uk Turkish tr [PreviousPlay'n GO](https://ggr.gitbook.io/docs/appendix/languages/playn-go) [NextEGT](https://ggr.gitbook.io/docs/appendix/languages/egt) Last updated 4 months ago Was this helpful? Was this helpful? --- # DreamTech | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/appendix/languages/dreamtech.md) . Language Parameter Chinese (Simplified) zh\_CN, zh English (US) en\_US, en Thai th\_TH, th [PreviousTopTrend](https://ggr.gitbook.io/docs/appendix/languages/toptrend) [NextHacksaw](https://ggr.gitbook.io/docs/appendix/languages/hacksaw) Last updated 8 months ago Was this helpful? Was this helpful? --- # EGT | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/appendix/languages/egt.md) . Language Parameter Bulgarian BG Czech CS German DE German (Switzerland) DE-CH Greek EL English EN Spanish ES Spanish (Colombia) ES-CO French FR French (Switzerland) FR-CH Croatian HR Hungarian HU Italian IT Italian (Switzerland) IT-CH Georgian KA Macedonian MK Dutch NL Portuguese PT Romanian RO Russian RU Slovak SK Albanian SQ Serbian SR Swedish SV Turkish TR Ukrainian UK Chinese (Simplified) ZH-CN [PreviousAmusnet](https://ggr.gitbook.io/docs/appendix/languages/amusnet) [NextSpadegaming](https://ggr.gitbook.io/docs/appendix/languages/spadegaming) Last updated 4 months ago Was this helpful? Was this helpful? --- # FastSpin | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/appendix/languages/fastspin.md) . Language Parameter Bulgarian BG Czech CS German DE German (Switzerland) DE-CH Greek EL English EN Spanish ES Spanish (Colombia) ES-CO French FR French (Switzerland) FR-CH Croatian HR Hungarian HU Italian IT Italian (Switzerland) IT-CH Georgian KA Macedonian MK Dutch NL Portuguese PT Romanian RO Russian RU Slovak SK Albanian SQ Serbian SR Swedish SV Turkish TR Ukrainian UK Chinese (Simplified) ZH-CN [PreviousSpadegaming](https://ggr.gitbook.io/docs/appendix/languages/spadegaming) [NextJoker Gaming](https://ggr.gitbook.io/docs/appendix/languages/joker-gaming) Last updated 4 months ago Was this helpful? Was this helpful? --- # CQ9 | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/appendix/languages/cq9.md) . Language Parameter Simplified Chinese zh-cn, zh English en Thai th Korean ko Indonesian id Vietnamese vn Filipino ph German de Danish da Spanish es Finnish fi French fr Italian it Norwegian no Portuguese pt-br, pt Russian ru Swedish se Turkish tr Japanese ja [PreviousPlayson](https://ggr.gitbook.io/docs/appendix/languages/playson) [NextEvoplay](https://ggr.gitbook.io/docs/appendix/languages/evoplay) Last updated 1 year ago Was this helpful? Was this helpful? --- # Hacksaw | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/appendix/languages/hacksaw.md) . Language Parameter Danish da German de Greek el English en Spanish es Finnish fi French fr Croatian hr Hungarian hu Indonesian id Italian it Japanese ja Korean ko Lithuanian lt Latvian lv Dutch nl Norwegian no Polish pl Portuguese pt Romanian ro Russian ru Swedish sv Thai th Turkish tr Vietnamese vi Chinese zh [PreviousDreamTech](https://ggr.gitbook.io/docs/appendix/languages/dreamtech) [NextFaChai](https://ggr.gitbook.io/docs/appendix/languages/fachai) Last updated 8 months ago Was this helpful? Was this helpful? --- # Booongo | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/appendix/languages/booongo.md) . Language Parameter Bulgarian bg German de Greek el English en English (Social) en-soc Spanish es Finnish fi French fr Indonesian id Italian it Japanese ja Korean ko Dutch nl Norwegian no Portuguese pt Romanian ro Russian ru Swedish sv Thai th Turkish tr Ukrainian uk Vietnamese vi Chinese zh Chinese (Traditional) zh-hant [PreviousHabanero](https://ggr.gitbook.io/docs/appendix/languages/habanero) [NextPlayson](https://ggr.gitbook.io/docs/appendix/languages/playson) Last updated 1 year ago Was this helpful? Was this helpful? --- # Spadegaming | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/appendix/languages/spadegaming.md) . Language Parameter Chinese zh English en Thai th Indonesian id Vietnamese vi Japanese ja Korean ko Russian ru Turkish tr Spanish es French fr Portuguese pt Bengali bn Hindi hi Romanian ro Italian it [PreviousEGT](https://ggr.gitbook.io/docs/appendix/languages/egt) [NextFastSpin](https://ggr.gitbook.io/docs/appendix/languages/fastspin) Last updated 3 months ago Was this helpful? Was this helpful? --- # PGSoft | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/appendix/languages/pgsoft.md) . Language Parameter English en Danish da German de Spanish es Finnish fi French fr Indonesian id Italian it Japanese ja Korean ko Dutch nl Norwegian no Polish pl Portuguese pt Romanian ro Russian ru Swedish sv Thai th Turkish tr Vietnamese vi Chinese zh Burmese my [PreviousSpribe](https://ggr.gitbook.io/docs/appendix/languages/spribe) [NextHabanero](https://ggr.gitbook.io/docs/appendix/languages/habanero) Last updated 8 months ago Was this helpful? Was this helpful? --- # Play'n GO | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/appendix/languages/playn-go.md) . Language Parameter English en Bulgarian bg Catalan ca Chinese zh Czech cs Danish da German de Greek el Spanish es Estonian et Finnish fi French fr Croatian hr Hungarian hu Icelandic is Italian it Lithuanian lt Latvian lv Dutch nl Norwegian no Polish pl Portuguese pt Romanian ro Russian ru Slovak sk Slovenian sl Swedish sv Turkish tr Japanese ja Indonesian id Malay ms Thai th Vietnamese vi Korean ko [PreviousFaChai](https://ggr.gitbook.io/docs/appendix/languages/fachai) [NextAmusnet](https://ggr.gitbook.io/docs/appendix/languages/amusnet) Last updated 4 months ago Was this helpful? Was this helpful? --- # Pragmatic Play | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/appendix/languages/pragmatic-play.md) . Language Parameter English en Russian ru Dutch nl French fr German de Italian it Spanish es Danish da Korean ko Turkish tr Japanese ja Vietnamese vi Thai th Romanian ro Traditional Chinese zh Polish pl Bulgarian bg Lithuanian lt Latvian lv Swedish sv Finnish fi Norwegian no Indonesian id Serbian sr Czech cs Slovak sk Estonian et Greek el Hungarian hu Portuguese pt Malaysian ms [PreviousLanguages](https://ggr.gitbook.io/docs/appendix/languages) [NextEvolution](https://ggr.gitbook.io/docs/appendix/languages/evolution) Last updated 3 months ago Was this helpful? Was this helpful? --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/appendix/languages.md). # Languages - \[Pragmatic Play\](https://ggr.gitbook.io/docs/appendix/languages/pragmatic-play.md): These language codes are available for both slot and live casino games. - \[Evolution\](https://ggr.gitbook.io/docs/appendix/languages/evolution.md) - \[Sportsbook\](https://ggr.gitbook.io/docs/appendix/languages/sportsbook.md): Additional languages can be added upon request for valuable clients. - \[Spribe\](https://ggr.gitbook.io/docs/appendix/languages/spribe.md) - \[PGSoft\](https://ggr.gitbook.io/docs/appendix/languages/pgsoft.md) - \[Habanero\](https://ggr.gitbook.io/docs/appendix/languages/habanero.md) - \[Booongo\](https://ggr.gitbook.io/docs/appendix/languages/booongo.md) - \[Playson\](https://ggr.gitbook.io/docs/appendix/languages/playson.md) - \[CQ9\](https://ggr.gitbook.io/docs/appendix/languages/cq9.md) - \[Evoplay\](https://ggr.gitbook.io/docs/appendix/languages/evoplay.md) - \[TopTrend\](https://ggr.gitbook.io/docs/appendix/languages/toptrend.md) - \[DreamTech\](https://ggr.gitbook.io/docs/appendix/languages/dreamtech.md) - \[Hacksaw\](https://ggr.gitbook.io/docs/appendix/languages/hacksaw.md) - \[FaChai\](https://ggr.gitbook.io/docs/appendix/languages/fachai.md) - \[Play'n GO\](https://ggr.gitbook.io/docs/appendix/languages/playn-go.md) - \[Amusnet\](https://ggr.gitbook.io/docs/appendix/languages/amusnet.md) - \[EGT\](https://ggr.gitbook.io/docs/appendix/languages/egt.md) - \[Spadegaming\](https://ggr.gitbook.io/docs/appendix/languages/spadegaming.md) - \[FastSpin\](https://ggr.gitbook.io/docs/appendix/languages/fastspin.md) - \[Joker Gaming\](https://ggr.gitbook.io/docs/appendix/languages/joker-gaming.md): Most games are primarily built in English, with some supporting multiple languages. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/appendix/languages.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/integration/game-api/game-list.md). # Game List This is an API endpoint for retrieving a list of games associated with a specific provider. ### Endpoint \`\`\` POST https://{API\_SERVER} \`\`\` \*\*Content-Type:\*\* \`application/json\` ### Request #### game\\\_list (v1) \*\*Method:\*\* \`game\_list\` \`\`\`json { "method": "game\_list", "agent\_code": "your\_agent\_code", "agent\_token": "your\_agent\_token", "provider\_code": "PRAGMATIC" } \`\`\` \*\*Supported providers for \`game\_list\`:\*\* \`\`\` All providers \`\`\` #### game\\\_list\\\_v2 (v2) \*\*Method:\*\* \`game\_list\_v2\` \`\`\`json { "method": "game\_list\_v2", "agent\_code": "your\_agent\_code", "agent\_token": "your\_agent\_token", "provider\_code": "PRAGMATIC" } \`\`\` \*\*Supported providers for \`game\_list\_v2\`:\*\* \`\`\` PRAGMATIC, PGSOFT, REELKINGDOM, FATPANDA, HABANERO, CQ9 \`\`\` | Field | Type | Required | Description | | --------------- | ------ | -------- | ----------------------------- | | \`method\` | string | Yes | \`game\_list\` or \`game\_list\_v2\` | | \`agent\_code\` | string | Yes | Your agent code | | \`agent\_token\` | string | Yes | Your agent API token | | \`provider\_code\` | string | Yes | Provider code | ### Response #### Success — v1 \`\`\`json { "status": 1, "msg": "SUCCESS", "games": \[\ {\ "game\_code": "vs243mwarrior",\ "game\_name": "Monkey Warrior",\ "banner": "https://.../vs243mwarrior.png",\ "status": 1,\ "bet\_levels": {\ "1": 0.25,\ "2": 0.5,\ "3": 0.75,\ "4": 1,\ "5": 2.5,\ "6": 5,\ "7": 12.5,\ "8": 25,\ "9": 50,\ "10": 125\ }\ }\ \] } \`\`\` #### Success — v2 \`\`\`json { "status": 1, "msg": "SUCCESS", "games": \[\ {\ "id": 1,\ "game\_code": "vs243mwarrior",\ "game\_name": {\ "hi": "मंकी वारियर™",\ "vi": "Chiến Binh Khỉ",\ "ko": "몽키 워리어",\ "th": "นักรบลิง",\ "zh-hant": "酷猴戰士",\ "zh-hans": "酷猴战士"\ },\ "bet\_levels": {\ "1": 0.25,\ "2": 0.5,\ "3": 0.75,\ "4": 1,\ "5": 2.5,\ "6": 5,\ "7": 12.5,\ "8": 25,\ "9": 50,\ "10": 125\ }\ }\ \] } \`\`\` #### \`bet\_levels\` The bets the game offers, as \`level number\` → \`stake of one spin\`. Level \`1\` is always the smallest bet, and the levels go up from there. | Part | Meaning | | ----- | ------------------------------------------------------- | | Key | The bet level, counting from \`1\` | | Value | What one spin at that level costs, in \*\*your\*\* currency | The values are worked out for the agent making the request, from your currency and your bet range, so two agents can get different numbers for the same game. How many levels a game has differs per game as well — read the list, don't assume a fixed length. Use the key as the \`bet\_level\` of \*\*Create Free Tour\*\*. With \`"bet\_levels": { "3": 0.75 }\`, sending \`"bet\_level": 3\` stakes each of that tour's free rounds at 0.75. > \*\*\`PRAGMATIC\` only for now.\*\* \`bet\_levels\` is the one provider that exposes its bet range so far. Every other provider leaves the field out of the game object entirely, so treat it as optional and do not build a UI that expects it everywhere. More providers are planned. #### Failure \`\`\`json { "status": 0, "msg": "INTERNAL\_ERROR" } \`\`\` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/integration/game-api/game-list.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/integration/call-api/call-apply.md). # Call Apply Applies a call (bonus) to a user in a specific game. Use call\\\_rtp from the Get Call List response. ## Endpoint \`\`\` POST https://{API\_SERVER} \`\`\` \*\*Content-Type:\*\* \`application/json\` ### Request \*\*Method:\*\* \`call\_apply\` \`\`\`json { "method": "call\_apply", "agent\_code": "your\_agent\_code", "agent\_token": "your\_agent\_token", "provider\_code": "PRAGMATIC", "game\_code": "vs20doghouse", "user\_code": "test", "call\_rtp": 45010, "call\_type": 1 } \`\`\`
FieldTypeRequiredDescription
methodstringYesMust be call\_apply
agent\_codestringYesYour agent code
agent\_tokenstringYesYour agent API token
provider\_codestringYesGame provider code
game\_codestringYesGame identifier
user\_codestringYesTarget user
call\_rtpnumberYesRTP value from Get Call List
call\_typenumberYes1 = Common Free, 2 = Buy Bonus Free
### Response #### Success \`\`\`json { "status": 1, "called\_money": 720160, "msg": "SUCCESS" } \`\`\` \`called\_money\` is calculated as: \`\`\` called\_money = bet × (rtp / 100) \`\`\` #### Failure \`\`\`json { "status": 0, "msg": "Processing call is existed." } \`\`\` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/integration/call-api/call-apply.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/integration/freespin-tour-api.md). # FreeSpin Tour API - \[Create Tour\](https://ggr.gitbook.io/docs/integration/freespin-tour-api/create-tour.md) - \[Cancel Tour\](https://ggr.gitbook.io/docs/integration/freespin-tour-api/cancel-tour.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/integration/freespin-tour-api.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/integration/seamless-api.md). # Seamless API {% hint style="warning" %} Your site must implement this callback APIs. It is \*\*required\*\* for Seamless mode only. {% endhint %} The platform sends requests to your configured site endpoint (e.g. \`https://your-backend.com/gold\_api\`). {% hint style="danger" %} When entering the Site Endpoint in profile page, ensure that it is an \`https\` domain and does not include \`/gold\_api\` at the end, as \`/gold\_api\` will be appended automatically when sending API requests. {% endhint %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/integration/seamless-api.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/appendix/currencies.md). # Currencies \* We support all types of fiat currencies and special currencies tailored to the agent's requirements. \* Currency symbols may be hidden according to the request. \* The bet range can be adjusted as needed. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/appendix/currencies.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/appendix/languages/toptrend.md). # TopTrend | Language | Parameter | | --------------------- | --------- | | English | en | | Chinese (Simplified) | cn, zh | | Indonesian | id | | Japanese | ja | | Korean | ko | | Thai | th | | Chinese (Traditional) | tw | | Vietnamese | vi | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/appendix/languages/toptrend.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/integration/call-api/current-playing-users.md). # Current Playing Users Returns users currently playing slot games under your agent. ### Endpoint \`\`\` POST https://{API\_SERVER} \`\`\` \*\*Content-Type:\*\* \`application/json\` ### Request \*\*Method:\*\* \`call\_players\` \`\`\`json { "method": "call\_players", "agent\_code": "your\_agent\_code", "agent\_token": "your\_agent\_token" } \`\`\`
FieldTypeRequiredDescription
methodstringYesMust be call\_players
agent\_codestringYesYour agent code
agent\_tokenstringYesYour agent API token
### Response #### Success \`\`\`json { "status": 1, "data": \[\ {\ "user\_code": "test",\ "provider\_code": "PRAGMATIC",\ "game\_code": "vs20doghouse",\ "bet": 1600,\ "balance": 11804848.2,\ "total\_debit": 1271837.75,\ "total\_credit": 3383894.16,\ "target\_rtp": 92,\ "real\_rtp": 266.06\ }\ \] } \`\`\`
FieldDescription
user\_codeUser identifier
provider\_codeGame provider code
game\_codeGame identifier
betCurrent bet amount
balanceUser balance
total\_debitTotal debited amount
total\_creditTotal credited amount
target\_rtpTarget RTP for the user
real\_rtpActual RTP for the user
#### Failure \`\`\`json { "status": 0, "msg": "Invalid Agent." } \`\`\` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/integration/call-api/current-playing-users.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/appendix/languages/joker-gaming.md). # Joker Gaming Most games are primarily built in English, with some supporting multiple languages. | Language | Parameter | | ---------- | --------- | | English | en | | Chinese | zh | | Indonesian | id | | Thai | th | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/appendix/languages/joker-gaming.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/appendix/languages/fachai.md). # FaChai | Language | Parameter | | ---------- | --------- | | English | en | | Chinese | zh | | Portuguese | pt | | Thai | th | | Vietnamese | vi | | Burmese | my | | Japanese | ja | | Korean | ko | | Indonesian | id | | Spanish | es | | Turkish | tr | | Russian | ru | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/appendix/languages/fachai.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/appendix/languages/sportsbook.md). # Sportsbook Additional languages can be added upon request for valuable clients. | Language | Parameter | | ---------- | --------- | | English | en | | Portuguese | pt | | Turkish | tr | | Thai | th | | Filipino | tl | | Indonesian | id | | Russian | ru | | Spanish | es | | Albanian | al | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/appendix/languages/sportsbook.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/appendix/languages/evolution.md). # Evolution | Language | Parameter | | ------------------- | --------- | | English | en | | Russian | ru | | Dutch | nl | | French | fr | | German | de | | Italian | it | | Spanish | es | | Danish | da | | Korean | ko | | Turkish | tr | | Japanese | ja | | Vietnamese | vi | | Thai | th | | Romanian | ro | | Traditional Chinese | zh | | Polish | pl | | Bulgarian | bg | | Lithuanian | lt | | Latvian | lv | | Swedish | sv | | Finnish | fi | | Norwegian | no | | Indonesian | id | | Serbian | sr | | Czech | cs | | Slovak | sk | | Estonian | et | | Greek | el | | Hungarian | hu | | Portuguese | pt | | Malaysian | ms | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/appendix/languages/evolution.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/integration/game-api/game-log.md). # Game Log This is an API used to retrieve the game log for a specific user or agent, including transaction details for a specified time range. ## End\*\*point\*\* \`\`\` POST https://{API\_SERVER} \`\`\` ## \*\*Request Body\*\* \`\`\`json { "method": "get\_game\_log", "agent\_code": "testAgent", "agent\_token": "41f5cc794aef2b138c715cf25f767cc1", "user\_code": "tsetAgent", "game\_type": "slot", "start": "2021-09-17 00:00:00", "end": "2021-09-17 23:59:00", "page": 0, "perPage": 1000 } \`\`\`
KeyTypeDescription
methodstringThe method type(get\_game\_log)
agent\_codestringThe agent's code
agent\_tokenstringThe agent's authentication token
user\_codestringThe user's code
game\_typestringThe type of game for which the log is being retrieved.
startstringThe start date and time for the search in the format yyyy-MM-dd HH:mm:ss.
endstringThe end date and time for the search in the format yyyy-MM-dd HH:mm:ss.
pageintegerThe page number for pagination (used for multiple results).
perPageintegerThe number of records to return per page (maximum 1,000,000).
## \*\*Success Response\*\*
KeyTypeDescription
statusinteger (32-bit)The response status. 1 means success.
total\_countinteger (32-bit)The total number of logs that match the query criteria.
pageinteger (32-bit)The current page number of the results.
perPageinteger (32-bit)The number of records returned per page (as per the request).
slotarrayA list of game transaction logs matching the request, with each log entry containing transaction details.
\*\*Transaction Log Details (Inside \`slot\` array):\*\*
KeyTypeDescription
history\_idinteger (64-bit)The unique ID of the transaction history entry.
agent\_codestringThe code of the agent who processed the transaction.
user\_codestringThe code of the user who made the transaction.
provider\_codestringThe code of the game provider.
game\_codestringThe unique game identifier (e.g., vs20doghouse).
typestringThe type of transaction (e.g., BASE, FREE).
bet\_moneydoubleThe amount of money bet by the user.
win\_moneydoubleThe amount of money won by the user.
txn\_idstringThe unique transaction ID.
txn\_typestringThe type of transaction (e.g., debit\_credit)
user\_start\_balancedoubleThe user's balance before the transaction.
user\_end\_balancedoubleThe user's balance after the transaction.
agent\_start\_balancedoubleThe agent's balance before the transaction.
agent\_end\_balancedoubleThe agent's balance after the transaction.
created\_atstringThe date and time when the transaction was created.
### \*\*Example Success Response\*\* \`\`\`json { "status": 1, "total\_count": 340, "page": 0, "perPage": 1000, "slot": \[\ {\ "history\_id": 777,\ "agent\_code": "admin",\ "user\_code": "test",\ "provider\_code": "PRAGMATIC",\ "game\_code": "vs20doghouse",\ "type": "BASE",\ "bet\_money": 2000,\ "win\_money": 0,\ "txn\_id": "64a83f2fc597acc9004eec52c3f84c30",\ "txn\_type": "debit\_credit",\ "user\_start\_balance": 230500,\ "user\_end\_balance": 228500,\ "agent\_start\_balance": 22092000,\ "agent\_end\_balance": 22092000,\ "created\_at": "2021-09-17T12:50:42.000Z"\ },\ ...\ \] } \`\`\` ### \*\*Failure Response Example\*\* \`\`\`json { "status": 0, "msg": "Invalid Parameter.", "detail": "perPage must be less than or equal to 1000000" } \`\`\` #### \*\*Explanation:\*\*
KeyTypeDescription
statusinteger (32-bit)Indicates the response status. A value of 0 indicates a failure.
msgstringA brief message describing the error. In this case, Invalid Parameter. indicates an invalid parameter was provided.
detailstringA more detailed message explaining the specific issue.
\[^1\]: If not specified, the API will return the entire transaction history for the agent. \[^2\]: \`slot\` for slot games, \`live\` for live casino --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/integration/game-api/game-log.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/appendix/languages/playson.md). # Playson | Language | Parameter | | ------------------- | ---------- | | Portuguese (Brazil) | pt\\\_br, pt | | English (US) | en\\\_s | | English | en | | Danish | da | | German | de | | Greek | el | | Spanish | es | | Finnish | fi | | French | fr | | Indonesian | id | | Italian | it | | Japanese | ja | | Korean | ko | | Norwegian | no | | Portuguese | pt | | Romanian | ro | | Russian | ru | | Serbian | sr | | Swedish | sv | | Thai | th | | Turkish | tr | | Vietnamese | vi | | Chinese | zh | | Czech | cs | | Bulgarian | bg | | Croatian | hr | | Ukrainian | ua | | Slovak | sk | | Dutch | nl | | Hungarian | hu | | Latvian | lv | | Macedonian | mk | | Kazakh | kk | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/appendix/languages/playson.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/appendix/languages/spribe.md). # Spribe | Language | Parameter | | --------------------- | --------- | | German | de | | English | en | | Spanish | es | | Finnish | fi | | French | fr | | Hindi | hi | | Hungarian | hu | | Armenian | hy | | Indonesian | id | | Italian | it | | Japanese | ja | | Georgian | ka | | Korean | ko | | Lithuanian | lt | | Norwegian | no | | Polish | pl | | Portuguese | pt | | Portuguese (Brazil) | pt-br | | Romanian | ro | | Russian | ru | | Serbian | sr | | Swedish | sv | | Swahili | sw | | Thai | th | | Turkish | tr | | Ukrainian | uk | | Vietnamese | vi | | Chinese (Simplified) | zh | | Chinese (Traditional) | zh-tw | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/appendix/languages/spribe.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/appendix/languages/evoplay.md). # Evoplay | Language | Parameter | | --------------------- | --------- | | Chinese (Traditional) | zhtw | | Chinese | zh | | Ukrainian | uk | | Turkish | tr | | Thai | th | | Swedish | sv | | Russian | ru | | Romanian | ro | | Portuguese | pt | | Portuguese (Portugal) | pt-pt | | Polish | pl | | Lithuanian | lt | | Japanese | ja | | Italian | it | | Hungarian | hu | | Croatian | hr | | French | fr | | Finnish | fi | | Spanish | es | | English (US) | ens | | English | en | | German | de | | Czech | cs | | Bulgarian | bg | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/appendix/languages/evoplay.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/appendix/languages/habanero.md). # Habanero | Language | Parameter | | --------------------- | --------- | | Bulgarian | bg | | Burmese | my | | Chinese (Simplified) | zh-CN, zh | | Chinese (Traditional) | zh-TW | | Croatian | hr | | Danish | da | | Dutch | nl | | English | en | | Estonian | et | | Finnish | fi | | French | fr | | German | de | | Greek | el | | Hebrew | he | | Hungarian | hu | | Indonesian | id | | Italian | it | | Japanese | ja | | Korean | ko | | Latvian | lv | | Lithuanian | lt | | Malay | ms | | Norwegian | no | | Portuguese | pt | | Romanian | ro | | Russian | ru | | Serbian | sr | | Spanish | es | | Swahili | sw | | Swedish | sv | | Thai | th | | Turkish | tr | | Vietnamese | vi | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/appendix/languages/habanero.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/appendix/languages/amusnet.md). # Amusnet | Language | Parameter | | ---------- | --------- | | English | en | | Bulgarian | bg | | Italian | it | | Spanish | es | | Russian | ru | | French | fr | | Dutch | nl | | Macedonian | mk | | Romanian | ro | | Portuguese | pt | | Croatian | hr | | Danish | da | | Hungarian | hu | | Swedish | sv | | German | de | | Czech | cs | | Greek | el | | Ukrainian | uk | | Turkish | tr | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/appendix/languages/amusnet.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/appendix/languages/egt.md). # EGT | Language | Parameter | | --------------------- | --------- | | Bulgarian | BG | | Czech | CS | | German | DE | | German (Switzerland) | DE-CH | | Greek | EL | | English | EN | | Spanish | ES | | Spanish (Colombia) | ES-CO | | French | FR | | French (Switzerland) | FR-CH | | Croatian | HR | | Hungarian | HU | | Italian | IT | | Italian (Switzerland) | IT-CH | | Georgian | KA | | Macedonian | MK | | Dutch | NL | | Portuguese | PT | | Romanian | RO | | Russian | RU | | Slovak | SK | | Albanian | SQ | | Serbian | SR | | Swedish | SV | | Turkish | TR | | Ukrainian | UK | | Chinese (Simplified) | ZH-CN | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/appendix/languages/egt.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/appendix/languages/dreamtech.md). # DreamTech | Language | Parameter | | -------------------- | ---------- | | Chinese (Simplified) | zh\\\_CN, zh | | English (US) | en\\\_US, en | | Thai | th\\\_TH, th | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/appendix/languages/dreamtech.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/appendix/languages/fastspin.md). # FastSpin | Language | Parameter | | --------------------- | --------- | | Bulgarian | BG | | Czech | CS | | German | DE | | German (Switzerland) | DE-CH | | Greek | EL | | English | EN | | Spanish | ES | | Spanish (Colombia) | ES-CO | | French | FR | | French (Switzerland) | FR-CH | | Croatian | HR | | Hungarian | HU | | Italian | IT | | Italian (Switzerland) | IT-CH | | Georgian | KA | | Macedonian | MK | | Dutch | NL | | Portuguese | PT | | Romanian | RO | | Russian | RU | | Slovak | SK | | Albanian | SQ | | Serbian | SR | | Swedish | SV | | Turkish | TR | | Ukrainian | UK | | Chinese (Simplified) | ZH-CN | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/appendix/languages/fastspin.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/appendix/languages/cq9.md). # CQ9 | Language | Parameter | | ------------------ | --------- | | Simplified Chinese | zh-cn, zh | | English | en | | Thai | th | | Korean | ko | | Indonesian | id | | Vietnamese | vn | | Filipino | ph | | German | de | | Danish | da | | Spanish | es | | Finnish | fi | | French | fr | | Italian | it | | Norwegian | no | | Portuguese | pt-br, pt | | Russian | ru | | Swedish | se | | Turkish | tr | | Japanese | ja | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/appendix/languages/cq9.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/appendix/languages/pgsoft.md). # PGSoft | Language | Parameter | | ---------- | --------- | | English | en | | Danish | da | | German | de | | Spanish | es | | Finnish | fi | | French | fr | | Indonesian | id | | Italian | it | | Japanese | ja | | Korean | ko | | Dutch | nl | | Norwegian | no | | Polish | pl | | Portuguese | pt | | Romanian | ro | | Russian | ru | | Swedish | sv | | Thai | th | | Turkish | tr | | Vietnamese | vi | | Chinese | zh | | Burmese | my | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/appendix/languages/pgsoft.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/appendix/languages/hacksaw.md). # Hacksaw | Language | Parameter | | ---------- | --------- | | Danish | da | | German | de | | Greek | el | | English | en | | Spanish | es | | Finnish | fi | | French | fr | | Croatian | hr | | Hungarian | hu | | Indonesian | id | | Italian | it | | Japanese | ja | | Korean | ko | | Lithuanian | lt | | Latvian | lv | | Dutch | nl | | Norwegian | no | | Polish | pl | | Portuguese | pt | | Romanian | ro | | Russian | ru | | Swedish | sv | | Thai | th | | Turkish | tr | | Vietnamese | vi | | Chinese | zh | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/appendix/languages/hacksaw.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/appendix/languages/booongo.md). # Booongo | Language | Parameter | | --------------------- | --------- | | Bulgarian | bg | | German | de | | Greek | el | | English | en | | English (Social) | en-soc | | Spanish | es | | Finnish | fi | | French | fr | | Indonesian | id | | Italian | it | | Japanese | ja | | Korean | ko | | Dutch | nl | | Norwegian | no | | Portuguese | pt | | Romanian | ro | | Russian | ru | | Swedish | sv | | Thai | th | | Turkish | tr | | Ukrainian | uk | | Vietnamese | vi | | Chinese | zh | | Chinese (Traditional) | zh-hant | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/appendix/languages/booongo.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/appendix/languages/spadegaming.md). # Spadegaming | Language | Parameter | | ---------- | --------- | | Chinese | zh | | English | en | | Thai | th | | Indonesian | id | | Vietnamese | vi | | Japanese | ja | | Korean | ko | | Russian | ru | | Turkish | tr | | Spanish | es | | French | fr | | Portuguese | pt | | Bengali | bn | | Hindi | hi | | Romanian | ro | | Italian | it | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/appendix/languages/spadegaming.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/integration/rtp-api.md). # RTP API - \[Control Users RTP\](https://ggr.gitbook.io/docs/integration/rtp-api/control-users-rtp.md): Sets the target RTP for multiple users in one request. - \[Control User RTP\](https://ggr.gitbook.io/docs/integration/rtp-api/control-user-rtp.md): Sets the target RTP for a specific user on a provider. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/integration/rtp-api.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/integration/rate-limit.md). # Rate Limit The following APIs are subject to usage limits: \* \*\*user\\\_withdraw\\\_reset\*\* (when "all\\\_users" is set to true): Once per minute \* \*\*get\\\_game\\\_log\*\*: Once per 2 seconds \* \*\*game\\\_list\*\*: Once per second \* \*\*provider\\\_list\*\*: Once per second \* \*\*agent\\\_statistics\*\*: Once every 5 minutes --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/integration/rate-limit.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/integration/seamless-api/user-balance-site-endpoint.md). # User Balance (Site Endpoint) Called to retrieve the current balance for a user before or during gameplay. ### Endpoint \`\`\` POST https://{YOUR\_SITE}/gold\_api \`\`\` \*\*Content-Type:\*\* \`application/json\` \*\*Method:\*\* \`user\_balance\` ### Request \`\`\`json { "method": "user\_balance", "agent\_code": "your\_agent\_code", "agent\_secret": "your\_agent\_secret", "user\_code": "test", "user\_token": "c3041c6d9146a164387fa454eff7b432", "game\_code": "vs20olympgate" } \`\`\`
FieldTypeRequiredDescription
methodstringYesMust be user\_balance
agent\_codestringYesAgent code
agent\_secretstringYesAgent secret key
user\_codestringYesUser identifier
user\_tokenstringYesUser session token
game\_codestringYesGame being played
### Response #### Success Return balance even if it is \`0\`: \`\`\`json { "status": 1, "user\_balance": 0 } \`\`\` #### Failure \`\`\`json { "status": 0, "user\_balance": 0, "msg": "INTERNAL\_ERROR" } \`\`\` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/integration/seamless-api/user-balance-site-endpoint.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/appendix/languages/pragmatic-play.md). # Pragmatic Play These language codes are available for both slot and live casino games. | Language | Parameter | | ------------------- | --------- | | English | en | | Russian | ru | | Dutch | nl | | French | fr | | German | de | | Italian | it | | Spanish | es | | Danish | da | | Korean | ko | | Turkish | tr | | Japanese | ja | | Vietnamese | vi | | Thai | th | | Romanian | ro | | Traditional Chinese | zh | | Polish | pl | | Bulgarian | bg | | Lithuanian | lt | | Latvian | lv | | Swedish | sv | | Finnish | fi | | Norwegian | no | | Indonesian | id | | Serbian | sr | | Czech | cs | | Slovak | sk | | Estonian | et | | Greek | el | | Hungarian | hu | | Portuguese | pt | | Malaysian | ms | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/appendix/languages/pragmatic-play.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/appendix/languages/playn-go.md). # Play'n GO | Language | Parameter | | ---------- | --------- | | English | en | | Bulgarian | bg | | Catalan | ca | | Chinese | zh | | Czech | cs | | Danish | da | | German | de | | Greek | el | | Spanish | es | | Estonian | et | | Finnish | fi | | French | fr | | Croatian | hr | | Hungarian | hu | | Icelandic | is | | Italian | it | | Lithuanian | lt | | Latvian | lv | | Dutch | nl | | Norwegian | no | | Polish | pl | | Portuguese | pt | | Romanian | ro | | Russian | ru | | Slovak | sk | | Slovenian | sl | | Swedish | sv | | Turkish | tr | | Japanese | ja | | Indonesian | id | | Malay | ms | | Thai | th | | Vietnamese | vi | | Korean | ko | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/appendix/languages/playn-go.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/appendix/providers.md). # Providers
NoProvider CodeProvider NameTypeStatus
1EVOLUTIONEvolution LiveliveMaintenance
2PP\_LIVE\_PROPragmatic Play LiveliveOnline
3SPORTSBOOKNexustrikeSBOnline
4PRAGMATICPragmatic SlotslotOnline
5PGSOFTPGSoftslotOnline
6HABANEROHabaneroslotOnline
7BOOONGOBooongoslotOnline
8PLAYSONPlaysonslotOnline
9CQ9CQ9slotOnline
10EVOPLAYEvoplayslotOnline
11TOPTRENDTopTrendslotOnline
12DREAMTECHDreamTechslotOnline
13SPRIBESpribeMNOnline
14HACKSAWHacksawslotOnline
15FACHAIFaChaislotOnline
16PLAYNGOPlay'n GoslotOnline
17AMUSNETAmusnetslotOnline
18EGTEGT DigitalslotOnline
19SPADEGAMINGSpadegamingslotOnline
20FASTSPINFastSpinslotOnline
21JOKERGAMINGJoker GamingslotOnline
22RUBYPLAYRubyPlayslotOnline
23AMATICAmaticslotOnline
24FISHHUNTERFish HunterFHOnline
25NEXTSPINNext SpinslotOnline
--- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/appendix/providers.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/integration/transfer-api.md). # Transfer API - \[Deposit / Withdraw User Balance\](https://ggr.gitbook.io/docs/integration/transfer-api/deposit-withdraw-user-balance.md) - \[Reset User Balance\](https://ggr.gitbook.io/docs/integration/transfer-api/reset-user-balance.md): Withdraws the full balance from a user (or all users) and returns it to the agent. Used in Transfer mode. - \[Transfer Status\](https://ggr.gitbook.io/docs/integration/transfer-api/transfer-status.md): Checks the status of a previous deposit or withdraw transaction by \\\`agent\\\_sign\\\`. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/integration/transfer-api.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/integration/rtp-api/control-users-rtp.md). # Control Users RTP Sets the target RTP for multiple users in one request. ### Endpoint \`\`\` POST https://{API\_SERVER} \`\`\` \*\*Content-Type:\*\* \`application/json\` ### Request \*\*Method:\*\* \`control\_users\_rtp\` \`\`\`json { "method": "control\_users\_rtp", "agent\_code": "your\_agent\_code", "agent\_token": "your\_agent\_token", "user\_codes": "\[\\"test1\\",\\"test2\\"\]", "rtp": 92 } \`\`\`
FieldTypeRequiredDescription
methodstringYesMust be control\_users\_rtp
agent\_codestringYesYour agent code
agent\_tokenstringYesYour agent API token
user\_codesstringYesStringified JSON array of user codes
rtpnumberYesTarget RTP value (0 ~ 999)
> \`user\_codes\` must be a \*\*stringified JSON array\*\*, not a native JSON array. ### Response #### Success \`\`\`json { "status": 1, "changed\_rtp": 92 } \`\`\` #### Failure \`\`\`json { "status": 0, "msg": "Invalid JSON" } \`\`\` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/integration/rtp-api/control-users-rtp.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/integration/transfer-api/transfer-status.md). # Transfer Status Checks the status of a previous deposit or withdraw transaction by \\\`agent\\\_sign\\\`. ### Endpoint \`\`\` POST https://{API\_SERVER} \`\`\` \*\*Content-Type:\*\* \`application/json\` ### Request \*\*Method:\*\* \`transfer\_status\` \`\`\`json { "method": "transfer\_status", "agent\_code": "your\_agent\_code", "agent\_token": "your\_agent\_token", "user\_code": "test", "agent\_sign": "UNIQUE\_ID" } \`\`\`
FieldTypeRequiredDescription
methodstringYesMust be transfer\_status
agent\_codestringYesYour agent code
agent\_tokenstringYesYour agent API token
user\_codestringYesTarget user
agent\_signstringYesUnique ID from the original deposit/withdraw request
### Response #### Success \`\`\`json { "status": 1, "msg": "SUCCESS", "amount": 10000, "agent\_balance": 990000, "user\_balance": 10000, "type": "user\_deposit" } \`\`\` #### Failure \`\`\`json { "status": 0, "msg": "NOT FOUND" } \`\`\` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/integration/transfer-api/transfer-status.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/integration/transfer-api/reset-user-balance.md). # Reset User Balance Withdraws the full balance from a user (or all users) and returns it to the agent. Used in Transfer mode. ### Endpoint \`\`\` POST https://{API\_SERVER} \`\`\` \*\*Content-Type:\*\* \`application/json\` ### Request \*\*Method:\*\* \`user\_withdraw\_reset\` #### Single user \`\`\`json { "method": "user\_withdraw\_reset", "agent\_code": "your\_agent\_code", "agent\_token": "your\_agent\_token", "user\_code": "test" } \`\`\` #### All users \`\`\`json { "method": "user\_withdraw\_reset", "agent\_code": "your\_agent\_code", "agent\_token": "your\_agent\_token", "all\_users": true } \`\`\`
FieldTypeRequiredDescription
methodstringYesMust be user\_withdraw\_reset
agent\_codestringYesYour agent code
agent\_tokenstringYesYour agent API token
user\_codestringConditionalRequired when resetting a single user
all\_usersbooleanNoWhen true, resets all users
### Response #### Success — single user \`\`\`json { "status": 1, "msg": "SUCCESS", "agent": { "agent\_code": "your\_agent\_code", "balance": 1000000 }, "user": { "user\_code": "test", "withdraw\_amount": 5600, "balance": 0 } } \`\`\` #### Success — all users \`\`\`json { "status": 1, "msg": "SUCCESS", "agent": { "agent\_code": "your\_agent\_code", "balance": 1076850 }, "user\_list": \[\ {\ "user\_code": "test",\ "withdraw\_amount": 20000,\ "balance": 0\ },\ {\ "user\_code": "test2",\ "withdraw\_amount": 56850,\ "balance": 0\ }\ \] } \`\`\` #### Failure \`\`\`json { "status": 0, "msg": "INVALID\_PARAMETER" } \`\`\` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/integration/transfer-api/reset-user-balance.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/integration/freespin-tour-api/cancel-tour.md). # Cancel Tour Ends a running free tour early. Use the \`tour\_id\` you sent to \*\*Create Free Tour\*\*. > \*\*\`PRAGMATIC\` only for now\*\*, like \*\*Create Free Tour\*\* — there are no tours on other providers to cancel. ### Endpoint \`\`\` POST https://{API\_SERVER} \`\`\` \*\*Content-Type:\*\* \`application/json\` ### Request \*\*Method:\*\* \`tour\_cancel\` \`\`\`json { "method": "tour\_cancel", "agent\_code": "your\_agent\_code", "agent\_token": "your\_agent\_token", "tour\_id": "free\_tour\_777" } \`\`\` | Field | Type | Required | Description | | ------------- | ------ | -------- | ----------------------------------- | | \`method\` | string | Yes | Must be \`tour\_cancel\` | | \`agent\_code\` | string | Yes | Your agent code | | \`agent\_token\` | string | Yes | Your agent API token | | \`tour\_id\` | string | Yes | The \`tour\_id\` of the tour to cancel | ### Response #### Success \`\`\`json { "status": 1, "tour\_id": "free\_tour\_777", "user\_code": "test", "provider\_code": "PRAGMATIC", "game\_code": "vs20doghouse", "rest\_count": 6, "total\_win": 21400, "canceled\_money": 42950, "msg": "SUCCESS" } \`\`\` | Field | Type | Description | | ---------------- | ------- | -------------------------------------------------------- | | \`rest\_count\` | integer | Free rounds the user never got to play | | \`total\_win\` | number | What the tour had already paid the user | | \`canceled\_money\` | number | Returned to your agent balance: \`real\_win\` − \`total\_win\` | The user keeps what the tour already paid. Only the part that was never played is given back. #### Failure \`\`\`json { "status": 0, "msg": "There is no running tour." } \`\`\` \`\`\`json { "status": 0, "msg": "External Error", "detail": "TOUR\_IN\_PROGRESS" } \`\`\` | \`detail\` | Description | | ------------------ | ------------------------------------------------------------------------------------------------------------------------- | | \`TOUR\_NOT\_FOUND\` | The game server has no such tour, or it already ended | | \`TOUR\_IN\_PROGRESS\` | A free round is being played right now. Cancelling mid-round would turn it into a paid one — retry once the round is over | A tour can only be canceled once. \`There is no running tour.\` also comes back for a tour that was already canceled. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/integration/freespin-tour-api/cancel-tour.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/integration/game-api/agent-and-user-info.md). # Agent & User Info This is an API endpoint used to retrieve the balance information for a specific agent. ## \*\*Endpoint\*\* \`\`\` POST https://{API\_SERVER} \`\`\` ## \*\*Agent Info\*\* ### \*\*Request Body\*\* {% code fullWidth="false" %} \`\`\`json { "method": "money\_info", "agent\_code": "testAgent", "agent\_token": "41f5cc794aef2b138c715cf25f767cc1" } \`\`\` {% endcode %}
KeyTypeDescription
methodstringThe method type (money\_info)
agent\_codestringThe agent's code
agent\_tokenstringThe agent's authentication token
### \*\*Success Response Example\*\* \`\`\`json { "status": 1, "msg": "SUCCESS", "agent": { "agent\_code": "testAgent", "balance": 1000000 } } \`\`\` ### \*\*Failure Response Example\*\* \`\`\`json { "status": 0, "msg": "INVALID\_PARAMETER" } \`\`\` \*\*\* ## \*\*User Info\*\* ### \*\*Request Body\*\* {% code fullWidth="false" %} \`\`\`json { "method": "money\_info", "agent\_code": "testAgent", "agent\_token": "41f5cc794aef2b138c715cf25f767cc1", "user\_code": "testUser" } \`\`\` {% endcode %}
KeyTypeDescription
methodstringThe method type (money\_info)
agent\_codestringThe agent's code
agent\_tokenstringThe agent's authentication token
user\_codestringThe user's code
### \*\*Success Response Example\*\* \`\`\`json { "status": 1, "msg": "SUCCESS", "agent": { "agent\_code": "testAgent", "balance": 1000000, }, "user": { "user\_code": "testUser", "balance": 100000, } } \`\`\` ### \*\*Failure Response Example\*\* \`\`\`json { "status": 0, "msg": "INVALID\_PARAMETER" } \`\`\` \*\*\* ## \*\*All Users Info\*\* ### \*\*Request Body\*\* {% code fullWidth="false" %} \`\`\`json { "method": "money\_info", "agent\_code": "testAgent", "agent\_token": "41f5cc794aef2b138c715cf25f767cc1", "all\_users": true } \`\`\` {% endcode %}
KeyTypeDescription
methodstringThe method type (game\_list)
agent\_codestringThe agent's code
agent\_tokenstringThe agent's authentication token
all\_usersbooleantrue
### \*\*Success Response Example\*\* \`\`\`json { "status": 1, "msg": "SUCCESS", "agent": { "agent\_code": "testAgent", "balance": 99550000 }, "user\_list": \[\ {\ "user\_code": "testUser1",\ "balance": 450000\ },\ {\ "user\_code": "testUser2",\ "balance": 20000\ }\ \] } \`\`\` ### \*\*Failure Response Example\*\* \`\`\`json { "status": 0, "msg": "INVALID\_PARAMETER" } \`\`\` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/integration/game-api/agent-and-user-info.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/integration/rtp-api/control-user-rtp.md). # Control User RTP Sets the target RTP for a specific user on a provider. ### Endpoint \`\`\` POST https://{API\_SERVER} \`\`\` \*\*Content-Type:\*\* \`application/json\` ### Request \*\*Method:\*\* \`control\_rtp\` \`\`\`json { "method": "control\_rtp", "agent\_code": "your\_agent\_code", "agent\_token": "your\_agent\_token", "provider\_code": "PRAGMATIC", "user\_code": "test", "rtp": 92 } \`\`\`
FieldTypeRequiredDescription
methodstringYesMust be control\_rtp
agent\_codestringYesYour agent code
agent\_tokenstringYesYour agent API token
provider\_codestringYesGame provider code
user\_codestringYesTarget user
rtpnumberYesTarget RTP value (0 ~ 999)
### Response #### Success \`\`\`json { "status": 1, "changed\_rtp": 92 } \`\`\` #### Failure \`\`\`json { "status": 0, "msg": "Invalid Parameter.", "detail": "rtp must be less than or equal to 999" } \`\`\` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/integration/rtp-api/control-user-rtp.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/integration/call-api.md). # CALL API - \[Current Playing Users\](https://ggr.gitbook.io/docs/integration/call-api/current-playing-users.md): Returns users currently playing slot games under your agent. - \[Call List\](https://ggr.gitbook.io/docs/integration/call-api/call-list.md): Returns available call (free spin) options for a specific provider and game. - \[Call Apply\](https://ggr.gitbook.io/docs/integration/call-api/call-apply.md): Applies a call (bonus) to a user in a specific game. Use call\\\_rtp from the Get Call List response. - \[Call Cancel\](https://ggr.gitbook.io/docs/integration/call-api/call-cancel.md): Cancels a waiting call. Use call\\\_id from the Get Call History response. - \[Call History\](https://ggr.gitbook.io/docs/integration/call-api/call-history.md): Returns paginated call history for your agent. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/integration/call-api.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/integration/call-api/call-list.md). # Call List Returns available call (free spin) options for a specific provider and game. ### Endpoint \`\`\` POST https://{API\_SERVER} \`\`\` \*\*Content-Type:\*\* \`application/json\` ### Request \*\*Method:\*\* \`call\_list\` \`\`\`json { "method": "call\_list", "agent\_code": "your\_agent\_code", "agent\_token": "your\_agent\_token", "provider\_code": "PRAGMATIC", "game\_code": "vs20doghouse" } \`\`\`
FieldTypeRequiredDescription
methodstringYesMust be call\_list
agent\_codestringYesYour agent code
agent\_tokenstringYesYour agent API token
provider\_codestringYesGame provider code
game\_codestringYesGame identifier
### Response #### Success \`\`\`json { "status": 1, "calls": \[\ {\ "rtp": 75615,\ "call\_type": "Free"\ },\ {\ "rtp": 62185,\ "call\_type": "Free"\ },\ {\ "rtp": 45010,\ "call\_type": "Free"\ }\ \] } \`\`\`
FieldDescription
rtpRTP value — use this in Call Apply as call\_rtp
call\_typeCall type label
#### Failure \`\`\`json { "status": 0, "msg": "External Error" } \`\`\` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/integration/call-api/call-list.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/integration/call-api/call-cancel.md). # Call Cancel Cancels a waiting call. Use call\\\_id from the Get Call History response. ### Endpoint \`\`\` POST https://{API\_SERVER} \`\`\` \*\*Content-Type:\*\* \`application/json\` ### Request \*\*Method:\*\* \`call\_cancel\` \`\`\`json { "method": "call\_cancel", "agent\_code": "your\_agent\_code", "agent\_token": "your\_agent\_token", "call\_id": 109 } \`\`\`
FieldTypeRequiredDescription
methodstringYesMust be call\_cancel
agent\_codestringYesYour agent code
agent\_tokenstringYesYour agent API token
call\_idnumberYesCall ID from Get Call History
### Response #### Success \`\`\`json { "status": 1, "canceled\_money": 720160, "msg": "SUCCESS" } \`\`\` #### Failure \`\`\`json { "status": 0, "msg": "There is no waiting call." } \`\`\` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/integration/call-api/call-cancel.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/integration/game-api/in-game-history.md). # In-Game History Returns a provider-hosted URL where you can view a player's game history for a specific game. Unlike \`get\_game\_log\`, this does not return transaction records directly — it returns a link to the provider's history page. > \*\*Availability:\*\* Currently supported for \*\*Pragmatic Play Slot\*\* only (\`provider\_code\`: \`PRAGMATIC\`). Other providers will return \`INVALID\_PROVIDER\`. ### Endpoint \`\`\` POST https://{API\_SERVER} \`\`\` \*\*Content-Type:\*\* \`application/json\` ### Request \*\*Method:\*\* \`get\_game\_history\` \`\`\`json { "method": "get\_game\_history", "agent\_code": "your\_agent\_code", "agent\_token": "your\_agent\_token", "user\_code": "test", "provider\_code": "PRAGMATIC", "game\_code": "vs20doghouse" } \`\`\`
FieldTypeRequiredDescription
methodstringYesMust be get\_game\_history
agent\_codestringYesYour agent code
agent\_tokenstringYesYour agent API token
user\_codestringYesPlayer identifier
provider\_codestringYesMust be PRAGMATIC (Pragmatic Play Slot only)
game\_codestringYesPragmatic Play slot game code (e.g. vs20doghouse)
### Response #### Success \`\`\`json { "status": 1, "msg": "SUCCESS", "history\_url": "https://game-server.example.com/gs2c/lastGameHistory.do?symbol=vs20doghouse&mgckey=..." } \`\`\` | Field | Description | | ------------- | ----------------------------------------------------------- | | \`history\_url\` | URL to open the provider's game history page for the player | #### Failure \*\*Invalid provider (not Pragmatic Play Slot):\*\* \`\`\`json { "status": 0, "msg": "INVALID\_PROVIDER" } \`\`\` \*\*External provider error:\*\* \`\`\`json { "status": 0, "msg": "EXTERNAL\_ERROR : INVALID\_GAME" } \`\`\` \*\*Internal error:\*\* \`\`\`json { "status": 0, "msg": "INTERNAL\_ERROR" } \`\`\` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/integration/game-api/in-game-history.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/integration/seamless-api/transaction-site-endpoint.md). # Transaction (Site Endpoint) Called when a bet or win occurs. Your backend must update the user balance and return the updated value. ## Endpoint \`\`\` POST https://{YOUR\_SITE}/gold\_api \`\`\` \*\*Content-Type:\*\* \`application/json\` \*\*Method:\*\* \`transaction\` ## Request ### Slot transaction \`\`\`json { "method": "transaction", "agent\_code": "your\_agent\_code", "agent\_secret": "your\_agent\_secret", "agent\_balance": 10000000, "user\_code": "test", "user\_token": "c3041c6d9146a164387fa454eff7b432", "user\_balance": 99200, "game\_type": "slot", "slot": { "provider\_code": "PRAGMATIC", "game\_code": "vs20midas", "type": "BASE", "bet\_money": 1000, "win\_money": 200, "round\_id": 63792613432127, "txn\_id": "63792613432127", "txn\_id\_v2": "64a83f2fc597acc9004eec52c3f84c30", "txn\_type": "debit\_credit" } } \`\`\` ### Live transaction \`\`\`json { "method": "transaction", "agent\_code": "your\_agent\_code", "agent\_secret": "your\_agent\_secret", "agent\_balance": 10000000, "user\_code": "test", "user\_token": "c3041c6d9146a164387fa454eff7b432", "user\_balance": 102000, "game\_type": "live", "info": "{\\"gameresult\\":{\\"pp\\":\\"0.0\\",\\"bb\\":\\"0.0\\",\\"gameType\\":\\"baccarat\\",\\"perfectPair\\":\\"false\\",\\"banker\_pair\\":\\"false\\",\\"code\\":\\"0\\",\\"bighand\\":\\"false\\",\\"bg\\":\\"0.0\\",\\"player\_pair\\":\\"false\\",\\"bp\\":\\"0.0\\",\\"result\\":\\"player\\",\\"score\\":\\"8\\",\\"bnc\\":\\"0.0\\",\\"sm\\":\\"2.5\\",\\"id\\":\\"15676627318\\",\\"table\\":\\"pwnhicogrzeodk79\\",\\"eitherPair\\":\\"false\\",\\"gameId\\":\\"15676627318\\",\\"b\\":\\"0.0\\",\\"s6\\":\\"0.0\\",\\"natural\\":\\"true\\",\\"playerBonus\\":\\"true\\",\\"pnc\\":\\"2.0\\",\\"ep\\":\\"0.0\\",\\"bankerBonus\\":\\"false\\",\\"prp\\":\\"0.0\\",\\"p\\":\\"2.0\\",\\"pb\\":\\"2.0\\",\\"t\\":\\"0.0\\",\\"super6\\":\\"false\\",\\"time\\":\\"00:40:15\\",\\"smallhand\\":\\"true\\",\\"seq\\":2304,\\"value\\":\\"player\\"}}", "live": { "provider\_code": "EVOLUTION", "game\_code": "100", "type": "baccarat", "bet\_money": 2000, "win\_money": 4000, "round\_id": 15676627318, "txn\_id": "15676627318", "txn\_id\_v2": "b7e12d4a8f0c4519a2d6e3b81f5c9047", "txn\_type": "debit\_credit" } } \`\`\` ### Sportsbook transaction \`\`\`json { "method": "transaction", "agent\_code": "your\_agent\_code", "agent\_secret": "your\_agent\_secret", "agent\_balance": 10000000, "user\_code": "test", "user\_token": "c3041c6d9146a164387fa454eff7b432", "user\_balance": 102000, "game\_type": "SB", "info": "{\\"couponCode\\":\\"000000561435\\",\\"status\\":\\"pending\\",\\"totalOdds\\":3.73,\\"potentialWin\\":18.64,\\"stake\\":5,\\"payout\\":0,\\"betslips\\":\[{\\"id\\":120,\\"sportName\\":\\"Football\\",\\"countryName\\":\\"World\\",\\"leagueName\\":\\"Club Friendlies\\",\\"matchName\\":\\"Odds - Stromsgodset\\",\\"homeTeam\\":\\"Odds\\",\\"awayTeam\\":\\"Stromsgodset\\",\\"marketName\\":\\"1X2\\",\\"oddName\\":\\"W1\\",\\"oddRate\\":1.46,\\"oddPoint\\":\\"696729566|1|1|0\\"}\],\\"settlementData\\":{}}", "SB": { "provider\_code": "SPORTSBOOK", "game\_code": "SPORTSBOOK", "type": "accumulator", "bet\_money": 5, "win\_money": 0, "round\_id": 561435, "txn\_id": "561435", "txn\_id\_v2": "44097c196a8b59b7371ee2ca6fe83999", "txn\_type": "debit" } } \`\`\` ### Mini game (MN) transaction \`\`\`json { "method": "transaction", "agent\_code": "your\_agent\_code", "agent\_secret": "your\_agent\_secret", "agent\_balance": 10000000, "user\_code": "test", "user\_token": "c3041c6d9146a164387fa454eff7b432", "user\_balance": 99200, "game\_type": "MN", "MN": { "provider\_code": "SPRIBE", "game\_code": "minigame\_01", "type": "BASE", "bet\_money": 1000, "win\_money": 200, "round\_id": 123456789, "txn\_id": "123456789", "txn\_id\_v2": "3f0a6c1de95b47829c04a7be2d18f635", "txn\_type": "debit\_credit" } } \`\`\` ### Game object fields \*\*Important:\*\* The game detail object key \*\*must match\*\* the \`game\_type\` value. > Example: if \`"game\_type": "slot"\`, the payload must include a \`"slot": { ... }\` object. If \`"game\_type": "SB"\`, use \`"SB": { ... }\`. | game\\\_type | Provider Type | | ---------- | ------------- | | \`slot\` | Slot | | \`live\` | Live Casino | | \`SB\` | Sportsbook | | \`MN\` | Mini Game | | \`FT\` | Fish | Fields inside the game object (\`slot\` / \`live\` / \`SB\` / \`MN\`):
FieldTypeRequiredDescription
provider\_codestringYesGame provider code
game\_codestringYesGame identifier
typestringYesBet/round type (e.g. BASE, baccarat)
bet\_moneynumberYesBet amount
win\_moneynumberYesWin amount
round\_idintegerYesUnique ID for one bet. Every transaction the bet produces shares it
txn\_idstringYes

The round\_id as a string.

Starting October 15, 2026 (UTC):
txn\_id will use the same value as txn\_id\_v2.

txn\_id\_v2stringYesUnique per inner spin of one bet. Deduplicate on this field. txn\_id\_v2 will be deprecated on October 31, 2026 (UTC).
txn\_typestringYesdebit, credit, or debit\_credit
> \*\*\`round\_id\` and \`txn\_id\_v2\`\*\* > > One bet is not always one payout. A bet can play out over several \*\*inner spins\*\* — tumbling wins, free game rounds, the closing collect — and every one of them is sent as its own transaction. > > \* \`round\_id\` — one bet (integer). Every transaction that bet produces carries the same value. > \* \`txn\_id\_v2\` — unique per inner spin (string). No two transactions ever share it. > > \*\*Deduplicate on \`txn\_id\_v2\`.\*\* \`round\_id\` is unique per \*bet\*, not per transaction, so treating it as an idempotency key makes your site drop the win of a round it already booked the bet for. ### Live / Sportsbook \`info\` field The \`info\` field (top-level, for live and sportsbook) is a \*\*stringified JSON\*\* object with bet/result details. \*\*Sportsbook \`info\` fields:\*\* | Field | Description | | ---------------- | ---------------------------------------------------------------------------------------------------------------------------- | | \`couponCode\` | Bet coupon code | | \`status\` | \`pending\`, \`won\`, \`lost\`, \`cashedout\`, or \`canceled\` | | \`totalOdds\` | Combined odds | | \`potentialWin\` | Potential payout | | \`stake\` | Bet stake | | \`payout\` | Actual payout | | \`betslips\` | Array of \`{ id, sportName, countryName, leagueName, matchName, homeTeam, awayTeam, marketName, oddName, oddRate, oddPoint }\` | | \`settlementData\` | Settlement details object | ## Transaction Type Reference \`txn\_type\` values: \`debit\`, \`credit\`, \`debit\_credit\` | Type | Description | \`bet\_money\` | \`win\_money\` | | -------------- | ----------------------- | ------------------- | ------------------- | | \`debit\` | Only send bet amount | Valid | Invalid (don't use) | | \`credit\` | Only send win amount | Invalid (don't use) | Valid | | \`debit\_credit\` | Send bet and win amount | Valid | Valid | ### Txn examples One bet (\`round\_id\`, and the \`txn\_id\` mirroring it) can produce several transactions, each with its own \`txn\_id\_v2\`. \`\`\`json // debit — bet only { "txn\_type": "debit", "bet\_money": 2000, "win\_money": 0, "round\_id": 123456789, "txn\_id": "123456789", "txn\_id\_v2": "64a83f2fc597acc9004eec52c3f84c30" } // credit — win of an inner spin (same round\_id and txn\_id, new txn\_id\_v2) { "txn\_type": "credit", "bet\_money": 0, "win\_money": 1500, "round\_id": 123456789, "txn\_id": "123456789", "txn\_id\_v2": "5c81b0af73e2496db1fa08c6d437e9a2" } // credit — win of the next inner spin of that same bet { "txn\_type": "credit", "bet\_money": 0, "win\_money": 400, "round\_id": 123456789, "txn\_id": "123456789", "txn\_id\_v2": "e04fd920a1b74c8fb2c3576ad8e1490f" } // debit\_credit — the next bet, settled in one transaction { "txn\_type": "debit\_credit", "bet\_money": 2000, "win\_money": 1500, "round\_id": 123456790, "txn\_id": "123456790", "txn\_id\_v2": "a1b2c3d4e5f6789012345678abcdef01" } \`\`\` ## Response ### Success Must return the updated user balance: \`\`\`json { "status": 1, "user\_balance": 1000 } \`\`\` ### Failure \`\`\`json { "status": 0, "msg": "INSUFFICIENT\_USER\_FUNDS" } \`\`\` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/integration/seamless-api/transaction-site-endpoint.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/integration/freespin-tour-api/create-tour.md). # Create Tour Grants a user a bundle of free rounds (a "free tour") on one slot game. The whole tour is laid out in advance when it is created, so the response already tells you what it will pay. Only one tour can run per user and game at a time — the previous one has to finish, expire or be canceled first. > \*\*\`PRAGMATIC\` only for now.\*\* Free tours are supported on Pragmatic games and nowhere else yet. Sending \`tour\_create\` for any other \`provider\_code\` fails, since that provider's game server has no tour to create. More providers are planned. ### Endpoint \`\`\` POST https://{API\_SERVER} \`\`\` \*\*Content-Type:\*\* \`application/json\` ### Request \*\*Method:\*\* \`tour\_create\` \`\`\`json { "method": "tour\_create", "agent\_code": "your\_agent\_code", "agent\_token": "your\_agent\_token", "user\_code": "test", "provider\_code": "PRAGMATIC", "game\_code": "vs20doghouse", "bet\_level": 1, "spin\_count": 10, "amount": 70000, "expiration\_time": "2026-02-26T06:46:04.000Z", "tour\_id": "free\_tour\_777" } \`\`\` | Field | Type | Required | Description | | ----------------- | -------- | -------- | --------------------------------------------------------------------------------------------------- | | \`method\` | string | Yes | Must be \`tour\_create\` | | \`agent\_code\` | string | Yes | Your agent code | | \`agent\_token\` | string | Yes | Your agent API token | | \`user\_code\` | string | Yes | Target user | | \`provider\_code\` | string | Yes | Game provider code | | \`game\_code\` | string | Yes | Game identifier | | \`bet\_level\` | integer | Yes | Index into the game's bet range: \`1\` = minimum bet, \`2\` = the next one, and so on | | \`spin\_count\` | integer | Yes | Number of free rounds. \`1\` – \`1000\` | | \`amount\` | number | Yes | Max win of the whole tour, in your currency. At least the equivalent of 7 USD at your currency rate | | \`expiration\_time\` | datetime | Yes | When the tour stops being playable. Must be in the future | | \`tour\_id\` | string | Yes | Your own identifier for the tour, 1 – 36 characters. It comes back in the later callbacks | > \*\*\`amount\` is a ceiling, not a target.\*\* The tour is shaped like an ordinary session — only a few of its rounds pay — so what it really pays out is usually below \`amount\`. That figure comes back as \`real\_win\`. ### Response #### Success \`\`\`json { "status": 1, "tour\_id": "free\_tour\_777", "user\_code": "test", "provider\_code": "PRAGMATIC", "game\_code": "vs20doghouse", "bet\_level": 1, "bet": 100, "total\_bet": 2000, "spin\_count": 10, "amount": 70000, "real\_win": 64350, "expiration\_time": "2026-02-26T06:46:04.000Z", "msg": "SUCCESS" } \`\`\` | Field | Type | Description | | ----------- | ------ | ----------------------------------------------------- | | \`bet\` | number | Coin bet of one line at \`bet\_level\` | | \`total\_bet\` | number | Bet of one free round (\`bet\` × the game's pay lines) | | \`real\_win\` | number | What the prepared rounds actually pay, up to \`amount\` | \*\*Balance:\*\* \`real\_win\` is deducted from your agent balance the moment the tour is created, and the unplayed part comes back if you cancel it. Your balance still has to cover the full \`amount\` at creation time, before \`real\_win\` is known. #### Failure \`\`\`json { "status": 0, "msg": "Duplicated Tour Id." } \`\`\` \`\`\`json { "status": 0, "msg": "External Error", "detail": "INVALID\_BET\_LEVEL" } \`\`\` \`External Error\` means the game server refused the tour. \`detail\` says why: | \`detail\` | Description | | ------------------------- | -------------------------------------------------------- | | \`INVALID\_GAME\` | The game does not exist or has no pay lines | | \`PO\_GAME\` | The game is switched off | | \`INVALID\_BET\_LEVEL\` | \`bet\_level\` is above the game's highest bet | | \`INVALID\_SPIN\_COUNT\` | \`spin\_count\` is outside \`1\` – \`1000\` | | \`INVALID\_AMOUNT\` | \`amount\` is below the 7 USD equivalent for your currency | | \`INVALID\_EXPIRATION\_TIME\` | \`expiration\_time\` is missing or already past | | \`INVALID\_TOUR\_ID\` | \`tour\_id\` is longer than 36 characters | | \`DUPLICATED\_TOUR\_ID\` | The game server already knows this \`tour\_id\` | | \`TOUR\_IN\_PROGRESS\` | This user still has a playable tour on this game | | \`NO\_PATTERN\_DATA\` | The game has no round data to build a tour from | A refused tour is not recorded, so the same \`tour\_id\` can be used again once the cause is fixed. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/integration/freespin-tour-api/create-tour.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/integration/call-api/call-history.md). # Call History Returns paginated call history for your agent. ### Endpoint \`\`\` POST https://{API\_SERVER} \`\`\` \*\*Content-Type:\*\* \`application/json\` ### Request \*\*Method:\*\* \`call\_history\` \`\`\`json { "method": "call\_history", "agent\_code": "your\_agent\_code", "agent\_token": "your\_agent\_token", "offset": 0, "limit": 100 } \`\`\`
FieldTypeRequiredDescription
methodstringYesMust be call\_history
agent\_codestringYesYour agent code
agent\_tokenstringYesYour agent API token
offsetnumberYesPagination offset (starting index)
limitnumberYesNumber of records to return
### Response #### Success \`\`\`json { "status": 1, "data": \[\ {\ "id": 93,\ "agent\_code": "your\_agent\_code",\ "user\_code": "test",\ "provider\_code": "PRAGMATIC",\ "game\_code": "vs20doghouse",\ "bet": 1600,\ "user\_prev": null,\ "user\_after": null,\ "agent\_prev": 901200,\ "agent\_after": 181040,\ "expect": 720160,\ "missed": 720160,\ "real": 0,\ "rtp": 45010,\ "type": "common",\ "status": 0,\ "msg": null,\ "created\_at": "2023-02-23T04:02:45.000Z",\ "updated\_at": "2023-02-23T04:02:46.000Z"\ }\ \] } \`\`\` #### Failure \`\`\`json { "status": 0, "msg": "Invalid Agent." } \`\`\` ### Call Status Reference
StatusMeaning
0Waiting
1Processing
2Finished
3Rejected by game server (bet amount changed)
4Canceled (via Cancel API or back-office button)
### Expect, Missed, and Real Money
FieldDescription
expectAmount reserved when the admin applies the call (e.g. 1000)
realAmount the user actually received (e.g. 800)
missedDifference returned to the admin (expect − real, e.g. 200)
#### Why missed money? Some Pragmatic Play games with free-option mechanics (e.g. 5 Lions Megaways, The Dog House Megaways, Wild Booster) may not deliver the full expected payout. Unused funds are returned to the agent. ### Status Examples #### Waiting (\`status: 0\`) \`\`\`json { "id": 93, "status": 0, "expect": 720160, "missed": 720160, "real": 0, "msg": null } \`\`\` #### Processing (\`status: 1\`) \`\`\`json { "id": 94, "status": 1, "msg": "Processing" } \`\`\` #### Finished (\`status: 2\`) \`\`\`json { "id": 95, "status": 2, "expect": 2000, "missed": 0, "real": 2000, "msg": "Finished" } \`\`\` #### Rejected — bet changed (\`status: 3\`) \`\`\`json { "id": 106, "status": 3, "msg": "Rejected (callBet = 2000, currentBet = 1600)}" } \`\`\` #### Canceled (\`status: 4\`) \`\`\`json { "id": 107, "status": 4, "msg": "Canceled by User" } \`\`\` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/integration/call-api/call-history.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://ggr.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://ggr.gitbook.io/docs/integration/transfer-api/deposit-withdraw-user-balance.md). # Deposit / Withdraw User Balance ## End\*\*point\*\* \`\`\` POST https://{API\_SERVER} \`\`\` ## \*\*Request Body\*\* 
{
    "method": "user\_deposit",
    "agent\_code": "testAgent",
    "agent\_token": "c3041c6d9146a164387fa454eff7b432",
    "user\_code": "test",
    "amount": 10000.00,
    "agent\_sign"："UNIQUE\_ID"   // Optional to prevent duplicated
}
\`\`\`json { "method": "user\_withdraw", "agent\_code": "testAgent", "agent\_token": "c3041c6d9146a164387fa454eff7b432", "user\_code": "test", "amount": 10000.00, "agent\_sign"："UNIQUE\_ID" // Optional to prevent duplicated } \`\`\`
KeyTypeDescription
methodstringAPI method name. For balance transfer to a user game wallet, the value must be user\_deposit or user\_withdraw.
agent\_codestringUnique agent identifier provided by NEXUS. Used to identify which agent is sending the request.
agent\_tokenstringSecret authentication token assigned to the agent. Used for API authentication and request validation.
user\_codestringUnique user identifier within the agent’s platform. This user will receive the transferred balance.
amountdoubleAmount to transfer from the agent balance to the user API balance. Supports up to 2 digits after the decimal point. Example: 10000.00
agent\_signstringOptional unique request identifier used to prevent duplicated requests. Recommended for transaction safety and idempotency handling. Example: UUID, hash string, timestamp-based unique value.
## \*\*Response Example\*\* \`\`\`json { "status": 1, "msg": "SUCCESS", "agent\_balance": 990000, "user\_balance": 10000 } \`\`\` \`\`\`json { "status": 0, "msg": "INSUFFICIENT\_AGENT\_FUNDS" / "INSUFFICIENT\_USER\_FUNDS" } \`\`\`
FieldTypeDescription
statusintRequest processing status. 1 indicates success, while 0 indicates failure.
msgstringResponse message describing the result of the request. Example: SUCCESS: "INSUFFICIENT\_AGENT\_FUNDS".
agent\_balancedoubleRemaining balance of the agent after the transaction has been processed successfully. Supports up to 2 digits after the decimal point.
user\_balancedoubleUpdated API balance of the user after the transaction has been completed successfully. Supports up to 2 digits after the decimal point.
--- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://ggr.gitbook.io/docs/integration/transfer-api/deposit-withdraw-user-balance.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Providers | Casino API For the complete documentation index, see [llms.txt](https://ggr.gitbook.io/docs/llms.txt) . This page is also available as [Markdown](https://ggr.gitbook.io/docs/appendix/providers.md) . No Provider Code Provider Name Type Status 1 EVOLUTION Evolution Live live Maintenance 2 **PP\_LIVE\_PRO** Pragmatic Play Live live Online 3 SPORTSBOOK Nexustrike SB Online 4 **PRAGMATIC** Pragmatic Slot slot Online 5 **PGSOFT** PGSoft slot Online 6 **HABANERO** Habanero slot Online 7 **BOOONGO** Booongo slot Online 8 **PLAYSON** Playson slot Online 9 **CQ9** CQ9 slot Online 10 **EVOPLAY** Evoplay slot Online 11 **TOPTREND** TopTrend slot Online 12 **DREAMTECH** DreamTech slot Online 13 **SPRIBE** Spribe MN Online 14 **HACKSAW** Hacksaw slot Online 15 FACHAI FaChai slot Online 16 PLAYNGO Play'n Go slot Online 17 AMUSNET Amusnet slot Online 18 EGT EGT Digital slot Online 19 SPADEGAMING Spadegaming slot Online 20 FASTSPIN FastSpin slot Online 21 JOKERGAMING Joker Gaming slot Online 22 RUBYPLAY RubyPlay slot Online 23 AMATIC Amatic slot Online 24 FISHHUNTER Fish Hunter FH Online 25 NEXTSPIN Next Spin slot Online [PreviousRate Limit](https://ggr.gitbook.io/docs/integration/rate-limit) [NextLanguages](https://ggr.gitbook.io/docs/appendix/languages) Last updated 27 days ago Was this helpful? ---