Response body goes here
Response body goes here
An authenticate request is needed for validating the external token passed to Playtech during the game launch flow. For extra security, the Operator has an option to return a permanent external token in the response to be used for wallet communication and treat the external token passed during the game launch as a temporary one. The authenticate request response must return also some player specific parameters, like currency and country, for Playtech to be able to create the player record on their side on the fly, in case it doesn't exist already. Under normal circumstances the Authenticate request is made only once per one game launch.
Used for retrieving player's balance snapshot from the Operator's wallet.
This request is used for placing a bet during the gameplay. It has a mandatory parameter to identify the game round, by which the Operator's wallet must decide whether to start a new game session or use an existing one. In case of bonus rounds, it has got reference to the parent game round. Bet amount defines the amount of money to be requested from the Operator's wallet. In case of free spins, it is 0. If free spins are used, Playtech's wallet bonus fund changes are described in the internal fund changes list.
This request is used for reporting game round result(s). It may or may not close the game round. Multiple GameRoundResults can be sent during one game round. A game round can result in lose, win or refund. In case of player losing, no transactional data is sent. Otherwise the pay amount is defined.
This request is primarily used for submitting the player's choice regarding the reality check timer. The dialog ID that was received in Bet response will be passed along with the request.
Used for retrieving player's balance snapshot by context from the Operator's wallet.
Sent to keep player login session alive during low activity game play.
Sent when the session expires on the Playtech side. The Operator can invalidate the session related to the given external token and not accept requests with it any more (except retries).
This request is to transfer funds to the Operator's wallet outside of a regular game round. This is mostly relevant in case of free spins with wagering requirements, where bonus winnings are released after the wagering has been completed.
This request is to notify the Operator about an event with bonus instance. Currently supports ACCEPTED and REMOVED status. The request is not sent by default and needs to be explicitly enabled for the integration.
This request is used to ask for funds from the operator's wallet when a player tips a dealer in a Live game.
Used in Italian regulation where Playtech games provide bring money dialog and Operator handles regulator communication. Sent when a player has chosen an amount to bring to the table and table session is started.
Used in Italian regulation where Playtech games provide bring money dialog and Operator handles regulator communication. Sent when table session is closed.
Used for synchronizing reality check status between Playtech and Operator.
Get all available permissions
Verify admin password
To create a new kiosk admin under the specific business entity
Create new admin limits
To get the information of the specific kiosk admin
To get the list of admin limits
To get the complete list of kiosk admins created under the specific bussiness entity
Authentificate admin by username and password
Move admin to another entity
Get permissions Admin permissions (inherited from role or set custom)
Remove admin limits
Reset failed login attempts for Admin
Set Admin custom permissions (role have to be set to custom first)
To save limits to admin
To update the information of specific kiosk admin
Change password for admin
Check if kiosk admin online or offline
Logout admin if admin is online
Add specific permissions for all active admin in specific entity
Remove specific permissions from all active admin from specific entity
Set specific permissions for all active admin in specific entity
Delete ip whitelisting from admin
Get ip whitelist from an admin
templatedetails
To get the list of all available custom reports
To get the data of the specific custom report
Decorators and post process JS
To get the required input parameters description of the specific custom report
Get custom report weight data
Get last aggregated date (in timezone TLE)
To get the list of entity balances
To get the list of broken games for all players
Drop Entity run time config caches
Create new entity balance
To add credits to child entity
To add bonus to child entity
To freeze entity and all it's admins, kiosks and subentities
To generate a new key for the specific business entity
To get the complete list of business entities created under the structure
To get the list of blocked IP address(es)
Move entity to another entity
To get the information of amount of min, max, per minute map of player online during selected period
Allow/disallow to create players in the entity
Remove entity balance
To get the list of business structure
To unblock kiosk admin's locked IP addresses using the Top admin account
To unfreeze entity and all it's admins, kiosks and subentities
To withdraw money from child entity
To withdraw bonus money from child entity
Check if entity online or offline
Get all online admins
Get all online entities
Logout all admins in entity if they are online
Logout entity if entity is online
setviplevel
Remove 2FA entity auth token so its became impossible to login with this entity
To generate a new key for the specific business entity.
Get is Entity 2FA auth enabled or not
Authentificate entity by name, key and 2fa - result secret token can be send as 'X-Entity-Secret' Header to authorise API calls
Reset failed login attempts for Entity
To get ip whitelist configuration propagated from an entity
Get ip whitelist from an entity
To get free spins list of bonuses 'name | bonusid' available for TLE
To add free spin point to a entity free spin balance
To remove free spin point from entity free spin balance
To get nearly real time games flow (up to 30 sec update delay), by default last fully processed minute games in response (It is not recommended to use a range more than 48 hours in the past)
To get nearly real time games flow , by start from 6 sec delay, manually start point can be set up to 48 hours in the past
Used for giving players free spins. It is possible to define the free spin count and the list of games in which it is usable together with the win wagering multiplier (if the correct bonus template is used). This request also creates a player record on-demand, meaning that the Operator must pass a couple of player related parameters. If the Operator is sure of having created the player record already, it can leave the player-specific fields empty.
Used for giving player golden chips based on a bonus template configured on Playtech side. It is possible to define the golden chips count, chip value and list of games in which it is usable. This request also creates a player record on the Playtech side on-demand, meaning that the Operator must pass a couple of player related parameters. If the Operator is sure of having created the player record already on the Playtech side (e.g. has successfully issued player a bonus at least one time), it can leave the player-specific fields empty.
Used for removing a bonus instance that has been given to the player. Requires the bonus instance code on the Playtech side to be passed.
Used for removing a Free Spin bonus instance that has been given to the player. Requires the bonus instance code on the Playtech side to be passed.
Used for removing a Goldenchip bonus instance that has been given to the player. Requires the bonus instance code on the Playtech side to be passed.
Returns a list of player's active bonuses. It includes the bonus name, the remaining amount or count depending on the bonus type, the remaining wagering requirements and bonus balance.
Used for logging out player login sessions on the Playtech side. If the player has a game window opened, they are notified about the logout.
Returns a list of player's non-active bonuses that have been issued in the last year. Maximum number of bonuses returned is 500, ordered by removal date (descending).
Used for showing messages to the player inside Playtech gaming clients. It is advised to use this call only when Operator is unable to show messages on top of Playtech gaming clients from their Portal (e.g. on mobile devices in redirect-mode). It should be used for messages that are not possible to return in External Wallet request responses (e.g. time based notifications). The message is displayed in all open Playtech gaming clients. Successful response means that Playtech has received the message, but actually player might not have seen it yet.
Used to notify Playtech about a responsible gaming limit that player has reached. This is relevant for download/native clients, where the operator is unable to handle regulatory requirements in the wrapping web page.
Used for retrieving the list of supported Free Spin bet values for a game or set of games. If multiple games are provided, then a list of common bet values across specified games is returned. Returned bet values are used to issue a Free Spin bonus to the player - at least one or more values must be provided.
Used for notifying Playtech system that the balance on external wallet side has changed and fresh balance should be requested.
This request returns the URL to the detailed game history view of a specific game round.
To get golden chips list of bonuses 'name | bonusid' available for TLE
Log admin login/logout
Log create admin
Log create entity
Log entity login
Execution log (entity exec logs)
Log player (except create)
Log structure (entity kioskadmin logs)
Seamless log (seamless exec logs)
Used for removing a bonus instance that has been given to the player. Requires the bonus instance code on the Playtech side to be passed.
To get the broken games of a player.
Updates or generates password for player.
To freeze player
To get player games of a session
To get the information of the specific player username
To get the list of all players created.
To logout the specific player from the game
Used for removing a bonus instance that has been given to the player. Requires the bonus instance code on the Playtech side to be passed.
To logout mass volume of players from the game.
To check if the player is currently online.
To remove temporary lock of the specific player account upon entering 3 incorrect username or password.
To revert the broken game of the specific player
To get specific player serials.
To get the sessions of a player
Get player tags
To unfreeze player.
To update the information of a specific player account
Verify if provided playername is fits name requirements and available to use
Get list of roles per TLE
Get permissions set per role
To get the information of the specific business entity
To create a new business entity
To update the information of the specific business entity
Clear 2FA for an admin
Generate 2FA for an admin
Get status of 2FA configuration for an admin
Used for removing a bonus instance that has been given to the player. Requires the bonus instance code on the Playtech side to be passed.