Casino is the entity which works with the players.
Aggregator Provider is the entity which provides single API for integrations.
Casino provides:
\nCallback Url
\nIPs to whitelist.
\nAggregator Provider provides:
\nAPI Url
\nBasic Auth Username
\nBasic Auth Password
\nBrand Id
\nIPs to whitelist.
\nMoney amount is passed with minor units
Examples: 2.50 EUR = 250, 10.50 TRY = 1050
Currency is passed as string
Examples: EUR, TRY
Supported Currencies:
\nDate and Time are passed in Unix Timestamp using UTC timezone (epochconverter) - 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 (ISO-639, ISO-3166).
\nLocales:
\nEach request between casino and aggregator provider and vice versa must contain basic auth header (Basic access authentication)
Example for username 'name' and password 'password':
Authorization: Basic bmFtZTpwYXNzd29yZA==
Returns the Landing URL of the chosen game. Casino has to forward User to returned URL. There are several ways to forward the User:
\nEmbed URL into iframe on your site;
\nRedirect User to URL;
\nOpen URL in new window/tab of browser.
\nObject:
\ngameId(string, required) - Id from get games request
urls (object, required)
returnUrl (string, required) - Url to provider page on casino
depositUrl (string required) - Url to deposit page on casino
user (object, required)
externalId (string, required) - User id in casino system. Must be unique
username (string, required)
name (string, optional)
surname (string, optional)
honorific (enum, optional) - Values: 'Mr', 'Mrs', 'Ms', 'Miss'
ip (string, required)
locale (string, required)
device (object, required)
operatingSystem (enum, required) - Values 'WINDOWS', 'LINUX', 'MACOS', 'IOS', 'ANDROID'
platform (enum, required) - Values 'BROWSER', 'NATIVE'
currency (string, required) - User currency
session (object, optional)
externalId (string, required) - Session Id in casino system. Will be attached to callbacks in Casino API, see session objectObject:
\nlink(string, required) - Link to open gameReturns the Landing URL of the chosen game in Demo mode.
\nObject:
\nbrandId (int, required) - Brand id provided by aggregator provider
gameId(string, required) - Id from get games request
urls (object, required)
returnUrl (string, required) - Url to provider page on casino
depositUrl (string required) - Url to deposit page on casino
user (object, required)
ip (string, required)
locale (string, required)
device (object, required)
operatingSystem (enum, required) - Values 'WINDOWS', 'LINUX', 'MACOS', 'IOS', 'ANDROID'
platform (enum, required) - Values 'BROWSER', 'NATIVE'
Object:
\nlink(string, required) - Link to open gameReturns the list of games available for brand
\nObject:
\nbrandId (int, required) - Brand id provided by aggregator provider
provider (string, optional) - Provider which games should be returned. If not present all games will be returned
List of Objects:
\nid (string, required) - Id of the game. Unique among all games
providerGameId (string, required) - Id of the game in provider system.
name (string, required)
isActive (boolean, required)
isDemoAvailable (boolean, required)
isFreeBonusBuyAvailable (boolean, required) - if this game is applicable for free bonus buys
previewImages (list of objects, required)
size (enum, required) - Values: 'S', 'M', 'L'
url (string, required) - Url to game's preview image
backgroundImageUrl (string, optional) - Url to game's background image
provider (string, required) - Provider name
product (enum, required) - Values: 'LIVE_CASINO', 'CASINO', 'GAMES', 'VIRTUAL'
createdAt (long, required) - Created at timestamp
devices (list of enums, required) - Values: 'DESKTOP', 'MOBILE'
gameTags (list of objects, required)
id (string, required)
name (string, required)
betValues (list of objects, required) - Bet values to create free spins
currency (string, required) - Bet value currency
values (list of long, required) - Possible free spins bets values. Values are in Money format
rtp (object, optional) - Game RTP value
type (string, required) - RTP object type (Fixed)
value (double, required) - RTP value
Returns details about game providers.
\nObject:
\nbrandId (int, required) - Brand id provided by aggregator providerList of Objects:
\nname (string, required) - Provider name
roundHistory (boolean, required)
products (list of enum, required) - Values: 'VIRTUAL', 'GAMES', 'LIVE_CASINO', 'CASINO', 'SPORTS', 'POKER'
bonuses (list of enum, required) - Values: 'FREE_SPINS'
Retursn jackpot feed. Process of fetching jackpot data is asynchronious and it's expected to use some sort of polling mechanism to get latest jackpot details.
\nObject:
\nbrandId (int, required) - Brand id provided by aggregator provider
providers (string array, required) - Ids of providers to fetch jackpots
currency (enum, required) - Currency of jackpot
Response body is a dedicated jackpot pool
\nList of Objects:
\nprovider (string, required) - Provider name
tiers (object array, required) - Tiers for that pool
level (int, required) - Jackpot level
amount (long, required) - Jackpot amount
currency (enum, required) - Jackpot amount currency
Provides methods to display and launch games on a Casino.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"f0e1e21d-e55f-4678-9cae-e8f9f3cbe6ca"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"ae19f328-ab27-44bc-b26b-336c6f33930d"}}],"_postman_id":"ad48e282-12f9-4a09-a273-9f81b39843bd","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{username}"},{"key":"password","value":"{password}"}]},"isInherited":true,"source":{"_postman_id":"f25cc1e0-b5ff-4625-85b2-d09b578043d6","id":"f25cc1e0-b5ff-4625-85b2-d09b578043d6","name":"Casino Aggregator API","type":"folder"}}},{"name":"Free Spins API","item":[{"name":"Get Player Active Free Spins","id":"a31dcd3c-9921-4a97-88ce-bd37c5f4f4aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"brandId\": 0,\n \"externalUserId\": \"externalId\"\n}","options":{"raw":{"language":"json"}}},"url":"{apiUrl}/external-casino-client/v1/free-spins","description":"Returns currently active player Free Spins.
\nObject:
\nbrandId (int, required) - Brand id provided by aggregator provider
externalUserId (string, required) - User id in casino system
List of Objects:
\nexternalFreeSpinsId (string, required) - Id of Free Spins in casino system
internalUserId (string, required) - User id in aggregator provider system
externalUserId (string, required) - User id in casino system
gameIds (string array, required) - Ids from get games request
betValue (object, required) - Bet value from games request
currency (string, required) - Bet value currency
value (long, required) - Bet value from games request. In Money format
amount (integer, required) - Amount of free spins
currentAmount (integer, required) - Amount of used free spins
startDate (long, required) - Free Spins start date timestamp
endDate (long, required) - Free Spins end date timestamp
Endpoint for creating Free Spins
\nObject:
\nbrandId (int, required) - Brand id provided by aggregator provider
externalFreeSpinsId (string, required) - Id of Free Spins in casino system
user (object, required)
externalId (string, required) - User id in casino system. Must be unique
username (string, required)
name (string, optional)
surname (string, optional)
honorific (enum, optional) - Values: 'Mr', 'Mrs', 'Ms', 'Miss'
currency (string, required) - User currency
locale (string, required)
gameId (string, required) - Id from get games request
amount (integer, required) - Amount of free spins
betValue (object, required) - Bet value from games request
currency (string, required) - Bet value code currency
value (long, required) - Bet value from games request. In Money format
startDate (long, required) - Free Spins start date timestamp
endDate (long, required) - Free Spins end date timestamp
Object:
\nexternalFreeSpinsId (string, required) - Id of Free Spins in casino system
internalUserId (string, required) - User id in aggregator provider system
externalUserId (string, required) - User id in casino system
gameId (string, optional) - Id from get games request
gameIds (string array, optional) - Ids from get games request, either gameId or gameIds should be present. If both provided behaviour is undefined
betValue (object, required) - Bet value from games request
currency (string, required) - Bet value code currency
value (long, required) - Bet value from games request. In Money format
startDate (long, required) - Free Spins start date timestamp
endDate (long, required) - Free Spins end date timestamp
Endpoint for creating Free Spins
\nObject:
\nbrandId (int, required) - Brand id provided by aggregator provider
externalFreeSpinsId (string, required) - Id of Free Spins in casino system
user (object, required)
externalId (string, required) - User id in casino system. Must be unique
username (string, required)
name (string, optional)
surname (string, optional)
honorific (enum, optional) - Values: 'Mr', 'Mrs', 'Ms', 'Miss'
currency (string, required) - User currency
locale (string, required)
gameIds (string array, required) - Ids from get games request
betValue (object, required) - Bet value from games request
currency (string, required) - Bet value code currency
value (long, required) - Bet value from games request. In Money format
startDate (long, required) - Free Spins start date timestamp
endDate (long, required) - Free Spins end date timestamp
Object:
\nexternalFreeSpinsId (string, required) - Id of Free Spins in casino systemEndpoint for cancelling Free Spins
\nObject:
\nbrandId (int, required) - Brand id provided by aggregator provider
externalFreeSpinsId (string, required) - Id of Free Spins in casino system
externalUserId (string, required) - User id in casino system
Object:
\ninternalUserId (string, required) - User id in aggregator provider system
externalUserId (string, required) - User id in casino system
externalFreeSpinsId (string, required) - Id of Free Spins in casino system
Provides methods to manage rewards (freespins, freebets, prizes).
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"d43873aa-ae84-43d3-acc2-9c2cf897cb98"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"f52fe4ac-6a86-4630-98a0-1425305bec37"}}],"_postman_id":"bf8617e6-ac99-4a01-8d2c-410e36a6ed74","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{username}"},{"key":"password","value":"{password}"}]},"isInherited":true,"source":{"_postman_id":"f25cc1e0-b5ff-4625-85b2-d09b578043d6","id":"f25cc1e0-b5ff-4625-85b2-d09b578043d6","name":"Casino Aggregator API","type":"folder"}}},{"name":"Lobby API","item":[{"name":"Get Lobby Link","id":"570382c7-4140-41d6-b76a-92532d6aa64b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"brandId\": 0,\n \"urls\": {\n \"returnUrl\": \"https://example.com\",\n \"depositUrl\": \"https://example.com\"\n },\n \"user\": {\n \"externalId\": \"externalId\",\n \"username\": \"test\",\n \"name\": \"test\",\n \"surname\": \"test\",\n \"honorific\": \"Mr\",\n \"ip\": \"0.0.0.0\",\n \"locale\": \"tr_TR\",\n \"device\": {\n \"operatingSystem\": \"LINUX\",\n \"platform\": \"BROWSER\"\n },\n \"currency\": \"TRY\"\n },\n \"session\": {\n \"externalId\": \"your-session-id\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{apiUrl}/external-casino-client/v1/lobby/link","description":"Returns the Landing URL of the Lobby.
\nObject:
\nbrandId (int, required) - Brand id provided by aggregator provider
urls (object, required)
returnUrl (string, required) - Url to provider page on casino
depositUrl (string, required) - Url to deposit page on casino
user (object, required)
externalId (string, required) - User id in casino system. Must be unique
username (string, required)
name (string, optional)
surname (string, optional)
honorific (enum, optional) - Values: 'Mr', 'Mrs', 'Ms', 'Miss'
ip (string, required)
locale (string, required)
device (object, required)
operatingSystem (enum, required) - Values 'WINDOWS', 'LINUX', 'MACOS', 'IOS', 'ANDROID'
platform (enum, required) - Values 'BROWSER', 'NATIVE'
currency (string, required) - User currency
session (object, optional)
externalId (string, required) - Session Id in casino system. Will be attached to callbacks in Casino API, see session objectObject:
\nlink(string, required) - Link to open lobbyReturns the Landing URL of the Demo Lobby.
\nObject:
\nbrandId (int, required) - Brand id provided by aggregator provider
urls (object, required)
returnUrl (string, required) - Url to provider page on casino
depositUrl (string, required) - Url to deposit page on casino
user (object, required)
ip (string, required)
locale (string, required)
device (object, required)
operatingSystem (enum, required) - Values 'WINDOWS', 'LINUX', 'MACOS', 'IOS', 'ANDROID'
platform (enum, required) - Values 'BROWSER', 'NATIVE'
Object:
\nlink(string, required) - Link to open lobbyProvides methods to show Games Lobby.
\nGames Lobby contains all games availbale to brand and ready to play
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"2698772a-87e3-4ffa-9855-01d236a9a7b6"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"57b5fd65-c6ea-4de5-b390-4d459ad3d0ba"}}],"_postman_id":"1a65d46f-d387-48d3-a2bc-850b99ced403","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{username}"},{"key":"password","value":"{password}"}]},"isInherited":true,"source":{"_postman_id":"f25cc1e0-b5ff-4625-85b2-d09b578043d6","id":"f25cc1e0-b5ff-4625-85b2-d09b578043d6","name":"Casino Aggregator API","type":"folder"}}},{"name":"Round API","item":[{"name":"Get Private Round History","id":"d7a49ec9-aec2-474d-9066-caf716c5e42f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"brandId\": 0,\n \"externalUserId\": \"externalId\",\n \"roundId\": \"6a95ba3a-1448-4824-998c-045552421f62\"\n}","options":{"raw":{"language":"json"}}},"url":"{apiUrl}/external-casino-client/v1/round/private/history","description":"Returns the URL of a game round detail. Designed for Backoffice usage, because there might be sensitive data here.
\nObject:
\nbrandId (int, required) - Brand id provided by aggregator provider i
externalUserId (string, required) - User id in casino system
roundId (string, required) - Id of the round
Object:
\nvalue (string, required) - URL that contains round info in provider system, it's preferred to insert it into iframe.src attributReturns the URL of a game round replay. This API should be only used to retrive replays for rounds with big multipliers.
\nObject:
\nbrandId (int, required) - Brand id provided by aggregator provider i
externalUserId (string, required) - User id in casino system
roundId (string, required) - Id of the round
Object:
\nvalue (string, required) - URL that contains round replay in provider system, it's preferred to insert it into iframe.src attributReturns the URL of a game round detail. Designed for Public usage, i.e. you can use this API to display link on your Player UI.
\nObject:
\nbrandId (int, required) - Brand id provided by aggregator provider i
externalUserId (string, required) - User id in casino system
roundId (string, required) - Id of the round
Object:
\nvalue (string, required) - URL that contains round info in provider system, it's preferred to insert it into iframe.src attributThis report returns all the game rounds that were started by a certain player but not completed yet.
Customer is expected to use this API
Object:
\nbrandId (int, required) - Brand id provided by aggregator provider i
externalUserId (string, required) - User id in casino system
providers (string array, optional) - Provider value received from providers endpoint, if no given - all prvoiders will be used
products (enum array, optional) - Values: 'LIVE_CASINO', 'CASINO', 'GAMES', 'VIRTUAL', if empty will search for all products
Array of objects:
\nid (string, required) - ID of pending round
gameId (string, required) - game identifier
betAmount (number, required) - pending bet amount
currency (enum, required) - round currency
Requests sent from Casino to Aggregator Provider
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"a7def537-06c9-4736-a061-989c2ce8c7d5"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"48e9d329-f752-4514-9465-350293e96bdb"}}],"_postman_id":"88578455-9adc-446b-9913-744a0ab23265","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{username}"},{"key":"password","value":"{password}"}]},"isInherited":true,"source":{"_postman_id":"f25cc1e0-b5ff-4625-85b2-d09b578043d6","id":"f25cc1e0-b5ff-4625-85b2-d09b578043d6","name":"Casino Aggregator API","type":"folder"}}},{"name":"Casino API","item":[{"name":"Get Balance","id":"2a40cb4c-6538-4a21-bb6a-81500cec489b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"brandId\": 0,\n \"internalUserId\": \"037ee5a8-d09f-4b0a-9f5d-dc5d12d0d48b\",\n \"externalUserId\": \"externalId\",\n \"currency\": \"TRY\",\n \"session\": {\n \"externalId\": \"your-session-id\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{callbackUrl}/get-balance","description":"Called when player's balance is needed. Casino is expected to return player's current balance
\nObject:
\nbrandId (int, required) - Brand id provided by aggregator provider
internalUserId (string, required) - User id in aggregator provider system
externalUserId (string, required) - User id in casino system
currency (string, required) - User currency
provider (string, optional) - Provider which requests the balance. This value might not be available in certain situations
session (object, optional)
externalId (string, required) - Session Id in casino system received on game launchgameId(string, optional) - Game Id
Object:
\nexternalUserId (string, required) - User id in casino system
balance (long, required) - In Money format
currency (string, required) - User currency
Endpoint used for various transactions:
\nBET - Called when the User places a bet.
\nWIN - Called when the User wins.
\nROLLBACK - Called when there is need to roll back the effect of the referenced transaction.
\nFREE_SPINS_BET - Called when the User places a Free Spins bet.
\nFREE_SPINS_WIN - Called when the User wins in Free Spins round.
\nObject:
\nbrandId (int, required) - Brand id provided by aggregator provider
internalUserId (string, required) - User id in aggregator provider system
externalUserId (string, required) - User id in casino system
txType (enum, required) - Values: 'BET', 'WIN', 'ROLLBACK', 'FREE_SPINS_BET', 'FREE_SPINS_WIN'
txId (string, required) - Id of the transaction. Unique among all txs
roundId (string, required) - Id of the round in aggregator system
providerRoundId (string, required) - Id of the round in provider system
isForced (boolean, required) - BET should be accepted even if player doesn't have enough money on balance (balance can go negative)
isJackpot (boolean, required) - Indicates if current transaction is related to jackpot
isBonusBuy (boolean, required) - Indicates if current transaction is related to bonus buy
isRoundFinished (boolean, required)
amount (long, required) - Transaction amount. In Money format
currency (string, required) - User currency
provider (string, required) - Provider name
rolledBackTxId (string, optional) - Not null in case of rollback. Tx id to rollback
externalFreeSpinsId (string, optional) - Not null in case of free spins transaction
gameId (string, optional) - Id from get games request. Can be null in case of jackpots, tips etc
timestamp (long, required) - Transaction process timestamp in aggregator provider system
session (object, optional)
externalId (string, required) - Session Id in casino system received on game launchdetails (object, optional) - Sportsbook bet context. Populated only for sportsbook transactions; null for casino game transactions. See \"Sportsbook Scheme\" folder for the schema.
Object:
\ntxId (string, required) - Transaction id in casino system
externalUserId (string, required) - User id in casino system
balance (long, required) - Balance after transaction. In Money format
currency (string, required) - User currency
Called to notify about round end.
\nObject:
\nbrandId (int, required) - Brand id provided by aggregator provider
internalUserId (string, required) - User id in aggregator provider system
externalUserId (string, required) - User id in casino system
roundId (string, required) - Id of the round
providerRoundId (string, required) - Id of the round in provider system
isRoundFinished (boolean, required)
currency (string, required) - User currency
provider (string, required) - Provider name
gameId (string, optional) - Id from get games request. Can be null in case of jackpots, tips etc
timestamp (long, required) - End round timestamp in aggregator provider system
session (object, optional)
externalId (string, required) - Session Id in casino system received on game launchdetails (object, optional) - Sportsbook bet context. Populated only for sportsbook transactions; null for casino game transactions. See \"Sportsbook Scheme\" folder for the schema.
Object:
\nexternalUserId (string, required) - User id in casino system
balance (long, required) - Balance in Money format
currency (string, required) - User currency
Called to notify about free spins completion.
\nObject:
\nbrandId (int, required) - Brand id provided by aggregator provider
internalUserId (string, required) - User id in aggregator provider system
externalUserId (string, required) - User id in casino system
externalFreeSpinsId (string, required) - Free spins id that you used for its create
currency (enum, required) - Currency of rpvodied amounts
totalAmount (long, required) - Total winning amount of a free spin
txId (string, required) - Free spins total win transaction id for operation idempotency
Object:
\nexternalUserId (string, required) - User id in casino system
balance (long, required) - In Money format
currency (string, required) - User currency
Called to fetch player details by provided token.
\nThis API is optional, it might become mandatory to be implemented depending on the product scope received by the casino
\nObject:
\nbrandId (int, required) - Brand id provided by aggregator provider
token (string, required) - Token received from integration that will allow it to fetch player details
Object:
\nexternalUserId (string, required) - User id in casino system
username (string, required)
name (string, optional)
surname (string, optional)
honorific (enum, optional) - Values: 'Mr', 'Mrs', 'Ms', 'Miss'
Requests sent from Aggregator Provider to Casino
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"00232eef-9544-47e3-b980-bd326483f60e"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"31314ff1-2c8a-4a5f-b728-740d28443b2b"}}],"_postman_id":"313155e0-ebbb-4aa8-8ef4-96dfc019cb9e","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{username}"},{"key":"password","value":"{password}"}]},"isInherited":true,"source":{"_postman_id":"f25cc1e0-b5ff-4625-85b2-d09b578043d6","id":"f25cc1e0-b5ff-4625-85b2-d09b578043d6","name":"Casino Aggregator API","type":"folder"}}}],"id":"f25cc1e0-b5ff-4625-85b2-d09b578043d6","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{username}"},{"key":"password","value":"{password}"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"cfa7c79a-740c-4d64-827d-43bbbe6ff1aa"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"25c98e57-e6da-44e4-ab0f-7b42ed9949e7"}}],"_postman_id":"f25cc1e0-b5ff-4625-85b2-d09b578043d6","description":""},{"name":"Sportsbook Scheme - Preview","item":[{"name":"Transaction Details","item":[],"id":"dcb5c0d5-af7a-4a84-a146-2d7e559b1644","description":"Schema of the details object attached to sportsbook-originated Transaction and End Round callbacks.
Populated only for sportsbook transactions; null for casino game transactions.
\nmethod (enum, required) - Sportsbook event that triggered the notify. Values: 'ACCOUNT_DETAILS', 'EDIT_BET', 'BET_CANCELED', 'CREATE_BET_BATCH', 'CREATE_BET', 'BET_SETTLED', 'BET_CASH_OUT', 'BET_PARTIAL_CASH_OUT', 'BET_CREATE_FAILED', 'BET_ODDS_BOOST_SETTLED', 'BET_ODDS_BOOST_CANCELED', 'CREATE_FORECAST', 'SETTLE_FORECAST', 'CANCEL_FORECAST'
bet (object, required) - Snapshot of the underlying sportsbook bet (see Bet section below)
Bet (details.bet):
betId (string, required) - Bet id in sportsbook system
totalCoefficient (double, required) - Total bet coefficient
eventPicks (array, required) - Picks placed on regular sport events (see Pick and Event Pick sections)
outrightPicks (array, required) - Picks placed on outright (long-term) markets (see Pick and Outright Pick sections)
createTime (long, required) - Timestamp in milliseconds when the bet was placed
live (boolean, required) - True if the bet was placed on a live event
hash (object, required) - Structural summary of the bet (see \"Bet Hash\" item in this folder)
result (enum, optional) - Bet settlement state. Null while the bet is still pending. Values: 'WIN', 'LOSS', 'PARTIAL_WIN', 'PARTIAL_LOSS', 'CANCELED', 'PENDING', 'CASH_OUTED', 'RETURN', 'UNKNOWN'
settledAt (long, optional) - Timestamp in milliseconds when the bet was settled
cashOutAt (long, optional) - Timestamp in milliseconds when the bet was cashed out
canceledAt (long, optional) - Timestamp in milliseconds when the bet was canceled
Pick (shared fields of details.bet.eventPicks[] and details.bet.outrightPicks[]):
pickId (string, required) - Pick id in sportsbook system
sportName (string, required) - Sport name
sportId (string, required) - Sport id
categoryName (string, required) - Sport category name
categoryId (string, required) - Sport category id
tournamentName (string, required) - Tournament name
tournamentId (string, required) - Tournament id
coefficient (string, required) - Pick coefficient
result (string, required) - Pick settlement result
outcomeParameterHash (object, required) - Outcome descriptor (see \"Outcome Hash\" item in this folder).
banker (boolean, required) - True if the pick is marked as a banker in a system bet
contribution (double, optional) - Pick contribution to the total coefficient
Event Pick (details.bet.eventPicks[] extra fields):
eventStatus (string, required) - Sport event status
eventId (string, required) - Sport event id
eventName (string, required) - Sport event name
marketParameterHash (object, required) - Market descriptor (see \"Market Hash\" item in this folder).
participants (object, required) - Map keyed by participant slot, value is a Participant object with name (string) and teamId (string).
finalScore (object, optional) - Final score of the event with team1 (float) and team2 (float).
Outright Pick (details.bet.outrightPicks[] extra fields):
outrightId (string, required) - Outright market id
outrightName (string, required) - Outright market name
{\n \"method\": \"BET_SETTLED\",\n \"bet\": {\n \"betId\": \"b1f8a8a4-2eb3-4b16-8d6c-2a4a25c5c5c5\",\n \"totalCoefficient\": 1.5,\n \"eventPicks\": [\n {\n \"pickId\": \"1c1a8a01-1111-4111-9111-111111111111\",\n \"sportName\": \"Football\",\n \"sportId\": \"11111111-1111-1111-1111-111111111111\",\n \"categoryName\": \"England\",\n \"categoryId\": \"22222222-2222-2222-2222-222222222222\",\n \"tournamentName\": \"Premier League\",\n \"tournamentId\": \"33333333-3333-3333-3333-333333333333\",\n \"coefficient\": \"1.50\",\n \"result\": \"WIN\",\n \"outcomeParameterHash\": {\n \"parameters\": { \"@kind\": \"enum\", \"outcome\": \"team1\" }\n },\n \"banker\": false,\n \"contribution\": null,\n \"eventStatus\": \"ENDED\",\n \"eventId\": \"44444444-4444-4444-4444-444444444444\",\n \"eventName\": \"Arsenal vs Chelsea\",\n \"marketParameterHash\": {\n \"type\": \"score_oupt\",\n \"parameters\": { \"total\": \"2.5\" }\n },\n \"participants\": {\n \"1\": { \"name\": \"Arsenal\", \"teamId\": \"55555555-5555-5555-5555-555555555555\" },\n \"2\": { \"name\": \"Chelsea\", \"teamId\": \"66666666-6666-6666-6666-666666666666\" }\n },\n \"finalScore\": { \"team1\": 2.0, \"team2\": 1.0 }\n }\n ],\n \"outrightPicks\": [],\n \"createTime\": 1710849600000,\n \"live\": false,\n \"hash\": { \"betType\": \"SINGLE\", \"totalPicks\": 1, \"picksPerSelection\": [1], \"bankersCount\": 0 },\n \"result\": \"WIN\",\n \"settledAt\": 1710856800000,\n \"cashOutAt\": null,\n \"canceledAt\": null\n }\n}\nStructural summary of a bet, exposed at details.bet.hash.
The platform represents bet structure with a compact string (e.g. 1/1, 3/3, 2/3, 2/3:3/3, 2/3|B1). This object exposes the same information as parsed values, so an integration does not need to parse the string itself.
betType (enum, required) - Bet structure. Values: 'SINGLE' (one pick), 'PARLAY' (all picks must win), 'SYSTEM' (any K out of N must win, possibly across several selection groups).
totalPicks (int, required) - Total number of picks N in the bet.
picksPerSelection (array, required) - For each selection group, the number of picks K that must win for that group to pay out. SINGLE/PARLAY have one entry equal to totalPicks; SYSTEM may have several entries with K < N.
bankersCount (int, required) - Number of picks marked as bankers. Bankers must always win for any combination to settle.
picksPerSelectionEach entry is the K of a K/N selection group. The number of winning combinations the bet pays out on equals sum over K of C(N, K).
Examples:
\nMaximum picks per parlay: 14
\nMaximum picks per system: 12
\nMarket descriptor, exposed at details.bet.eventPicks[].marketParameterHash.
Identifies the market the pick is placed on (e.g. \"Total goals over/under 2.5\") via a stable type code plus a parameters map.
\ntype (string, required) - Market type code. Lower-case identifier matching the platform's MarketType enum (examples: match_winner, dnb, 1x2, score_oupt (over/under total), score_handicap, correct_score, htft, team_total, score_first_ynpt, score_assist_oupt). Always present.
parameters (object, required) - Map of string keys to string values that specialise the market. The exact keys depend on type. May be empty for parameter-less markets (e.g. match_winner, dnb). See \"Common parameter keys\" below.
Keys are sorted alphabetically and values are always strings. Numeric values use minimum-precision decimal formatting (e.g. 2, not 2.0; but 2.5 stays 2.5).
Markets without parameters serialise as an empty parameters map.
{ \"type\": \"match_winner\", \"parameters\": {} }\n{ \"type\": \"score_oupt\", \"parameters\": { \"total\": \"2.5\" } }\n{ \"type\": \"score_handicap\", \"parameters\": { \"handicap\": \"-1.5\" } }\n{ \"type\": \"team_total\", \"parameters\": { \"team\": \"team1\", \"total\": \"1.5\" } }\nOutcome descriptor, exposed at details.bet.eventPicks[].outcomeParameterHash and details.bet.outrightPicks[].outcomeParameterHash.
Identifies which option of the market the user picked (e.g. \"team 1 to win\", \"over 2.5\", \"correct score 2:1\").
\nparameters (object, required) - Map of string keys to string values that identifies the outcome inside the market. Always carries an @kind key whose value selects the parameter shape; the remaining keys depend on @kind. See \"Kinds and their keys\" below.The @kind key is required and selects the shape of the remaining keys. Values come from the platform's OutcomeParametersKind enum.
Notes:
\nKeys are sorted alphabetically when serialised.
\nNumeric values use minimum-precision decimal formatting (2 instead of 2.0).
@kind is always present; if a kind needs no extra keys, only @kind is sent.
Reference structures for the sportsbook-specific payloads attached to Casino API callbacks (Transaction, End Round).
\nWhen the originating transaction comes from a sportsbook bet, the request body carries an extra details object alongside the regular casino fields. Casino game transactions leave it null.
This folder documents:
\nTransaction Details - the full details object schema and an example payload.
Bet Hash - structural summary of the bet (single / parlay / system, banker count).
\nMarket Hash - market type code and the contents of its parameters map.
Outcome Hash - the parameters map keys, indexed by @kind (the outcome parameters kind).
POST /external-casino-client/v1/affiliate/users/register
This endpoint allows external casino systems to register affiliate users. The system supports idempotent operations - if a user with the same externalUserId and brandId already exists, the stored user data is returned instead of creating a duplicate.
Object:
\nbrandId (Int, required) - Brand id provided by aggregator provider. Must be a valid brand identifier.
externalUserId (string, required) - Unique identifier of the user in the casino system. Must be unique among all users for the same brand. Cannot be blank.
username (string, required) - Username for the user. Cannot be blank.
name (string, optional) - First name of the user. Can be null.
surname (string, optional) - Last name of the user. Can be null.
honorific (enum, optional) - Honorific title for the user. Please refer to the common API documentation for honorific enum values. Can be null.
locale (enum, required) - Locale code for the user. Please refer to the common API documentation for locale enum values. Must be a valid locale enum value.
currency (string, required) - Currency code. Must be a valid currency code and cannot be blank. Please refer to the common API documentation for currency code rules.
tracker (object, optional) - Tracking information for affiliate attribution. Can be null if the user registration should not be attributed to any affiliate. If provided, must be a valid tracker object. The tracker object has the following structure:
type (enum, required) - Tracker type. Valid values:
TRACKING_CODE - Tracking code type
LINK_CODE - Link code type
value (string, required) - Tracker value. The value must be non-empty and cannot be blank. This validation applies to both TRACKING_CODE and LINK_CODE tracker types.
promoCode (string, optional) - Promotional code associated with the registration. Can be null.
Object:
\ninternalUserId (string, required) - Internal user identifier in the aggregator provider system. This is a unique identifier generated by the system and can be used for future reference or queries.
externalUserId (string, required) - User identifier from the request. If a user with this externalUserId and brandId already exists, the stored value is returned (idempotent behavior).
brandId (integer, required) - Brand id from the request. If the user already exists, the stored value is returned.
createdAt (long, required) - Created at timestamp when the user was registered. If the user already exists, the stored value is returned. Please refer to the common API documentation for timestamp format rules.
referrer (object, optional) - Referrer information if the user was referred by an affiliate. Can be null if no referrer is associated with the user. The referrer object has the following structure:
type (enum, required) - Referrer type. Valid values:
AFFILIATE - User was referred by an affiliateid (string, required) - Referrer identifier (UUID format). Unique identifier of the referrer.
**When** **`referrer`** **is null:**\n- No `tracker` was provided in the request (user registered without attribution)\n- The `tracker` value provided in the request could not be resolved to a valid referrer (affiliate)\n- The tracker value does not exist in the system or is invalid\n- No referrer was associated with the user during registration\n**When** **`referrer`** **is not null:**\n- The `tracker` value provided in the request was successfully resolved to a valid referrer\n- The system identified an affiliate associated with the tracker value\n- The referrer information is returned to indicate successful attribution\n**Idempotent behavior:**\n- If a user with the same `externalUserId` and `brandId` already exists, the stored referrer value from the original registration is returned\n- This means the referrer value (null or not null) will be the same as it was during the initial registration, regardless of the tracker value in subsequent requests\n\nusername (string, optional) - Username from the request. If the user already exists, the stored value is returned. Can be null.
name (string, optional) - First name from the request. If the user already exists, the stored value is returned. Can be null.
surname (string, optional) - Last name from the request. If the user already exists, the stored value is returned. Can be null.
honorific (enum, optional) - Honorific from the request. If the user already exists, the stored value is returned. Please refer to the common API documentation for honorific enum values. Can be null.
locale (enum, required) - Locale from the request. If the user already exists, the stored value is returned. Please refer to the common API documentation for locale enum values.
currency (string, optional) - Currency code from the request. If the user already exists, the stored value is returned. Please refer to the common API documentation for currency code rules. Can be null.
{\n \"brandId\": 1,\n \"externalUserId\": \"user-abc-123\",\n \"username\": \"johndoe\",\n \"name\": \"John\",\n \"surname\": \"Doe\",\n \"honorific\": \"MR\",\n \"locale\": \"en_US\",\n \"currency\": \"USD\",\n \"tracker\": {\n \"type\": \"TRACKING_CODE\",\n \"value\": \"tracking-code-12345\"\n },\n \"promoCode\": \"WELCOME2024\"\n}\n\n{\n \"brandId\": 1,\n \"externalUserId\": \"user-xyz-789\",\n \"username\": \"janedoe\",\n \"name\": \"Jane\",\n \"surname\": \"Doe\",\n \"locale\": \"en_GB\",\n \"currency\": \"GBP\",\n \"tracker\": {\n \"type\": \"LINK_CODE\",\n \"value\": \"link-code-67890\"\n }\n}\n\n{\n \"brandId\": 1,\n \"externalUserId\": \"user-minimal-456\",\n \"username\": \"minimaluser\",\n \"locale\": \"tr_TR\",\n \"currency\": \"TRY\",\n \"tracker\": {\n \"type\": \"TRACKING_CODE\",\n \"value\": \"tracking-code-11111\"\n }\n}\n\n{\n \"brandId\": 1,\n \"externalUserId\": \"user-no-attribution-789\",\n \"username\": \"directuser\",\n \"locale\": \"en_US\",\n \"currency\": \"USD\"\n}\n\n{\n \"internalUserId\": \"internal-user-uuid-12345\",\n \"externalUserId\": \"user-abc-123\",\n \"brandId\": 1,\n \"createdAt\": 1704067200000,\n \"referrer\": null,\n \"username\": \"johndoe\",\n \"name\": \"John\",\n \"surname\": \"Doe\",\n \"honorific\": \"MR\",\n \"locale\": \"en_US\",\n \"currency\": \"USD\"\n}\n\n{\n \"internalUserId\": \"internal-user-uuid-12345\",\n \"externalUserId\": \"user-abc-123\",\n \"brandId\": 1,\n \"createdAt\": 1704067200000,\n \"referrer\": {\n \"type\": \"AFFILIATE\",\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\"\n },\n \"username\": \"johndoe\",\n \"name\": \"John\",\n \"surname\": \"Doe\",\n \"honorific\": \"MR\",\n \"locale\": \"en_US\",\n \"currency\": \"USD\"\n}\n\nOccurs when request validation fails. Common causes:
\nMissing required fields
\nInvalid field formats (e.g., invalid currency code, invalid enum value)
\nBlank values for required string fields
\nInvalid tracker format or value (if tracker is provided)
\nInvalid tracker type (if tracker is provided)
\nExample Error Response:
\n{\n \"error\": \"Request validation failed\",\n \"message\": \"Field 'currency' must be a valid currency code\"\n}\n\nOccurs when a tracker is provided but the format or value is invalid. Common causes:
\nMissing type or value field in tracker object
Invalid tracker type (must be TRACKING_CODE or LINK_CODE)
Blank or empty tracker value
Note: This error only occurs when a tracker object is provided. If no tracker is provided, the registration will succeed without attribution.
\nExample Error Response:
\n{\n \"error\": \"Request validation failed\",\n \"message\": \"Tracker value should be valid tracking code\"\n}\n\nOccurs when an unexpected server error happens.
\nExample Error Response:
\n{\n \"error\": \"Unknown error\",\n \"message\": \"An unexpected error occurred\"\n}\n\nIdempotency: The endpoint is idempotent. If you send the same request (same externalUserId and brandId) multiple times, you will receive the same response with the stored user data. This prevents duplicate user registrations.
User Uniqueness: The combination of externalUserId and brandId must be unique. Attempting to register a user with the same externalUserId and brandId but different data will return the existing user.
Tracker and Attribution:
\nThe tracker field is optional. If not provided, the user will be created without attribution (the referrer field in the response will be null)
If tracker is provided, it must contain a valid tracker object
The tracker type must be either TRACKING_CODE or LINK_CODE
The tracker value must be non-empty and cannot be blank for both tracker types
If a valid tracker is provided and can be resolved, the referrer field in the response will contain the referrer information
Currency Codes: Please refer to the common API documentation for currency code rules.
\nLocale Values: Please refer to the common API documentation for locale enum values.
\nHonorific Values: Please refer to the common API documentation for honorific enum values.
\nTimestamp Format: Please refer to the common API documentation for timestamp format rules.
\nThis endpoint requires authentication. Please refer to the authentication documentation for details on how to include authentication headers in your requests.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{username}"},{"key":"password","value":"{password}"}]},"isInherited":true,"source":{"_postman_id":"ee5964aa-a7f4-41c1-b2fd-2f619fbe0678","id":"ee5964aa-a7f4-41c1-b2fd-2f619fbe0678","name":"Affiliate API","type":"folder"}},"urlObject":{"path":["external-casino-client","v1","affiliate","users","register"],"host":["{apiUrl}"],"query":[],"variable":[]}},"response":[{"id":"57b06256-4bd2-4f66-b444-72e643e15abb","name":"success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic e3VzZXJuYW1lfTp7cGFzc3dvcmR9","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"brandId\": 0,\n \"externalUserId\": \"ext_987654321\",\n \"username\": \"mehmet.demir\",\n \"name\": \"Mehmet\",\n \"surname\": \"Demir\",\n \"honorific\": \"Mr\",\n \"locale\": \"tr_TR\",\n \"currency\": \"TRY\",\n \"tracker\": {\n \"type\": \"TRACKING_CODE\",\n \"value\": \"ABHoQxDbREpLTHMp18gbAL6wZw\"\n },\n \"promoCode\": \"WELCOME\"\n}","options":{"raw":{"language":"json"}}},"url":"{apiUrl}/external-casino-client/v1/affiliate/users/register"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"internalUserId\": \"019a3409-eace-739e-ae71-83b41d323375\",\n \"externalUserId\": \"ext_987654321\",\n \"brandId\": 0,\n \"createdAt\": 1761721205143,\n \"referrer\": {\n \"id\": \"019a33fe-a05d-71bc-91fc-2ee9ca31ae1b\",\n \"type\": \"AFFILIATE\"\n },\n \"username\": \"mehmet.demir\",\n \"name\": \"Mehmet\",\n \"surname\": \"Demir\",\n \"honorific\": \"Mr\",\n \"locale\": \"tr_TR\",\n \"currency\": \"TRY\"\n}"},{"id":"531c0fa6-4e13-4810-a41d-8a961b208726","name":"fail","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic e3VzZXJuYW1lfTp7cGFzc3dvcmR9","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"brandId\": 0,\n \"externalUserId\": \"ext_987654321\",\n \"username\": \"mehmet.demir\",\n \"name\": \"Mehmet\",\n \"surname\": \"Demir\",\n \"honorific\": \"Mr\",\n \"locale\": \"tr_TR\",\n \"currency\": \"TRY\",\n \"tracker\": {\n \"type\": \"TRACKING_CODE\",\n \"value\": \"ABHoQxDbREpLTHMp18gbAL6wZw\"\n },\n \"promoCode\": \"WELCOME\"\n}","options":{"raw":{"language":"json"}}},"url":"{apiUrl}/external-casino-client/v1/affiliate/users/register"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": 107,\n \"errorMessage\": \"User creation failed\"\n}"}],"_postman_id":"900177fb-8166-4134-8f65-6a634cb358d3"},{"name":"Create User Financial Transaction","id":"3e963ecf-e231-4ea8-8d39-3c67aac3e13e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"externalTxId\": \"ext_787654324\",\n \"brandId\": 0,\n \"externalUserId\": \"ext_987654321\",\n \"createdAt\": 1761721205143,\n \"txType\": \"DEPOSIT\",\n \"amount\": 100,\n \"currency\": \"TRY\"\n}","options":{"raw":{"language":"json"}}},"url":"{apiUrl}/external-casino-client/v1/affiliate/users/transactions/financial/create","description":"POST /external-casino-client/v1/affiliate/users/transactions/financial/create
This endpoint allows external casino systems to create financial transactions for affiliate users. The system supports idempotent operations - if a transaction with the same externalTxId and brandId already exists, the stored transaction data is returned instead of creating a duplicate.
Object:
\nbrandId (integer, required) - Brand id provided by aggregator provider. Must be a valid brand identifier.
\nexternalTxId (string, required) - Unique identifier of the transaction in the casino system. Must be unique among all transactions for the same brand. Cannot be blank.
\nexternalUserId (string, required) - User identifier in the casino system. Must match a previously registered affiliate user. Cannot be blank.
\ncreatedAt (long, required) - Timestamp when the transaction was created. Must be a valid long integer. Please refer to the common API documentation for timestamp format rules.
\ntxType (enum, required) - Type of financial transaction. Valid values:
\nDEPOSIT - Funds deposited to the user account
WITHDRAWAL - Funds withdrawn from the user account
ROLLBACK - Transaction rollback (requires rolledBackExternalTxId)
amount (integer, required) - Transaction amount. Must be a valid integer. Please refer to the common API documentation for amount format rules.
\ncurrency (string, required) - Currency code. Must be a valid currency code and cannot be blank. Please refer to the common API documentation for currency code rules.
\nrolledBackExternalTxId (string, optional) - Identifier of the transaction being rolled back. Required when txType is ROLLBACK. Must reference an existing transaction that was previously created. Can be null for DEPOSIT and WITHDRAWAL transaction types.
Object:
\ntxId (string, required) - Internal transaction identifier in the aggregator provider system. This is a unique identifier generated by the system and can be used for future reference or queries.
\nexternalTxId (string, required) - Transaction identifier from the request. If a transaction with this externalTxId and brandId already exists, the stored value is returned (idempotent behavior).
brandId (integer, required) - Brand id from the request. If the transaction already exists, the stored value is returned.
\nexternalUserId (string, required) - User identifier in the casino system from the request. If the transaction already exists, the stored value is returned.
\ncreatedAt (long, required) - Created at timestamp from the request. If the transaction already exists, the stored value is returned. Please refer to the common API documentation for timestamp format rules.
\ntxType (enum, required) - Transaction type from the request. Valid values: DEPOSIT, WITHDRAWAL, ROLLBACK. If the transaction already exists, the stored value is returned.
amount (integer, required) - Transaction amount from the request. If the transaction already exists, the stored value is returned. Please refer to the common API documentation for amount format rules.
\ncurrency (string, required) - Currency code from the request. If the transaction already exists, the stored value is returned. Please refer to the common API documentation for currency code rules.
\nrolledBackExternalTxId (string, optional) - Identifier of the rolled back transaction from the request. Required for rollback transactions. If the transaction already exists, the stored value is returned. Can be null for DEPOSIT and WITHDRAWAL transaction types.
{\n \"brandId\": 1,\n \"externalTxId\": \"tx-deposit-12345\",\n \"externalUserId\": \"user-abc-123\",\n \"createdAt\": 1704067200000,\n \"txType\": \"DEPOSIT\",\n \"amount\": 10000,\n \"currency\": \"USD\"\n}\n\n{\n \"brandId\": 1,\n \"externalTxId\": \"tx-withdrawal-67890\",\n \"externalUserId\": \"user-abc-123\",\n \"createdAt\": 1704067300000,\n \"txType\": \"WITHDRAWAL\",\n \"amount\": 5000,\n \"currency\": \"EUR\"\n}\n\n{\n \"brandId\": 1,\n \"externalTxId\": \"tx-rollback-11111\",\n \"externalUserId\": \"user-abc-123\",\n \"createdAt\": 1704067400000,\n \"txType\": \"ROLLBACK\",\n \"amount\": 10000,\n \"currency\": \"USD\",\n \"rolledBackExternalTxId\": \"tx-deposit-12345\"\n}\n\n{\n \"txId\": \"internal-tx-uuid-12345\",\n \"externalTxId\": \"tx-deposit-12345\",\n \"brandId\": 1,\n \"externalUserId\": \"user-abc-123\",\n \"createdAt\": 1704067200000,\n \"txType\": \"DEPOSIT\",\n \"amount\": 10000,\n \"currency\": \"USD\",\n \"rolledBackExternalTxId\": null\n}\n\nOccurs when request validation fails. Common causes:
\nMissing required fields
\nInvalid field formats (e.g., invalid currency code, invalid enum value)
\nBlank values for required string fields
\nInvalid integer or long values
\nExample Error Response:
\n{\n \"error\": \"Request validation failed\",\n \"message\": \"Field 'currency' must be a valid currency code\"\n}\n\nOccurs when the externalUserId does not exist in the system (user not registered).
Example Error Response:
\n{\n \"error\": \"Invalid user\",\n \"message\": \"User with externalUserId 'user-abc-123' not found\"\n}\n\nOccurs when txType is ROLLBACK but the rolledBackExternalTxId references a transaction that does not exist.
Example Error Response:
\n{\n \"error\": \"Rolled back transaction not found\",\n \"message\": \"Transaction with externalTxId 'tx-deposit-12345' not found\"\n}\n\nOccurs when txType is ROLLBACK but rolledBackExternalTxId is not provided.
Example Error Response:
\n{\n \"error\": \"Missing rolled back transaction ID\",\n \"message\": \"rolledBackExternalTxId is required for ROLLBACK transactions\"\n}\n\nOccurs when an unexpected server error happens.
\nExample Error Response:
\n{\n \"error\": \"Unknown error\",\n \"message\": \"An unexpected error occurred\"\n}\n\nIdempotency: The endpoint is idempotent. If you send the same request (same externalTxId and brandId) multiple times, you will receive the same response with the stored transaction data. This prevents duplicate transactions.
Transaction Uniqueness: The combination of externalTxId and brandId must be unique. Attempting to create a transaction with the same externalTxId and brandId but different data will return the existing transaction.
User Registration: The externalUserId must reference a user that was previously registered through the affiliate user registration endpoint.
Rollback Transactions:
\nWhen txType is ROLLBACK, the rolledBackExternalTxId field is required
The rolledBackExternalTxId must reference an existing transaction (DEPOSIT or WITHDRAWAL)
The amount in a rollback transaction should typically match the amount of the original transaction
Amount Format: Please refer to the common API documentation for amount format rules.
\nCurrency Codes: Please refer to the common API documentation for currency code rules.
\nTimestamp Format: Please refer to the common API documentation for timestamp format rules.
\nThis endpoint requires authentication. Please refer to the authentication documentation for details on how to include authentication headers in your requests.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{username}"},{"key":"password","value":"{password}"}]},"isInherited":true,"source":{"_postman_id":"ee5964aa-a7f4-41c1-b2fd-2f619fbe0678","id":"ee5964aa-a7f4-41c1-b2fd-2f619fbe0678","name":"Affiliate API","type":"folder"}},"urlObject":{"path":["external-casino-client","v1","affiliate","users","transactions","financial","create"],"host":["{apiUrl}"],"query":[],"variable":[]}},"response":[{"id":"13b9737a-8549-4c9e-958a-a97b1f7a72a6","name":"success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"externalTxId\": \"ext_787654324\",\n \"brandId\": 0,\n \"externalUserId\": \"ext_987654321\",\n \"createdAt\": 1761721205143,\n \"txType\": \"DEPOSIT\",\n \"amount\": 100,\n \"currency\": \"TRY\"\n}","options":{"raw":{"language":"json"}}},"url":"{apiUrl}/external-casino-client/v1/affiliate/users/transactions/financial/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"txId\": \"019a3404-b7f5-7b9e-abc3-1a3318c0b245\",\n \"externalTxId\": \"ext_787654324\",\n \"brandId\": 0,\n \"externalUserId\": \"ext_987654321\",\n \"createdAt\": 1761721205143,\n \"txType\": \"DEPOSIT\",\n \"amount\": 100,\n \"currency\": \"TRY\"\n}"},{"id":"15ae28a4-ecf6-42ea-ad3c-14d86a19017d","name":"success rollback","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"externalTxId\": \"ext_787654324\",\n \"brandId\": 0,\n \"externalUserId\": \"ext_987654321\",\n \"createdAt\": 1761721205143,\n \"txType\": \"ROLLBACK\",\n \"amount\": 100,\n \"currency\": \"TRY\",\n \"rolledBackExternalTxId\": \"ext_787654323\"\n}","options":{"raw":{"language":"json"}}},"url":"{apiUrl}/external-casino-client/v1/affiliate/users/transactions/financial/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"txId\": \"019a3404-b7f5-7b9e-abc3-1a3318c0b245\",\n \"externalTxId\": \"ext_787654324\",\n \"brandId\": 0,\n \"externalUserId\": \"ext_987654321\",\n \"createdAt\": 1761721205143,\n \"txType\": \"ROLLBACK\",\n \"amount\": 100,\n \"currency\": \"TRY\",\n \"rolledBackExternalTxId\": \"ext_787654323\"\n}"},{"id":"bb75fffd-c2a0-4f66-b182-73a3c3149344","name":"fail","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"externalTxId\": \"ext_787654324\",\n \"brandId\": 0,\n \"externalUserId\": \"ext_987654321\",\n \"createdAt\": 1761721205143,\n \"txType\": \"DEPOSIT\",\n \"amount\": 100,\n \"currency\": \"TRY\"\n}","options":{"raw":{"language":"json"}}},"url":"{apiUrl}/external-casino-client/v1/affiliate/users/transactions/financial/create"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"errorCode\": 109,\n \"errorMessage\": \"Invalid User\"\n}"}],"_postman_id":"3e963ecf-e231-4ea8-8d39-3c67aac3e13e"},{"name":"Get Affiliate Profile","id":"fc4bae02-8f92-4380-92c2-cda2b6df6f04","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"brandId\": 0,\n \"resolver\": {\n \"type\": \"TRACKER\",\n \"tracker\": {\n \"type\": \"TRACKING_CODE\",\n \"value\": \"AAJpzQHEQm5wU2wvSSizCB1ZwRzSeB\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{apiUrl}/external-casino-client/external-casino-client/v1/affiliate/profile/get","description":"POST /external-casino-client/v1/affiliate/profile/get
This endpoint allows external casino systems to retrieve affiliate profile information. The affiliate can be resolved either by direct ID or by a tracker (link code or tracking code).
\nObject:
\nbrandId (integer, required) - Brand id provided by aggregator provider. Must be a valid brand identifier.
\nresolver (object, required) - Defines how to resolve the affiliate. Uses polymorphic deserialization based on the type discriminator field. The resolver object has the following structure:
type (enum, required) - Resolution strategy type. Valid values:
\nID - Resolve affiliate directly by identifier
TRACKER - Resolve affiliate by tracker (link code or tracking code)
When type is ID:
When type is TRACKER:
tracker (object, required) - Tracking information used to resolve the affiliate. The tracker object has the following structure:
\ntype (enum, required) - Tracker type. Valid values:
\nTRACKING_CODE - Tracking code type
LINK_CODE - Link code type
value (string, required) - Tracker value. The value must be non-empty and cannot be blank. This validation applies to both TRACKING_CODE and LINK_CODE tracker types.
When tracker type is TRACKING_CODE:
The value must be a valid, non-expired tracking code token
\nThe tracking code must resolve to an existing affiliate link in the system
\nWhen tracker type is LINK_CODE:
The value must be a valid link short code
\nThe short code must reference an existing, non-deleted affiliate link in the system
\nIf the link is not found, error code 204 (Affiliate link not found) is returned
\nObject:
\nid (string, required) - Affiliate identifier in the aggregator provider system. UUID format.
\nusername (string, optional) - Affiliate login username. Can be null if the affiliate has no login assigned.
\nprofile (object, required) - Affiliate personal profile information. Contains personal details of the affiliate. The profile object has the following structure:
\nname (string, optional) - Affiliate first name. Can be null.
\nsurname (string, optional) - Affiliate surname. Can be null.
\ncountry (string, required) - Country ISO 3166-1 alpha-3 code (e.g., FRA, TUR, USA).
locale (string, required) - Affiliate locale code (e.g., tr_TR, en_US).
status (string, required) - Affiliate account status. Possible values: ACTIVE, SUSPENDED, CLOSED.
approveStatus (string, required) - Affiliate approval status. Possible values: APPROVED, REJECTED, PENDING.
companyName (string, optional) - Affiliate company name. Can be null.
\n{\n \"brandId\": 0,\n \"resolver\": {\n \"type\": \"ID\",\n \"id\": \"019d495b-bd90-7887-9403-b253b853f460\"\n }\n}\n\n{\n \"brandId\": 1,\n \"resolver\": {\n \"type\": \"TRACKER\",\n \"tracker\": {\n \"type\": \"LINK_CODE\",\n \"value\": \"abc123\"\n }\n }\n}\n\n{\n \"brandId\": 1,\n \"resolver\": {\n \"type\": \"TRACKER\",\n \"tracker\": {\n \"type\": \"TRACKING_CODE\",\n \"value\": \"AAJpzQHEQm5wU2wvSSizCB1ZwRzSeB\"\n }\n }\n}\n\n{\n \"id\": \"019d495b-bd90-7887-9403-b253b853f460\",\n \"username\": \"mehmet.demir\",\n \"name\": \"Mehmet\",\n \"surname\": \"Demir\",\n \"country\": \"TUR\",\n \"locale\": \"en_US\",\n \"status\": \"ACTIVE\",\n \"approveStatus\": \"APPROVED\",\n \"companyName\": \"Mehmet Soft\"\n}\n\nOccurs when the resolver.type is ID and the provided affiliate identifier does not exist in the system.
Example Error Response:
\n{\n \"errorCode\": 203,\n \"errorMessage\": \"Affiliate not found\"\n}\n\nOccurs when the resolver.type is TRACKER and the tracker value (link code or tracking code) does not resolve to an existing affiliate link.
Example Error Response:
\n{\n \"errorCode\": 204,\n \"errorMessage\": \"Affiliate link not found\"\n}\n\nOccurs when request validation fails. Common causes:
\nMissing required fields
\nInvalid field formats (e.g., invalid resolver type, invalid tracker type)
\nBlank values for required string fields
\nid exceeds maximum length of 36 characters
Example Error Response:
\n{\n \"errorCode\": 3,\n \"errorMessage\": \"Request validation failed: '...'\"\n}\n\nOccurs when an unexpected server error happens.
\nExample Error Response:
\n{\n \"errorCode\": 1,\n \"errorMessage\": \"Unknown error\"\n}\n\nResolution Strategies: The endpoint supports two resolution strategies via the resolver object:
ID - Direct lookup by affiliate identifier. Fastest resolution path.
TRACKER - Resolution through the affiliate tracking system. Supports both link codes and tracking codes.
Link Code Resolution: Link codes are short codes associated with affiliate links. The link must exist and not be deleted in the system.
\nAffiliate Status: The response includes both status and approveStatus fields. An affiliate is considered generally active when status is ACTIVE and approveStatus is APPROVED.
This endpoint requires authentication. Please refer to the authentication documentation for details on how to include authentication headers in your requests.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{username}"},{"key":"password","value":"{password}"}]},"isInherited":true,"source":{"_postman_id":"ee5964aa-a7f4-41c1-b2fd-2f619fbe0678","id":"ee5964aa-a7f4-41c1-b2fd-2f619fbe0678","name":"Affiliate API","type":"folder"}},"urlObject":{"path":["external-casino-client","external-casino-client","v1","affiliate","profile","get"],"host":["{apiUrl}"],"query":[],"variable":[]}},"response":[{"id":"7cfa3cd8-98cd-4848-84d9-8b683b0a064f","name":"success by tracker","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"brandId\": 0,\n \"resolver\": {\n \"type\": \"TRACKER\",\n \"tracker\": {\n \"type\": \"TRACKING_CODE\",\n \"value\": \"AAJpzQHEQm5wU2wvSSizCB1ZwRzSeB\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{apiUrl}/external-casino-client/v1/affiliate/profile/get"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"id\": \"019d495b-bd90-7887-9403-b253b853f460\",\n \"username\": \"mehmet.demir\",\n \"profile\": {\n \"name\": \"Mehmet\",\n \"surname\": \"Demir\",\n \"country\": \"TUR\",\n \"locale\": \"en_US\"\n },\n \"status\": \"ACTIVE\",\n \"approveStatus\": \"APPROVED\",\n \"companyName\": \"Mehmet Soft\"\n}"},{"id":"04b38415-9821-43ad-a3c1-72609c5f814d","name":"success by id","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"brandId\": 0,\n \"resolver\": {\n \"type\": \"ID\",\n \"id\": \"019d495b-bd90-7887-9403-b253b853f460\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{apiUrl}/external-casino-client/v1/affiliate/profile/get"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"id\": \"019d495b-bd90-7887-9403-b253b853f460\",\n \"username\": \"mehmet.demir\",\n \"profile\": {\n \"name\": \"Mehmet\",\n \"surname\": \"Demir\",\n \"country\": \"TUR\",\n \"locale\": \"en_US\"\n },\n \"status\": \"ACTIVE\",\n \"approveStatus\": \"APPROVED\",\n \"companyName\": \"Mehmet Soft\"\n}"},{"id":"6710a0eb-8745-4678-a117-f7804b0d0b65","name":"fail","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"brandId\": 0,\n \"resolver\": {\n \"type\": \"ID\",\n \"id\": \"019d495b-bd90-7887-9403-b253b853f460\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{apiUrl}/external-casino-client/v1/affiliate/profile/get"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"errorCode\": 203,\n \"errorMessage\": \"Affiliate not found\"\n}"}],"_postman_id":"fc4bae02-8f92-4380-92c2-cda2b6df6f04"}],"id":"087a91c4-aca4-4f77-8fe2-04b86f8d0508","description":"Requests sent from Casino to Aggregator Provider
\n","_postman_id":"087a91c4-aca4-4f77-8fe2-04b86f8d0508","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{username}"},{"key":"password","value":"{password}"}]},"isInherited":true,"source":{"_postman_id":"ee5964aa-a7f4-41c1-b2fd-2f619fbe0678","id":"ee5964aa-a7f4-41c1-b2fd-2f619fbe0678","name":"Affiliate API","type":"folder"}}}],"id":"ee5964aa-a7f4-41c1-b2fd-2f619fbe0678","description":"Before starting the integration, ensure you have:
\nAccess to the aggregator provider API
\nYour brandId assigned by the aggregator provider
Authentication credentials (API keys, tokens, etc.)
\nUnderstanding of your casino system's user registration flow
\nContact the aggregator provider to:
\nObtain your brandId
Get API credentials and authentication details
\nReceive API endpoint URLs
\nUnderstand any brand-specific requirements
\nReview API Documentation:
\nRead the Customer Registration API documentation
\nRead the Financial Transaction API documentation
\nUnderstand request/response format
\nThe system supports two types of tracking for affiliate attribution:
\nTRACKING_CODE)What it is: A unique link transaction code that attributes each redirect from an affiliate tracking link
\nHow it works:
\nGenerated automatically by the aggregator system for each click/redirect (unique per click)
\nUses a special encrypted format that contains attribution information
\nRequires a tracking domain to function
\nClicks are counted when users click the tracking link
\nUse case: When you need to track individual clicks and count redirects from affiliate links
\nFormat: Encrypted format generated automatically by the system
\nRequirement: Requires tracking domain setup
\nLINK_CODE)What it is: A static code assigned to a link that can be used to attribute users
\nHow it works:
\nGenerated randomly when creating a link in the Back Office
\nStatic code per link (doesn't change per click)
\nCan be used with Cuttly links to survive domain blocks
\nDoes not count clicks
\nUse case: When you need static attribution that works with short links (Cuttly) and can survive domain blocks
\nFormat: Randomly generated code created in Back Office
\nNote: Cannot be used for postbacks (server-to-server callbacks)
\nTracking codes are unique link transaction codes that are automatically generated by the aggregator system for each click/redirect from an affiliate tracking link. Each tracking code:
\nIs unique per click (not static)
\nContains encrypted attribution information
\nEnables click counting
\nRequires a tracking domain to function
\nLink Creation: An affiliate link is created with a link code in the Back Office
\nUser Clicks: When a user clicks the tracking link, the system automatically generates a unique tracking code
\nRedirect: User is redirected to your casino with the tracking code in the tid query parameter
Registration: Extract the tid parameter and include it in the registration request
Attribution: The system decrypts the tracking code and attributes the user to the affiliate
\nClick Counting: The click is counted when the tracking link is clicked
\nTracking codes work with tracking domains using the following structure:
\nInitial Link Format:
\nhttps://tracking.com/{link-code}\n\nAfter Click (Redirect):
When a user clicks the tracking link, they are redirected to your casino with a tid parameter:
https://yourcasino.com/register?tid={tracking-code}\n\nThe tid parameter contains the automatically generated tracking code (encrypted format).
When a user arrives at your registration page from a tracking domain, extract the tid parameter:
// Example JavaScript\nconst urlParams = new URLSearchParams(window.location.search);\nconst trackingCode = urlParams.get('tid');\n\n{\n \"brandId\": 1,\n \"externalUserId\": \"user-abc-123\",\n \"username\": \"johndoe\",\n \"locale\": \"en_US\",\n \"currency\": \"USD\",\n \"tracker\": {\n \"type\": \"TRACKING_CODE\",\n \"value\": trackingCode\n }\n}\n\nAutomatic Generation: Tracking codes are generated automatically - you don't create them manually
\nUnique Per Click: Each click generates a new tracking code
\nEncrypted Format: The tracking code uses a special encrypted format - don't try to decode or modify it
\nRequires Tracking Domain: Tracking codes only work with properly configured tracking domains
\nClick Counting: Clicks are counted automatically when users click the tracking link
\nLink codes are static codes assigned to affiliate links that can be used to attribute users. Unlike tracking codes:
\nStatic: The same code is used for all clicks on a specific link
\nNo Click Counting: Clicks are not counted with link codes
\nCuttly Compatible: Typically used with URL shorteners like Cuttly
\nDomain Block Survival: Can survive domain blocks through Cuttly link updates
\nQuery Parameter: Passed in the p query parameter
Link Creation: When creating an affiliate link in the Back Office, a link code is randomly generated
\nLink Distribution: The link code is embedded in the affiliate link (typically in a Cuttly short link)
\nUser Clicks Cuttly Link: When a user clicks the Cuttly link, they are redirected to your casino page
\nRedirect with Parameter: The redirect includes the p query parameter containing the link code
Extract Link Code: Extract the p parameter value from the URL
User Registration: Include the link code in the registration request to the aggregator
\nAttribution: The system uses the link code to attribute the user to the affiliate
\nLink codes are generated randomly when you create a link in the Back Office:
\nAccess the Back Office
\nCreate a new affiliate link
\nThe system automatically generates a random link code for that link
\nThe link code is static and remains the same for that specific link
\nCreate Link in Back Office: Generate a link code through the Back Office
\nCreate Cuttly Short Link: Use the Back Office to create a Cuttly short link
\nLink Format: The Cuttly link will redirect to your casino with the p query parameter containing the link code
User Clicks Cuttly Link: User clicks a Cuttly short link (e.g., https://cutt.ly/xyz123)
Redirect to Casino: Cuttly redirects the user to your casino page
\nURL with Parameter: The redirect URL includes the p query parameter: https://yourcasino.com/register?p={link-code}
Extract Parameter: Extract the p parameter value from the URL
Report to Aggregator: Include the link code in the registration request to the aggregator API
\nUser clicks: https://cutt.ly/abc123\n↓\nCuttly redirects to: https://yourcasino.com/register?p=link-code-67890\n↓\nExtract p parameter: \"link-code-67890\"\n↓\nInclude in registration API:\n{\n \"tracker\": {\n \"type\": \"LINK_CODE\",\n \"value\": \"link-code-67890\"\n }\n}\n\nIf your casino's main domain gets blocked:
\nDomain Rotation: Your external system should notify the aggregator provider about the domain rotation
\nAutomatic Update: The aggregator provider updates all Cuttly short links with your new domain
\nLink Continuity: All existing Cuttly links continue to work with the new domain
\nNo Link Recreation: You don't need to recreate or redistribute links
\nParameter Preservation: The p parameter is preserved through the domain update
{\n \"tracker\": {\n \"type\": \"LINK_CODE\",\n \"value\": \"abc123xyz789\"\n }\n}\n\nLink codes are always passed in the p query parameter. Extract the p parameter value from the URL:
// Example JavaScript - Extract p parameter\nconst urlParams = new URLSearchParams(window.location.search);\nconst linkCode = urlParams.get('p');\n\nWhen a user clicks a Cuttly link, they are redirected to your casino page with the p parameter:
Example URL after Cuttly redirect:
\nhttps://yourcasino.com/register?p=link-code-67890\n\nExtract and use:
\nconst urlParams = new URLSearchParams(window.location.search);\nconst linkCode = urlParams.get('p'); // Returns \"link-code-67890\"\n\nIf using link codes with tracking domains, the URL format is:
\nhttps://track.example.com/?p=abc123xyz789\n\nExtract the p parameter value the same way:
const urlParams = new URLSearchParams(window.location.search);\nconst linkCode = urlParams.get('p');\n\nAfter extracting the p parameter value, you must report it back to the aggregator in the registration API request. The link code should be included in the tracker field:
{\n \"brandId\": 1,\n \"externalUserId\": \"user-abc-123\",\n \"username\": \"johndoe\",\n \"locale\": \"en_US\",\n \"currency\": \"USD\",\n \"tracker\": {\n \"type\": \"LINK_CODE\",\n \"value\": \"link-code-67890\"\n }\n}\n\nStatic Codes: Link codes don't change per click - same code for all users clicking the same link
\nNo Click Counting: Link codes do not enable click counting
\nCuttly Compatible: Can be used with Cuttly short links
\nNot for Postbacks: Link codes cannot be used for server-to-server postbacks (use tracking domains instead)
\nDomain Block Protection: Cuttly links with link codes can be updated when domains are blocked
\nTracking domains are custom domains (e.g., track.yourbrand.com) that redirect users to your casino registration page while preserving affiliate tracking information through URL parameters. Tracking domains are required for:
Tracking Codes: Enable click counting and automatic tracking code generation
\nPostbacks: Required for server-to-server postback callbacks
\nTracking domains can be easily created via the Back Office. The process is simplified and handled through the aggregator provider's interface.
\nLog in to the Back Office
\nNavigate to the tracking domains section
\nSelect the option to create a new tracking domain
\nEnter your domain: Provide the domain name you want to use (e.g., trackingyourbrand.com)
Domain ownership: Ensure you have ownership rights to the domain
\nSubmit request: Submit the domain creation request through the Back Office
\nCreating tracking domains via Back Office provides:
\n✅ Simplified process: Easy-to-use interface for domain management
\n✅ Automatic configuration: Many settings are configured automatically
\n✅ Centralized management: Manage all tracking domains in one place
\n✅ Status monitoring: Track domain status and configuration in real-time
\nInitial Link: https://tracking.com/{link-code}\nAfter Click: https://yourcasino.com/register?tid={tracking-code}\n\n{link-code}: The link code created in Back Office
tid: Automatically generated tracking code (encrypted format) passed in redirect
https://tracking.com/?p={link-code}&campaign={campaign-id}&source={source}\n\np (required): Link code identifying the affiliate
campaign (optional): Campaign identifier
source (optional): Traffic source identifier
Use Tracking Domains for:
\nProduction environments requiring click counting
\nServer-to-server postbacks
\nUse Cuttly Links for:
\nWhen domain block survival is important
\nWhen click counting is not required
\nServer-to-server postbacks are not needed
\nAPI Documentation: See Customer Registration API and Financial Transaction API
\nContact: Reach out to the aggregator provider for:
\nTracking code generation
\nTracking domain setup assistance
\nAPI credentials and access
\nTechnical support
\nA: When you register a user with a tracking code, check the referrer field in the response. If it's not null, the tracking code was successfully resolved to an affiliate.
A: Yes, but not in the same request. Choose one tracking method per registration. You can use different methods for different affiliates or campaigns.
\nA: The user will be registered successfully, but the referrer field in the response will be null, indicating no affiliate attribution.
A: The Back Office setup is quick, but DNS propagation in worst cases may take up to 24-48 hours. SSL certificates are usually handled automatically by the aggregator provider.
\nA: Yes, tracking domains can be easily created via the Back Office. Simply log in, navigate to the tracking domains section, and follow the creation process.
\nA: No
\nA:
\nTracking Codes: Automatically generated unique codes per click, encrypted format, enable click counting, require tracking domains
\nLink Codes: Static codes generated randomly in Back Office, can be used with Cuttly links, don't count clicks, can survive domain blocks
\nA: No, Cuttly links cannot be used for server-to-server postbacks because they don't pass tracking parameters. You must use tracking domains for postbacks.
\nA: When your casino domain is blocked, notify the aggregator provider about the domain rotation via API.
\nA: Yes, tracking codes enable click counting. Clicks are counted automatically when users click the tracking link.
\nA: No, link codes do not count clicks. They only provide static attribution for user registration.
\nPostbacks are server-to-server callbacks used for:
\nRegistration tracking: Notifying external systems when a user successfully registers
\nTransaction tracking: Notifying external systems about financial transactions (first deposits, redeposits)
\nMust use Tracking Domains: Postbacks require tracking domains because they need to pass tracking parameters in server-to-server communication
\nCannot use Cuttly Links: Cuttly links do not work for postbacks because they don't pass tracking parameters through server-to-server calls
\nContact the aggregator provider for specific postback implementation details and requirements.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{username}"},{"key":"password","value":"{password}"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"33b401d6-62db-431c-999d-064a09ae7ed4"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"159ce817-922e-49d4-8601-34f8b4196fc6"}}],"_postman_id":"ee5964aa-a7f4-41c1-b2fd-2f619fbe0678"},{"name":"Error Response","item":[],"id":"d1d5244b-f0db-4d78-bfa2-de0b3e51641e","description":"Error response from Casino to Aggregator Provider and vice versa is the same
\nStatus Code: not 200
Object:
\nerrorCode (integer, required)
errorMessage (string, reqiured)
Error Codes:
\nResponse Example:
\n{\n \"errorCode\": 2,\n \"errorMessage\": \"Invalid credentials\"\n}\n\nAll responses to transaction callbacks must be idempotent
\nRollback transaction callback can be both for bet and win transactions
\nRollback transaction can be sent before transaction to rollback.
In this case rollback should be accepted and if transaction to rollback came later, it should be accepted too and response should be successful.
For both callbacks no balance changes must be processed
Average response time should be no more than 500 ms for good user experience. Request will be aborted if there is no response more than 5 seconds
\nIn case of loss win with 0 amount will be sent
\nEnd round callback doesn't produce any transaction. It is notification about round end
\nBets can be with amount 0
\nBets with 0 amount are retriable
\nBets with 0 amount must be always accepted
\nBets with not 0 amount are not retriable. Failed bet will cause rollback on bet
\nWins and Rollbacks are retriable
\nWins and Rollbacks must be always accepted
\nIf game has empty betValues, then it doesn't support free spins
\nPOST /external-casino-client/v1/domains/target/update
This endpoint allows external casino systems to change the current domain value of a casino. Traffic is redirected to this domain, which serves as the target for incoming traffic across various system components.
\nObject:
\nbrandId (integer, required) - Brand id provided by aggregator provider. Must be a valid brand identifier.
domain (string, required) - Domain to update.
type (enum, required) - Domain type. Valid values:
EXTERNAL - External type.name (string, required) - Domain name. Must be a valid domain name (for example example.com).
Object:
\nbrandId (integer, required) - Brand id provided by aggregator provider.
domain (object, required) - Updated domain. This is the domain that was successfully updated in the system.
type (enum, required) - Domain type.
name (string, required) - Updated domain name.