Provider - 3rd party provider that integrates this API to make its game content available for players through Aggregator.
\nAggregator - aggregator that provides API for integrating Provider's content.
\napiUrl - API endpoint URL
IPs to whitelist
\nbrandId - unique brand identifier where Provider's games will be available. Can be used for custom RTP settings, game lists, etc.
provider - unique Provider identifier in Aggregator's system
API credentials (apiUsername, apiPassword)
IPs to whitelist
\nNote: API credentials and URLs may differ for each provider + brandId combination.
Date and Time are passed in Unix Timestamp using UTC timezone - number of milliseconds from the epoch of 1970-01-01T00:00:00Z.
Examples: 2024-03-15T11:42:03+00:00 = '1710499323000'
User's locale should be passed in ISO-639 + '_' + ISO-3166 format.
Examples: en_US, ru_RU, de_DE
Money amount is passed as bigdecimal.
Examples: 10.00, 150.50, 0.25, 144.39999
Currency is passed as string (ISO 4217).
Examples: EUR, USD, TRY
Each request between Provider and Aggregator must contain basic auth header.
Example for username 'name' and password 'password':
Authorization: Basic bmFtZTpwYXNzd29yZA==
Loads the provider's game catalog.
\nObject:
\ncurrencies (array, required) - List of requested currencies
jurisdiction (object, required) - Jurisdiction information
type (enum, required) - Jurisdiction type. Values: 'NOT_APPLICABLE'Object:
\ngames (array, required) - List of games
id (string, required) - Game identifier
name (string, required) - Game name
demoAvailable (boolean, required) - Demo mode availability
rtp (number, required) - Return to player percentage
tag (string, required) - Game category tag (see Available Tags below)
provider (string, required) - Sub-provider identifier. Used by aggregators to display games from multiple providers separately. Game IDs are expected to be unique within a provider. Example: your provider is green-studio, sub-provider is yellow-studio
betSizes (object, required) - Bet amount sizes per currency. Note: this is the actual bet amount, not coin value. Example: if coin value is 0.01 and slot has 20 lines, bet amount = coinValue * lines = 0.01 * 20 = 0.20
{currency} (array, required) - Available bet amounts for currencyNew tags can be added upon request.
\nLive Casino
\nCasino
\nGames
\nVirtuals
\n","urlObject":{"path":["v1","{provider}","{brandId}","games","list"],"host":["{apiUrl}"],"query":[],"variable":[]}},"response":[{"id":"9ab0a527-c116-4c15-9b29-2967b4fe805a","name":"success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"currencies\": [\n \"USD\",\n \"EUR\"\n ],\n \"jurisdiction\": {\n \"type\": \"NOT_APPLICABLE\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.example.com/v1/your-provider-code/brand-001/games/list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"games\": [\n {\n \"id\": \"some-slot-id\",\n \"name\": \"Some slot name\",\n \"demoAvailable\": true,\n \"rtp\": 96.0,\n \"tag\": \"CAS_SLOTS\",\n \"provider\": \"yellow-studio\",\n \"betSizes\": {\n \"USD\": [0.20, 0.50, 1.00, 2.00, 5.00],\n \"EUR\": [0.20, 0.40, 1.00, 2.00, 5.00]\n }\n }\n ]\n}"}],"_postman_id":"2776caaa-01eb-49e9-bc47-7833804bbdc1"},{"name":"Get Real Game Link","id":"e45ba148-0dda-4d4a-9f66-427a4bfdbad3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{apiUsername}"},{"key":"password","value":"{apiPassword}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"gameId\": \"some-game-id\",\n \"provider\": \"yellow-studio\",\n \"currency\": \"USD\",\n \"locale\": \"en_US\",\n \"ip\": \"127.0.0.1\",\n \"country\": \"USA\",\n \"device\": {\n \"operatingSystem\": \"ANDROID\",\n \"mobile\": true,\n \"userAgent\": \"Mozilla/5.0 (Linux; Android 10) AppleWebKit/537.36\"\n },\n \"urls\": {\n \"returnUrl\": \"https://example.com/home\",\n \"depositUrl\": \"https://example.com/deposit\"\n },\n \"player\": {\n \"id\": \"player-123\",\n \"username\": \"player_username\"\n },\n \"session\": {\n \"id\": \"session-123\"\n },\n \"jurisdiction\": {\n \"type\": \"NOT_APPLICABLE\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{apiUrl}/v1/{provider}/{brandId}/games/url/real","description":"Using this method Aggregator can receive a valid launch URL for the requested game. Aggregator has to forward Player to the returned URL. There are several ways to forward the Player:
\nEmbed URL into iframe on your site;
\nRedirect Player to URL;
\nOpen URL in new window/tab of browser.
\nObject:
\ngameId (string, required) - Game id from Get Games List response
provider (string, required) - Sub-provider identifier. Used by aggregators to display games from multiple providers separately. Game IDs are expected to be unique within a provider. Example: your provider is green-studio, sub-provider is yellow-studio
currency (string, required) - Player currency (ISO 4217)
locale (string, required) - Player locale (ISO-639 + '_' + ISO-3166)
ip (string, required) - Player IP address IPv4 or IPv6.
country (string, optional) - Country code (ISO 3166-1 alpha-3)
device (object, required)
operatingSystem (enum, required) - Values: 'WINDOWS', 'LINUX', 'MACOS', 'IOS', 'ANDROID'
mobile (boolean, required) - Whether the device is mobile
userAgent (string, required) - User agent string from browser
urls (object, required)
returnUrl (string, required) - URL to redirect page on Aggregator
depositUrl (string, required) - URL to deposit page on Aggregator
player (object, required)
id (string, required) - Player id in Aggregator system. Must be unique
username (string, required) - Player username
session (object, optional)
id (string, required) - Unique session identifier for the player. Every transaction made by the player (/bet, /win, /rollback) must include the sessionId obtained during game launchjurisdiction (object, required) - Jurisdiction information
type (enum, required) - Jurisdiction type. Values: 'NOT_APPLICABLE'Object:
\nvalue (object, required) - Game link objectvalue (string, required) - Game launch content (URL or HTML depending on type)
type (enum, required) - Link type. Values: 'URL', 'HTML'
Link Types:
\n","urlObject":{"path":["v1","{provider}","{brandId}","games","url","real"],"host":["{apiUrl}"],"query":[],"variable":[]}},"response":[{"id":"60e2fc08-6a8d-467e-a2f2-ece1327fd053","name":"success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"gameId\": \"some-game-id\",\n \"provider\": \"yellow-studio\",\n \"currency\": \"USD\",\n \"locale\": \"en_US\",\n \"ip\": \"127.0.0.1\",\n \"country\": \"USA\",\n \"device\": {\n \"operatingSystem\": \"ANDROID\",\n \"mobile\": true,\n \"userAgent\": \"Mozilla/5.0 (Linux; Android 10) AppleWebKit/537.36\"\n },\n \"urls\": {\n \"returnUrl\": \"https://example.com/home\",\n \"depositUrl\": \"https://example.com/deposit\"\n },\n \"player\": {\n \"id\": \"player-123\",\n \"username\": \"player_username\"\n },\n \"session\": {\n \"id\": \"session-123\"\n },\n \"jurisdiction\": {\n \"type\": \"NOT_APPLICABLE\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.example.com/v1/your-provider-code/brand-001/games/url/real"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"value\": {\n \"value\": \"https://example.com/launch-game\",\n \"type\": \"URL\"\n }\n}"},{"id":"9843d445-36c0-4994-94c7-188f3f6fe24c","name":"fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"gameId\": \"invalid-game-id\",\n \"currency\": \"USD\",\n \"locale\": \"en_US\",\n \"ip\": \"127.0.0.1\",\n \"device\": {\n \"operatingSystem\": \"ANDROID\",\n \"mobile\": true,\n \"userAgent\": \"Mozilla/5.0 (Linux; Android 10) AppleWebKit/537.36\"\n },\n \"urls\": {\n \"returnUrl\": \"https://example.com/home\",\n \"depositUrl\": \"https://example.com/deposit\"\n },\n \"player\": {\n \"id\": \"player-123\",\n \"username\": \"player_username\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{apiUrl}/v1/{provider}/{brandId}/games/url/real"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"RS_ERROR_UNKNOWN\",\n \"message\": \"Game not found\"\n}"}],"_postman_id":"e45ba148-0dda-4d4a-9f66-427a4bfdbad3"},{"name":"Get Demo Game Link","id":"e27226b2-0432-4fd7-a488-42bee9f163ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{apiUsername}"},{"key":"password","value":"{apiPassword}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"gameId\": \"some-game-id\",\n \"locale\": \"en_US\",\n \"ip\": \"127.0.0.1\",\n \"country\": \"USA\",\n \"device\": {\n \"operatingSystem\": \"ANDROID\",\n \"mobile\": true,\n \"userAgent\": \"Mozilla/5.0 (Linux; Android 10) AppleWebKit/537.36\"\n },\n \"urls\": {\n \"returnUrl\": \"https://example.com/home\"\n },\n \"jurisdiction\": {\n \"type\": \"NOT_APPLICABLE\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{apiUrl}/v1/{provider}/{brandId}/games/url/demo","description":"Returns the Landing URL of the chosen game in Demo mode.
\nObject:
\ngameId (string, required) - Game id from Get Games List response
locale (string, required) - Player locale (ISO-639 + '_' + ISO-3166)
ip (string, required) - Player IP address
country (string, optional) - Country code (ISO 3166-1 alpha-3)
device (object, required)
operatingSystem (enum, required) - Values: 'WINDOWS', 'LINUX', 'MACOS', 'IOS', 'ANDROID'
mobile (boolean, required) - Whether the device is mobile
userAgent (string, required) - User agent string from browser
urls (object, required)
returnUrl (string, required) - URL to redirect page on Aggregatorjurisdiction (object, required) - Jurisdiction information
type (enum, required) - Jurisdiction type. Values: 'NOT_APPLICABLE'Object:
\nvalue (object, required) - Game link objectvalue (string, required) - Game launch content (URL or HTML depending on type)
type (enum, required) - Link type. Values: 'URL', 'HTML'
Link Types:
\n","urlObject":{"path":["v1","{provider}","{brandId}","games","url","demo"],"host":["{apiUrl}"],"query":[],"variable":[]}},"response":[{"id":"59772ea2-60b1-4356-8939-f969b449290d","name":"success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"gameId\": \"some-game-id\",\n \"locale\": \"en_US\",\n \"ip\": \"127.0.0.1\",\n \"country\": \"USA\",\n \"device\": {\n \"operatingSystem\": \"ANDROID\",\n \"mobile\": true,\n \"userAgent\": \"Mozilla/5.0 (Linux; Android 10) AppleWebKit/537.36\"\n },\n \"urls\": {\n \"returnUrl\": \"https://example.com/home\"\n },\n \"jurisdiction\": {\n \"type\": \"NOT_APPLICABLE\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.example.com/v1/your-provider-code/brand-001/games/url/demo"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"value\": {\n \"value\": \"https://example.com/launch-demo-game\",\n \"type\": \"URL\"\n }\n}"}],"_postman_id":"e27226b2-0432-4fd7-a488-42bee9f163ee"},{"name":"Get Round History","id":"2908fc67-8645-466a-85b4-3e49d6878c11","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{apiUsername}"},{"key":"password","value":"{apiPassword}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"roundId\": \"your-round-id\",\n \"locale\": \"en_US\",\n \"jurisdiction\": {\n \"type\": \"NOT_APPLICABLE\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{apiUrl}/v1/{provider}/{brandId}/games/history/private/round","description":"History API provides game rounds played by the player, with their details.
\nThis endpoint is strictly intended for backoffice use only. Player's browser must NOT be used as initiator of requests to this service.
\nObject:
\nroundId (string, required) - Round identifierlocale (string, optional) - User locale (ISO-639 + '_' + ISO-3166)jurisdiction (object, required) - Jurisdiction informationtype (enum, required) - Jurisdiction type. Values: 'NOT_APPLICABLE'Object:
\nvalue (object, required) - Round history link objectvalue (string, required) - Round history content (URL or HTML depending on type)type (enum, required) - Link type. Values: 'URL', 'HTML'Link Types:
\n","urlObject":{"path":["v1","{provider}","{brandId}","games","history","private","round"],"host":["{apiUrl}"],"query":[],"variable":[]}},"response":[{"id":"46941630-ad73-4c13-9b4c-dc3eb11ad2dd","name":"success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"roundId\": \"your-round-id\",\n \"locale\": \"en_US\",\n \"jurisdiction\": {\n \"type\": \"NOT_APPLICABLE\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.example.com/v1/your-provider-code/brand-001/games/history/private/round"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"value\": {\n \"value\": \"https://example.com/round-history\",\n \"type\": \"URL\"\n }\n}"}],"_postman_id":"2908fc67-8645-466a-85b4-3e49d6878c11"}],"id":"fca48d86-45dc-4e62-a19f-ce3db5c4e355","description":"Provides methods to display and launch games.
\n","_postman_id":"fca48d86-45dc-4e62-a19f-ce3db5c4e355"},{"name":"Free Spins","item":[{"name":"Create Free Spins","id":"55248015-7e7c-4b1d-99e3-1cf0f736082b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{apiUsername}"},{"key":"password","value":"{apiPassword}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"fs-tx-001\",\n \"playerId\": \"player-123\",\n \"gameIds\": [\"game-1\", \"game-2\"],\n \"count\": 10,\n \"currency\": \"USD\",\n \"betValue\": 0.50,\n \"expiresAt\": 1735689600000,\n \"jurisdiction\": {\n \"type\": \"NOT_APPLICABLE\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{apiUrl}/v1/{provider}/{brandId}/games/freeround","description":"Creates free spins for a player.
\nThis operation is idempotent: if free spins with the same id were previously created, they will not be modified and the request will succeed without changes.
Object:
\nid (string, required) - Unique transaction identifier for creating free spins. This ID must be used in bet, win, and rollback requests when the transaction relates to these free spinsplayerId (string, required) - User identifier in Aggregator systemgameIds (array, required) - List of game identifiers eligible for free spinscount (int, required) - Number of free rounds. If assigned to multiple games, the total is shared across all gamescurrency (string, required) - Currency code (ISO 4217)betValue (number, required) - Bet value per free roundexpiresAt (number, required) - Expiration date as Unix timestamp in millisecondsjurisdiction (object, required) - Jurisdiction informationtype (enum, required) - Jurisdiction type. Values: 'NOT_APPLICABLE'Empty response body on success (HTTP 200)
\n","urlObject":{"path":["v1","{provider}","{brandId}","games","freeround"],"host":["{apiUrl}"],"query":[],"variable":[]}},"response":[{"id":"7064a38e-bc7d-430f-a60d-0881cdc250b2","name":"success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"fs-tx-001\",\n \"playerId\": \"player-123\",\n \"gameIds\": [\"game-1\", \"game-2\"],\n \"count\": 10,\n \"currency\": \"USD\",\n \"betValue\": 0.50,\n \"expiresAt\": 1735689600000,\n \"jurisdiction\": {\n \"type\": \"NOT_APPLICABLE\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.example.com/v1/your-provider-code/brand-001/games/freeround"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":""},{"id":"e3399efb-2f23-4118-b8a3-bec75ce36a3a","name":"fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"fs-tx-002\",\n \"playerId\": \"invalid-player\",\n \"gameIds\": [\"game-1\"],\n \"count\": 10,\n \"currency\": \"USD\",\n \"betValue\": 0.50,\n \"expiresAt\": 1735689600000\n}","options":{"raw":{"language":"json"}}},"url":"{apiUrl}/v1/{provider}/{brandId}/games/freeround"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"RS_ERROR_UNKNOWN\",\n \"message\": \"Failed to create free spins\"\n}"}],"_postman_id":"55248015-7e7c-4b1d-99e3-1cf0f736082b"},{"name":"Cancel Free Spins","id":"dbc45fa8-a237-4060-8107-069e4bdddea3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{apiUsername}"},{"key":"password","value":"{apiPassword}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"fs-tx-001\",\n \"jurisdiction\": {\n \"type\": \"NOT_APPLICABLE\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{apiUrl}/v1/{provider}/{brandId}/games/freeround/cancel","description":"Cancels previously created free spins.
\nThis operation is idempotent: if free spins with the specified id do not exist or were already cancelled, the request will succeed with HTTP 200.
Object:
\nid (string, required) - Free spins transaction identifier (from Create Free Spins request)jurisdiction (object, required) - Jurisdiction informationtype (enum, required) - Jurisdiction type. Values: 'NOT_APPLICABLE'On success (200): Empty response body
\nOn error (400):
\nObject:
\ncode (string, required) - Error status codemessage (string, required) - Error messageProvides methods to manage free spins for players.
\n","_postman_id":"75612dee-c74d-45db-acfe-6df0338e8780"}],"id":"8e2b3e8e-37a1-4c44-86d3-9625272c9ac9","description":"Requests sent from Aggregator to Provider.
Authentication: Use apiUsername / apiPassword for Basic Auth.
Aggregator Provider\n | |\n |-- Get Real Game Link ------------>|\n |<------------ Game URL ------------|\n | |\n | [Player plays the game] |\n | |\n |<------------- Bet ----------------|\n |------------- Balance ------------>|\n | |\n |<------------- Win ----------------|\n |------------- Balance ------------>|\n | |\n | [Player continues playing] |\n | |\n |<------------- Bet ----------------|\n |------------- Balance ------------>|\n | |\n |<------------- Win ----------------|\n |------------- Balance ------------>|\n\nAggregator Provider\n | |\n |-- Create Free Spins ------------->|\n |<------------ Success -------------|\n | |\n |-- Get Real Game Link ------------>|\n |<------------ Game URL ------------|\n | |\n | [Player starts free spins] |\n | |\n |<----- Bet (freeSpins.id) ---------|\n |------------- Balance -------------|\n | |\n |<----- Win ------------------------|\n |------------- Balance ------------>|\n | |\n | ... more free spin rounds ... |\n | |\n |<----- Bet (freeSpins.id) ---------|\n |------------- Balance ------------>|\n | |\n |<- Win (freeSpins.completed=true) -|\n |------------- Balance ------------>|\n | |\n | [Free spins finished, |\n | player continues with |\n | regular bets] |\n | |\n |<------------- Bet ----------------|\n |------------- Balance ------------>|\n | |\n |<------------- Win ----------------|\n |------------- Balance ------------>|\n\nA single round can contain multiple bet and win transactions. The roundEnded field indicates whether the round is complete.
Example 1: Simple round (single bet)
\nbet -> win (roundEnded: true)\n\nExample 2: Multi-bet round (e.g., blackjack with double)
\nbet -> win (roundEnded: false) -> bet -> win (roundEnded: true)\n\nExample 3: Parallel bets resolved sequentially
\nbet -> bet -> win (roundEnded: false) -> win (roundEnded: true)\n\nExample 4: Round cancelled after bet
\nbet -> rollback (roundEnded: true)\n\nExample 5: Partial rollback in multi-bet round
\nbet -> bet -> rollback (roundEnded: false) -> rollback (roundEnded: true)\n\nImportant: Provider must not create new transactions for a round after sending a transaction with roundEnded: true.
Called when player's balance is needed. Aggregator is expected to return player's current balance.
\nObject:
\nsessionId (string, required) - Session token from game launch
gameId (string, required) - Game identifier
provider (string, required) - Sub-provider identifier from games/list response
playerId (string, required) - User identifier in Aggregator system
currency (string, required) - Player currency at game launch (ISO 4217)
jurisdiction (object, required) - Jurisdiction information
type (enum, required) - Jurisdiction type. Values: 'NOT_APPLICABLE'Object:
\nplayerId (string, required) - User identifier
currency (string, required) - Currency code (ISO 4217)
balance (bigdecimal, required) - Current balance
Called when the User places a bet. Deducts the bet amount from the user's balance.
\nThis endpoint is designed for executing game transactions. Request retry is only allowed in case of network errors. Each transaction ID must be globally unique. It's recommended to retry bet transactions only in case of network errors.
\nIdempotency: The transactionId field serves as an idempotency key. If a request with the same transactionId is received multiple times, the Aggregator will return the response without processing the transaction again. This ensures safe retry behavior in case of network failures.
Object:
\ntransactionId (string, required) - Globally unique transaction identifier (also serves as idempotency key)
timestamp (number, required) - Request timestamp as Unix timestamp in milliseconds
sessionId (string, required) - Session token from game launch
playerId (string, required) - User identifier in Aggregator system
roundId (string, required) - Game round identifier
gameId (string, required) - Game identifier
provider (string, required) - Sub-provider identifier from games/list response
currency (string, required) - Currency code (ISO 4217)
amount (bigdecimal, required) - Bet amount
freeSpins (object, optional) - Free spins information
id (string, required) - Free spins identifier from Create Free Spins request
spentAmount (int, required) - Number of free spins spent in this bet
jurisdiction (object, required) - Jurisdiction information
type (enum, required) - Jurisdiction type. Values: 'NOT_APPLICABLE'Object:
\nplayerId (string, required) - User identifier
currency (string, required) - Currency code (ISO 4217)
balance (bigdecimal, required) - Balance after bet
Called when the User makes a tip. Deducts the tip amount from the user's balance.
\nTo make tips, this endpoint must be used instead of /bet. Request retry is only allowed in case of network errors. Each transaction ID must be globally unique. It's recommended to retry tip transactions only in case of network errors.
Idempotency: The transactionId field serves as an idempotency key. If a request with the same transactionId is received multiple times, the Aggregator will return the response without processing the transaction again. This ensures safe retry behavior in case of network failures.
Object:
\ntransactionId (string, required) - Globally unique transaction identifier (also serves as idempotency key)
timestamp (number, required) - Request timestamp as Unix timestamp in milliseconds
sessionId (string, required) - Session token from game launch
playerId (string, required) - User identifier in Aggregator system
roundId (string, required) - Game round identifier. Must be unique for every tip.
gameId (string, required) - Game identifier
provider (string, required) - Sub-provider identifier from games/list response
currency (string, required) - Currency code (ISO 4217)
amount (bigdecimal, required) - Bet amount
jurisdiction (object, required) - Jurisdiction information
type (enum, required) - Jurisdiction type. Values: 'NOT_APPLICABLE'Object:
\nplayerId (string, required) - User identifier
currency (string, required) - Currency code (ISO 4217)
balance (bigdecimal, required) - Balance after bet
Called when the User wins. Credits the win amount to the user's balance.
\nThis endpoint is designed for crediting balance to the player. Each /win transaction must reference a /bet transaction via referenceTransactionId. These transactions must be retried until a successful response is received. Provider must not allow /win to reference a /bet transaction that was cancelled through /rollback.
Idempotency: The transactionId field serves as an idempotency key. If a request with the same transactionId is received multiple times, the Aggregator will return the response without processing the transaction again.
Object:
\ntransactionId (string, required) - Globally unique transaction identifier (also serves as idempotency key)timestamp (number, required) - Request timestamp as Unix timestamp in millisecondssessionId (string, required) - Session token from game launchplayerId (string, required) - User identifier in Aggregator systemroundId (string, required) - Game round identifierreferenceTransactionId (string, required) - Reference to the original bet transactiongameId (string, required) - Game identifierprovider (string, required) - Sub-provider identifier from games/list responsecurrency (string, required) - Currency code (ISO 4217)amount (bigdecimal, required) - Win amountroundEnded (boolean, required) - Whether the game round has ended. Provider must not create new transactions for this round after sending roundEnded: truefreeSpins (object, optional) - Free spins informationid (string, required) - Free spins identifier from Create Free Spins requestcompleted (boolean, required) - Whether free spins session is completedjurisdiction (object, required) - Jurisdiction informationtype (enum, required) - Jurisdiction type. Values: 'NOT_APPLICABLE'Object:
\nplayerId (string, required) - User identifiercurrency (string, required) - Currency code (ISO 4217)balance (bigdecimal, required) - Balance after winCalled when there is need to roll back the effect of the referenced transaction.
\nThis endpoint is designed for cancelling transactions. Both /bet and /win transactions can be cancelled (e.g., in case of round cancellation). These transactions must be retried until a successful response is received.
\nIdempotency: The transactionId field serves as an idempotency key. If a request with the same transactionId is received multiple times, the Aggregator will return the response without processing the transaction again.
Object:
\ntransactionId (string, required) - Globally unique transaction identifier for this rollback (also serves as idempotency key)timestamp (number, required) - Request timestamp as Unix timestamp in millisecondssessionId (string, required) - Session token from game launchplayerId (string, required) - User identifier in Aggregator systemroundId (string, required) - Game round identifierreferenceTransactionId (string, required) - Reference to the transaction being rolled backgameId (string, required) - Game identifierprovider (string, required) - Sub-provider identifier from games/list responseroundEnded (boolean, required) - Whether the game round has ended. Provider must not create new transactions for this round after sending roundEnded: truefreeSpins (object, optional) - Free spins informationid (string, required) - Free spins identifier from Create Free Spins requestreturnAmount (int, required) - Number of free spins returned to the playerjurisdiction (object, required) - Jurisdiction informationtype (enum, required) - Jurisdiction type. Values: 'NOT_APPLICABLE'Object:
\nplayerId (string, required) - User identifiercurrency (string, required) - Currency code (ISO 4217)balance (bigdecimal, required) - Balance after rollbackGame transaction endpoints. This endpoints allow to make transactions against generic aggregator wallet
\nThe following error codes may be returned in the code field of error responses:
Requests sent from Provider to Aggregator.\nAuthentication: Use apiUsername / apiPassword for Basic Auth.
\nRecommended timeout for transaction requests (/bet, /win, /rollback): 5 seconds.
If a timeout occurs, the Provider should retry the request with the same transactionId. The Aggregator guarantees idempotent processing.