PlayStar Gaming System - Integration Service API
Page 1 of 100
PlayStar Gaming System
Integration Service API
PlayStar Gaming System - Integration Service API
Page 2 of 100
Table of Contents
Table of Contents 2
Revision History 3
Overview 8
1. General Notes 8
2. Game Playing 8
3. Access Token 9
API Reference 11
1. Game Launch (Host → PS) 12
2. Game download link (Optional) 19
3. Authenticate (PS → Host) 21
4. Logout (PS → Host) 23
5. Common Wallet (PS → Host) 24
6. Separate Wallet (Host → PS) 33
7. Data Feeds (Host → PS) 45
8. Game Administration (Host → PS) 93
Appendix 101
PlayStar Gaming System - Integration Service API
Page 3 of 100
Revision History
Version
Date
Comments
1.0
2015/11/23
Initial Release
1.1
2015/12/8
● Add a required field (host_id) to APIs which are
called from Host to PS.
● Add CreatePlayer to Funds Transfer
1.2
2015/12/11
● Add multiple languages support for the game
names.
1.3
2016/01/14
● Add a field (jackpot_group) to Game List
1.4
2016/01/17
● Add a field (game_id) to Bonus Award
1.5
2016/01/30
● Add a field (return_url) to Game Launch
1.6
2016/03/02
● Add Game History and Daily Summary to Data
Feeds
1.7
2016/03/02
● Add fields (bd, rd, ex…) to Game History
1.8
2016/03/15
● Add Result (Exceptional Case) to Game Play
1.9
2016/04/18
● Add a field (subgame_id) to Game Launch,
Bet/Bonus Award, Game List
● Add a field (sid) to Game History
● Add Game Status to Data Feeds
● Add a support language (ms-MY)
1.10
2016/05/04
● Add fields (game_id, subgame_id) to Result and
ResultEx
1.11
2016/05/15
● Add fields (start_dt, end_dt, type, min_times,
max_times) to Top Winners
● Add a support language (es-ES)
1.12
2016/05/16
● Add a field (type) to Game List
1.13
2016/05/21
● Add a field (member_id) to Top Winners
1.14
2016/05/26
● Add a field (sn) to Game History
● Add Error Accounts to Data Feeds
1.15
2016/05/31
● Add support for querying Game History without
member_id.
1.16
2016/06/27
● Add support for logout notification (Logout).
● Add timestamp to Bet, Result, ResultEx and
Bonus Award
1.17
2016/07/08
● Add a field (bonus_type) to Bonus Award
1.18
2016/07/20
● Add a field (bonus_win) to Result, ResultEx
1.19
2017/07/26
● Add a field (game_id) to Logout
● Add Clear Recovery to Game Administration
1.20
2016/10/10
● Add a field (member_id) to Daily Summary
1.21
2017/01/09
● Modify description of playing game in REAL
mode
1.22
2017/02/08
● Add a field (step) to Authenticate
1.23
2017/03/13
● Add a type to Game List
● Add Jackpot Winners to Data Feeds
● Add Get Balance to Game Play
1.24
2017/04/07
● Add a field (game_id) to Game History
PlayStar Gaming System - Integration Service API
Page 4 of 100
1.25
2017/04/12
● Add fields (dm, dtm) to Game History
1.26
2017/05/13
● Add fields (game_id, win_times) to Top Winners
1.27
2017/05/27
● Add Update Host API Info., Get Host API Info. to
Game Administration
1.28
2017/08/15
● Add Withdraw All, Log to Separate Wallet
● Add Kick Out to Game Administration
1.29
2017/08/22
● Fix a typo in Withdraw All
1.30
2017/08/22
● Add Error Codes to Deposit, Withdraw,
Withdraw All
1.31
2017/12/07
● Add a field (calc_by) to Top Winners
1.32
2018/02/18
● Add a field (feature) to Game List
● Rearrange category of slot game
1.33
2018/07/06
● Add language support (Korean)
● Add an error code (4: No More Bets) to Bet
1.34
2018/12/25
● Add a field (member_name) to Authenticate
1.35
2019/01/22
● Add maximum length of string fields.
1.36
2019/02/19
● Add Hourly Summary to Data Feeds
1.37
2019/03/18
● Add a field (host_type) to Game History
1.38
2019/03/25
● Add Sign In
● Add Jackpot Daily Contribution to Data Feeds
1.39
2019/04/23
● Add a type to Game List
● Add a field (host_type) to Jackpot Winners
● Add Uncompleted Games to Data Feeds
1.40
2019/05/09
● Add a field (return_target) to Game Launch
1.41
2019/05/13
● Modify the usage of the type/category
parameters of Game List
1.42
2019/06/10
● Add Update Member Info. and Get Member
Info. to Game Administration
1.43
2019/07/02
● Add a field (group_by) to Daily Summary and
Hourly Summary
● Add a field (host_type) to Daily Summary and
Hourly Summary
1.44
2019/07/05
● Remove language support (Korean)
● Add language support (Thai)
1.45
2019/07/24
● Add purpose of wallet to Separate Wallet for
supporting fish game.
1.46
2019/08/22
● Add fields (detail, fsd) to Game History
1.47
2019/09/09
● Add a field (bet) to Uncompleted Games
1.48
2019/10/03
● Add fields (game_id, game_type) to
DailySummary and Hourly Summary
● Add a field (game_type) to Game History
● Add new values to group_by of DailySummary
and Hourly Summary
1.49
2019/10/08
● Add a field (jd) to GameHistory
1.50
2019/10/17
● Add a field (balance) to Log of Separate Wallet
1.51
2019/10/22
● Add fields (start_dtm, end_dtm) to Jackpot
Winners
PlayStar Gaming System - Integration Service API
Page 5 of 100
1.52
2019/12/11
● Add a field (offln) to GameHistory
1.53
2020/02/04
● Add a field (jc) to GameHistory, DailySummary,
HourlySummary
● Change the data type of (tc) field of Jackpot
Daily Contribution from uint64 to double
1.54
2020/02/07
● Remove support of rd and ex of Game History
1.55
2020/03/25
● Add a field (jackpot_data) to Jackpot Winners
1.56
2020/04/16
● Modify max characters of member id and
member name to 64.
1.57
2020/04/17
● Add player_info to Sign In
● Add Change Password
1.58
2020/04/30
● Add support languages (ms-MY, ko-KR, vi-VN, id-
ID)
1.59
2020/05/26
● Add support for transferring PS coins
1.60
2020/07/14
● Add a field (jp_contrib) to Result
1.61
2020/08/03
● Add Minutely Summary To Data Feeds
● Add a field (dtm_type) to Jackpot Winner
1.62
2020/08/13
● Add a field (ipaddr) to Sign In, Change Password
1.63
2020/10/27
● Add two fields(category & minute_type) to
Minutely Summary
1.64
2020/11/05
● Add new value to category (CARD) of Game List,
GameHistory, Daily Summary, Hourly Summary
and Minutely Summary
1.65
2020/12/02
● Add new value to purpose of Get Balance
1.66
2020/12/17
● Add a field(message) to Result of Separate
Wallet
1.67
2021/01/25
● Add new value to category /
game_type(ARCADE) of Game List,
GameHistory, Daily Summary, Hourly Summary
and Minutely Summary
1.68
2021/01/26
● Add new value to minute_type of Minutely
Summary
1.69
2021/02/25
● Add a type to Game List
1.70
2021/03/19
● Add Eventlist, Eventrank, Eventawardlog
1.71
2021/06/16
● Add EventScoreawardlog
1.72
2021/07/07
● Add new value to purpose of Get Balance
1.73
2021/07/09
● Modify value to purpose of Get Balance
1.74
2021/07/13
● Add BanPlayer, GetBannedPlayer for Dummy
1.75
2021/08/30
● Add new value to purpose of Get Balance
1.76
2021/09/06
● Modify value to tm of uncompletedgames
1.77
2021/10/19
● Add value to type of Authenticate
1.78
2021/10/21
● Modify support category of Result
1.79
2021/10/27
● Add fields (betamt, winamt) to Result
1.80
2021/11/11
● Modify default type of Authenticate
1.81
2021/11/24
● Fixed getbalance Link
1.82
2021/12/2
● Remove the fish shooting only Separate Wallet
of General Notes
PlayStar Gaming System - Integration Service API
Page 6 of 100
1.83
2022/01/17
● Modify game support to Result
● Add field to Result (Exceptional Case)
1.84
2022/03/08
● Add value to purpose of Authenticate
1.85
2022/04/11
● Add Support language to Appendix
1.86
2022/05/19
● Add response value of Get Balance
1.87
2022/06/07
● Add value to purpose of Get Balance
1.88
2022/08/25
● Add field(winamt、betamt) to GameHistory
● Add support games to type 1 of Game List
1.89
2022/09/05
● Modify response status code of KickOut
1.90
2022/09/21
● Add value to retry result of Result
1.91
2022/10/04
● Add support arcade games to Result and Result
(Exceptional Case)
1.92
2022/10/05
● Add value to Game List
1.93
2022/10/06
● Add support arcade games to Game History
1.94
2023/03/07
● Add response value of Game History
1.95
2023/05/10
● Add support jackpot query of Jackpot Winners
1.96
2023/8/11
● Modify response status code of Clear Recovery
1.97
2023/8/29
● Add support game language of Appendix
1.98
2023/09/25
● Add Get Game Domain to Game Launch
1.99
2023/10/11
● Add response status code of Deposit
● Modify response status code of Kickout
2.00
2023/10/17
● Add Set Game Domain to Game Launch
2.01
2023/10/20
● Modify response value of Get Game Domain
2.02
2023/11/13
● Add Games Lobby to Game Launch
● Add Recommend Games to Game Launch
● Add Red Envelope Award Log to Data Feeds
● Remove deprecated field(type) of Game History
● Remove deprecated field(start_dt、end_dt) of
Jackpot Winners
● Fix response example of Daily Summary
● Fix response example of Hourly Summary
● Fix response example of Minutely Summary
2.03
2023/12/27
● Add Supported languages to Appendix
2.04
2024/3/4
● Modify value to purpose of Get Balance
2.05
2024/3/18
● Add Supported languages to Appendix
2.06
2024/4/9
● Remove unsupported content(App signin、App
changepwd、Baccarat Games)
2.07
2024/5/3
● Remove deprecated purpose value(PS Coin、
CANDY SMASH) of Get Balance
● Remove support for transferring PS coins
● Add Access Token description
2.08
2024/8/7
● Add Game Launch description
● Add a field (member_id) to Bet
● Add a field (member_id) to Result
2.09
2024/8/27c
● Remove fish、arcade、POK DENG、DUMMY、
PAI KANG、DUMMY KING、U4 game support
2.10
2024/9/23
● Add a field (game_id) to Refund Bet
PlayStar Gaming System - Integration Service API
Page 7 of 100
2.11
2024/11/4
● Add a field (member_id) to Authenticate,
Refund Bet, Bonus Award, Get Balance
2.12
2024/12/30
● Remove Common Wallet Result (Exceptional
Case)
2.14
2025/2/17
● Remove Get Game Domain API
● Remove Set Game Domain API
● Add Game download link API
2.15
2025/3/25
● Game download link return status_code
● Deposit, Withdraw, Withdraw All Block
duplicate order numbers
● Common Wallet Add status_code 5
2.16
2025/4/28
● Modify the description of the idle timeout
settings file in the overview
2.17
2025/5/12
● Add the field (e_tm) to the game history record
PlayStar Gaming System - Integration Service API
Page 8 of 100
Overview
This document describes the service integration between PlayStar Gaming System
(PS) and a host system/platform (Host). The following chapters describe the general
concept of integration as well as descriptions and examples of the API methods used
for the service integration.
1. General Notes
(1) Protocol:HTTPS
(2) Data Format:JSON (JavaScript Object Notation)
(3) Financial (Wallet)
● Options
■ Common Wallet (aka Single/Share/Seamless Wallet)
■ Separate Wallet (aka Transfer Wallet)
(4) Game clients are implemented using HTML5
(5) The Host manages the user account database (personal information, balance,
payment operations...etc.)
(6) The PS only manages the player data necessary to perform game operations.
(7) All money related numbers are represented in cent values. (1 dollar = 100
cents)
2. Game Playing
(1) Games can be launched in GUEST or REAL mode.
● GUEST mode
■ The player is playing with fun money which is set to the default value
upon starting a GUEST mode game session.
■ Games are not logged or recorded on the PS side, and no calls are made
to Host side.
● REAL mode
■ Games are played for real money.
■ Games are logged and recorded on the PS side.
■ If game client is disconnected from the game server when playing bonus
games, it will be continued when player reopen the game.
■ The unfinished games will be launched first.
(2) Support to launch multiple games simultaneously (must be different games).
(3) The default timeout period for a game session is 5 minutes. It can be
configured at will by host’s request.
PlayStar Gaming System - Integration Service API
Page 9 of 100
3. Access Token
Generated by the host itself, at least one group for each player, the signature can
have a validity period added (e.g., 2-5 minutes). It is recommended to use RSA-
SHA512 for encryption, and the content should be encoded in BASE64.
■ Example
MWYzYjFmDFhMTYwNjc3NmQ5MTVjMmViZWMxOTA1M2ZkMTllZTI2MTE2NDA4
MzQ4ZDJjYjcwMzkzMWY0NzZjMWY1ZjZlYWI2YjY=
PlayStar Gaming System - Integration Service API
Page 11 of 100
1. Game Launch (Host → PS)
PS provides two launch modes, including GUEST and REAL mode.
※ NOTE: The GUEST mode can be enabled/disabled from PS configuration at will by
the host’s request.
※ The game supports disconnection response/settlement functionality.
Disconnection Response: When a player disconnects during a game
■ If the disconnected game is a free game, the state at the time of
disconnection will be saved. When the player plays the same game again, it
will continue from the last disconnected state.
■ If the disconnected game is not a free game, the game will automatically
settle and complete that round.
Disconnection Settlement: When a player disconnects during a game, the backend
will automatically complete that round.
(1) GUEST mode: Launching a Game for Guest Players
● Request
Name
Type
Description
host_id
string
Unique ID of Host System (provided by PS)
game_id
string
Unique ID of PS Games (Max. 64 characters)
subgame_id
uint16
Optional. Sub-Game ID of PS Games
lang
string
Language for game client to start with. If language is
not specified or not supported, the default will be
used. (Please refer to Appendix: Supported
Languages)
return_url
string
Optional. The game will redirect the player to the
URL after pressing the home button.
return_target
string
Optional. The target window's URL will be replaced
with return_url. Possible values are described below:
String
Description
top
The outermost window (Default)
parent
The parent of the current window
self
The current window
PlayStar Gaming System - Integration Service API
Page 12 of 100
■ Example
https://{PS-API-
SERVER}/launch/?host_id=a62b545a3c56ec719257e82d60dbc518&game_id=PSS-
ON-00001&lang=en-US&return_url=http://{HOST-FRONT-END}/lobby/index.htm
● Response
(HTTP 302) Redirect to the download link of game.
● UML DIAGRAM
PlayStar Gaming System - Integration Service API
Page 13 of 100
(2) REAL mode: Launching a Game for Logged-In Players
※ NOTE: To verify access tokens, the host system must provide corresponding
API to PS side. For more information about the API, please refer to
Authenticate (PS → Host).
● Request
Name
Type
Description
host_id
string
Unique ID of Host System (provided by PS)
game_id
string
Unique ID of PS Games (Max. 64 characters)
subgame_id
uint16
Optional. Sub-Game ID of PS Games
lang
string
Language for game client to start with. If language
is not specified or not supported, the default will be
used. (Please refer to Appendix: Supported
Languages)
access_token
string
The access token is generated and verified by host
system for the player's current session.
return_url
string
Optional. The game will redirect the player to the
URL after pressing the home button.
return_target
string
Optional. The target window's URL will be replaced
with return_url. Possible values are described
below:
String
Description
top
The outermost window (Default)
parent
The parent of the current window
self
The current window
■ Example
https://{PS-API-
SERVER}/launch/?host_id=a62b545a3c56ec719257e82d60dbc518&game_id=PSS-
ON-00001&lang=en-
US&access_token=bdvaHBSEipVcv9TuZPQxZvolqEIanjaTedG5MCxaGjFZ2xTLc7&ret
urn_url=http://{HOST-FRONT-END}/lobby/index.htm
● Response
(HTTP 302) Redirect to the download link of game.
PlayStar Gaming System - Integration Service API
Page 14 of 100
● UML DIAGRAM
PlayStar Gaming System - Integration Service API
Page 15 of 100
(3) ★Games Lobby
Overview of all supported games
● Request
Name
Type
Description
host_id
string
Unique ID of Host System (provided by PS)
game_id
string
Unique ID of PS Games (Only support PS-LOBBY)
lang
string
Language for game client to start with. If language
is not specified or not supported, the default will be
used. (Please refer to Appendix: Supported
Languages)
access_token
string
The access token is generated and verified by host
system for the player's current session.
■ Example
https://{PS-API-
SERVER}/launch/?host_id=dd12f3635bc9599ca58012601d07197c&game_id=PS-
LOBBY&lang=en-
US&access_token=eyJpdiI6IjR3Z0pGYnBPMWJ6SHdUaUIzSitvalE9PSIsInZhbHVlIjoi
SFg4UlAzM3RsNHFqMit4V3d4WVZ0UT09IiwibWFjIjoiMzZmNjBjMGU1ZjljMmQ1Z
DAwYzZiNjI1NzRjNTMwZGFjNzc3ZTNlODJjYTg0NTBiMjcxYWEwNzc3MDY3YTFlMiJ
9
● Response
(HTTP 302) Redirect to the ps lobby link of game.
PlayStar Gaming System - Integration Service API
Page 16 of 100
(4) ★Recommend Games
Check the list of popular recommended games
● Request
Name
Type
Description
host_id
string
Unique ID of Host System (provided by PS)
order
string
Optional
Type
Description
0
Recommend (default)
1
Game ID
■ Example
https://{PS-API-
SERVER}/feed/gamelist?host_id=dd12f3635bc9599ca58012601d07197c&order=0
● Response
Name
Type
Description
game_id
string
Unique ID of PS Games (Max. 64 characters)
type
string
Type of PS Games (Max. 32 characters).
Possible values as below:
Type
Description
SLOT
Slot Machine
subgame_id
uint16
Sub-Game ID of PS Games. (0 means not set)
group_id
uint16
Group ID of PS Games. (0 means not set)
game_name
object
The name of PS Games in multiple languages.
Currently only support English (en-US), Chinese
Simplified (zh-CN), Traditional Chinese (zh-TW).
jackpot_group
int
Jackpot Group ID (0 means not set)
category
uint32
[SLOT] Game Category.
volatility
uint16
[SLOT] Game Volatility (1~5)
feature
string
[SLOT] Game Feature (Max. 16 characters)
min_bet
uint64
Minimum Bet (in cents)
max_bet
uint64
Maximum Bet (in cents)
PlayStar Gaming System - Integration Service API
Page 17 of 100
■ Response Example
[
{
"game_id": "PSS-ON-00003",
"type": "SLOT",
"subgame_id": 0,
"group_id": 0,
"game_name": {
"en-US": "SLOT-3",
"zh-TW": "SLOT-3",
"zh-CN": "SLOT-3"
},
"jackpot_group": 1,
"category": 1,
"volatility":2,
"feature": "243 Ways",
"min_bet": 30,
"max_bet": 60000
},
{
"game_id": "PSS-ON-00006",
"type": "SLOT",
"subgame_id": 0,
"group_id": 0,
"game_name": {
"en-US": "SLOT-6",
"zh-TW": "SLOT-6",
"zh-CN": "SLOT-6"
},
"jackpot_group": 1,
"category": 2,
"volatility":2,
"feature": "20 Lines",
"min_bet": 20,
"max_bet": 60000
}
]
PlayStar Gaming System - Integration Service API
Page 18 of 100
2. Game download link (Optional)
Directly obtain the game download link, support free trial and real mode, support 4.
API Encryption.
● Request
Name
Type
Description
host_id
string
Unique ID of Host System (provided by PS)
game_id
string
Unique ID of PS Games (Max. 64 characters)
subgame_id
uint16
Optional. Sub-Game ID of PS Games
lang
string
Language for game client to start with. If language
is not specified or not supported, the default will be
used. (Please refer to Appendix: Supported
Languages)
access_token
string
The access token is generated and verified by host
system for the player's current session.(Real mode
required)
return_url
string
Optional. The game will redirect the player to the
URL after pressing the home button.
return_target
string
Optional. The target window's URL will be replaced
with return_url. Possible values are described
below:
String
Description
top
The outermost window (Default)
parent
The parent of the current window
self
The current window
PlayStar Gaming System - Integration Service API
Page 19 of 100
■ Example
https://{PS-API-
SERVER}/host/GetLaunchURL/?host_id=a62b545a3c56ec719257e82d60dbc518&g
ame_id=PSS-ON-00001&subgame_id=0&lang=en-
US&access_token=bdvaHBSEipVcv9TuZPQxZvolqEIanjaTedG5MCxaGjFZ2xTLc7
■ Response Example
{
"status_code": 0,
"url": "~/game/PSS-ON-
00001/?access_token=bdvaHBSEipVcv9TuZPQxZvolqEIanjaTedG5MCxaGjFZ2xTLc7
(*-
-)a62b545a3c56ec719257e82d60dbc518&lang=eng&ccy=CNY&sm=00&subid=0&f
ullscr=1&lc=en-US&pm=0&ns=1",
"site_name": "SLOT"
}
PlayStar Gaming System - Integration Service API
Page 20 of 100
3. Authenticate (PS → Host)
Verify the access token sent from PS. The method is called on launching the game for
the logged-in player.
● Request
Name
Type
Description
access_token
string
The access token is generated by host system for
the player's current session.
step
int
Optional. The current step of authentication.
Type
Description
0
Checking Unfinished Game
1
Login
member_id
string
Unique ID of player (Max. 64 characters)
■ Example
https://{Host-API-
Server}/api/authenticate/?access_token=bdvaHBSEipVcv9TuZPQxZvolqEIanjaTedG
5MCxaGjFZ2xTLc7&step=1
● Response
Name
Type
Description
status_code
int
Possible values are described below:
Code
Description
0
Success
1
Invalid Token
member_id
string
Unique ID of the player (Max. 64 characters)
member_name
string
Optional. Nickname of the player (Max. 64
characters)
balance
uint64
Current balance of the player (in cents)
※ This field is ignored if use separate wallet.
type
int
Optional. User type.
Type
Description
0
Cash (Default)
1
Credit
■ Response Example
{
"status_code": 0,
"member_id": "test1",
"member_name": "TestPlayer1",
"balance": 1283200,
"type": 0
PlayStar Gaming System - Integration Service API
Page 21 of 100
}
● UML DIAGRAM
PlayStar Gaming System - Integration Service API
Page 22 of 100
4. Logout (PS → Host)
PS sends this request to Host to notify player leaving the game. (Optional)
● Request
Name
Type
Description
access_token
string
The access token is verified by host system for the
player's current session.
game_id
string
Unique ID of PS Games (Max. 64 characters)
subgame_id
uint16
Optional. Sub-Game ID of PS Games
■ Example
https://{Host-API-
Server}/api/logout/?access_token=bdvaHBSEipVcv9TuZPQxZvolqEIanjaTedG5MCx
aGjFZ2xTLc7&game_id=PSS-ON-00003
● Response
Name
Type
Description
status_code
int
Possible values are described below:
Code
Description
0
Success
1
Invalid Token
■ Response Example
{
"status_code": 0
}
PlayStar Gaming System - Integration Service API
Page 23 of 100
5. Common Wallet (PS → Host)
When a host wishes to integrate an external wallet to fund game play on a wager by
wager basis.
Each time a user places a wager or a wager is settled the game server sends a
request to the external wallet. The calls made are:
(1) Bet
(2) Result
(3) Refund Bet
(4) Bonus Award
(5) Get Balance
PlayStar Gaming System - Integration Service API
Page 24 of 100
(1) Bet
● Request
Name
Type
Description
access_token
string
The access token is verified by host system for the
player's current session.
txn_id
uint64
Unique ID of the transaction on the PS side.
total_bet
uint64
Amount of the bet (in cents).
game_id
string
Unique ID of PS Games (Max. 64 characters)
subgame_id
uint16
Sub-Game ID of PS Games
ts
uint64
The UTC timestamp (in seconds) of the beginning of
the round.
member_id
string
Optional. Unique ID of player (Max. 64 characters)
■ Example
https://{Host-API-
Server}/api/bet/?access_token=bdvaHBSEipVcv9TuZPQxZvolqEIanjaTedG5MCxaG
jFZ2xTLc7&txn_id=123&total_bet=3000&game_id=PSS-ON-
00003&subgame_id=0&ts=12345
● Response
Name
Type
Description
status_code
int
Possible values are described below:
Code
Description
0
Success
1
Invalid Token
2
Invalid Transaction ID
3
Insufficient Funds
4
5
No More Bets
System Error
balance
uint64
Current balance of the player (in cents)
■ Response Example
{
"status_code": 0,
"balance": 1283200
}
PlayStar Gaming System - Integration Service API
Page 25 of 100
● UML DIAGRAM
PlayStar Gaming System - Integration Service API
Page 26 of 100
(2) Result
● Request
Name
Type
Description
access_token
string
The access token is verified by host system for the
player's current session.
txn_id
uint64
Unique ID of the transaction.
total_win
uint64
Amount of win (in cents, including bonus win).
bonus_win
uint64
Amount of bonus win (in cents).
game_id
string
Unique ID of PS Games (Max. 64 characters)
subgame_id
uint16
Sub-Game ID of PS Games
ts
uint64
The UTC timestamp (in seconds) of the end of the
round.
jp_contrib
double
The amount of jackpot contribution (in cents,
round off to 2
nd
decimal place)
betamt
uint64
Optional. Valid bet (Only Card Games)
winamt
uint64
Optional. Valid win (Only Card Games)
member_id
string
Optional. Unique ID of player (Max. 64 characters)
■ Example
https://{Host-API-
Server}/api/result/?access_token=bdvaHBSEipVcv9TuZPQxZvolqEIanjaTedG5MCx
aGjFZ2xTLc7&txn_id=123&total_win=10000&game_id=PSS-ON-
00003&subgame_id=0&ts=12345& jp_contrib=50.12&betamt=500&winamt=50
● Response
Name
Type
Description
status_code
int
Possible values are described below:
Code
Description
0
Success
1
Invalid Token
2
5
Invalid Transaction ID
System Error
balance
uint64
Current balance of the player (in cents)
■ Response Example
{
"status_code": 0,
"balance": 1283200
}
PlayStar Gaming System - Integration Service API
Page 27 of 100
● UML DIAGRAM
PlayStar Gaming System - Integration Service API
Page 28 of 100
(3) Refund Bet
PS sends this request to Host to cancel the latest Bet call if system error
occurred.
● Request
Name
Type
Description
access_token
string
The access token is generated by host system for
the player's current session.
txn_id
uint64
Unique ID of the transaction.
game_id
string
Unique ID of PS Games (Max. 64 characters)
(Only Slot Games)
member_id
string
Unique ID of player (Max. 64 characters)
■ Example
https://{Host-API-
Server}/api/refund/?access_token=bdvaHBSEipVcv9TuZPQxZvolqEIanjaTedG5MCx
aGjFZ2xTLc7&txn_id=123
● Response
Name
Type
Description
status_code
int
Possible values are described below:
Code
Description
0
Success
1
Invalid Token
2
5
Invalid Transaction ID
System Error
balance
uint64
Current balance of the player (in cents)
PlayStar Gaming System - Integration Service API
Page 29 of 100
■ Response Example
{
"status_code": 0,
"balance": 1286200
}
● UML DIAGRAM
PlayStar Gaming System - Integration Service API
Page 30 of 100
(4) Bonus Award
PS sends this request to Host to release a bonus (such as jackpot award) to the
player's balance.
● Request
Name
Type
Description
access_token
string
The access token is generated by host system for
the player's current session.
bonus_id
uint64
Unique ID of the bonus.
bonus_reward
uint64
Amount of the bonus reward (in cents).
bonus_type
string
Type of the bonus. (Max. 12 characters)
game_id
string
Unique ID of PS Games (Max. 64 characters)
subgame_id
uint16
Sub-Game ID of PS Games
txn_id
uint64
Unique ID of the game round that is bound to the
bonus.
member_id
string
Unique ID of player (Max. 64 characters)
■ Example
https://{HostAPIServer}/api/bonusaward/?access_token=bdvaHBSEipVcv9TuZPQx
ZvolqEIanjaTedG5MCxaGjFZ2xTLc7&bonus_id=234&bonus_reward=13245&bonu
s_type=JP2&game_id=PSS-ON-00003&subgame_id=0&txn_id=123
● Response
Name
Type
Description
status_code
int
Possible values are described below:
Code
Description
0
Success
1
Invalid Token
2
5
Invalid Bonus ID
System Error
balance
uint64
Current balance of the player (in cents)
■ Response Example
{
"status_code": 0,
"balance": 1306445
}
PlayStar Gaming System - Integration Service API
Page 31 of 100
(5) Get Balance
For querying the balance of a particular player account.
● Request
Name
Type
Description
access_token
string
The access token is generated by host system for
the player's current session.
member_id
string
Unique ID of player (Max. 64 characters)
■ Example
https://{Host-API-
Server}/api/getbalance/?access_token=bdvaHBSEipVcv9TuZPQxZvolqEIanjaTedG5
MCxaGjFZ2xTLc7
● Response
Name
Type
Description
status_code
int
Possible values are described below:
Code
Description
0
Success
1
5
Invalid Member ID
System Error
balance
uint64
Current balance of the player (in cents)
■ Response Example
{
"status_code": 0,
"balance": 1283200
}
PlayStar Gaming System - Integration Service API
Page 32 of 100
6. Separate Wallet (Host → PS)
When a host wishes to use a separate account, the integration is done via a set of
API offered by PS. Funds are deposited and withdrawn to the PS with API calls. The
relevant API calls are:
※ NOTE: The following APIs require a "Funds" whitelist to set up additionally.
※ In order to operate the APIs, please inform the customer support ahead.
(1) CreatePlayer
(2) Get Balance
(3) Deposit
(4) Withdraw
(5) Withdraw All
(6) Log
PlayStar Gaming System - Integration Service API
Page 33 of 100
(1) Create Player
For creating new player account, the createplayer API call should be used.
● Request
Name
Type
Description
host_id
string
Unique ID of Host System (provided by PS)
member_id
string
Unique ID of the player (Max. 64 characters)
purpose
uint16
Optional. The purpose of wallet, possible values are
described below:
Value
Description
0
General (Default)
■ Example
https://{PS-API-
SERVER}/funds/createplayer/?host_id=a62b545a3c56ec719257e82d60dbc518&m
ember_id=test1
● Response
Name
Type
Description
status_code
int
Possible values are described below:
Code
Description
0
Success
2
Invalid Host ID
5
System Error
9
Invalid Wallet Type
10
Invalid Purpose
balance
uint64
Current balance of the player (in cents)
message
string
Extra message
■ Response Example
{
"status_code": 0,
"balance": 0,
“message”: “”
}
PlayStar Gaming System - Integration Service API
Page 34 of 100
(2) Get Balance
For querying the balance of a particular player account.
● Request
Name
Type
Description
host_id
string
Unique ID of Host System (provided by PS)
member_id
string
Unique ID of the player (Max. 64 characters)
purpose
uint16
Optional. The purpose of wallet, possible values are
described below:
Value
Description
130
total
0
General (Default)
3
Dummy2
7
color game
8
Tongits
■ Example
https://{PS-API-
SERVER}/funds/getbalance/?host_id=a62b545a3c56ec719257e82d60dbc518&me
mber_id=test1
● Response
Name
Type
Description
status_code
int
Possible values are described below:
Code
Description
0
Success
1
Invalid Member ID
2
Invalid Host ID
5
System Error
9
Invalid Wallet Type
10
Invalid Purpose
11
Dummy2 Maintenance
balance
uint64
Current balance of the player (in cents)
message
string
Extra message
■ Response Example
{
"status_code": 0,
"balance": 1283200,
“message”: “”
}
PlayStar Gaming System - Integration Service API
Page 35 of 100
PlayStar Gaming System - Integration Service API
Page 36 of 100
(3) Deposit
For transferring funds into the player account, the deposit API call should be
used.
● Request
Name
Type
Description
host_id
string
Unique ID of Host System (provided by PS)
member_id
string
Unique ID of the player (Max. 64 characters)
txn_id
uint64
Unique ID of the transaction on Host side.
※ This field will be ignored if purpose is 2.
※ Nonrepeatable, Maximum length 20 characters
amount
uint64
Amount of funds to be transfer into (in cents).
purpose
uint16
Optional. The purpose of wallet, possible values are
described below:
Value
Description
0
General (Default)
■ Example
https://{PS-API-
SERVER}/funds/deposit/?host_id=a62b545a3c56ec719257e82d60dbc518&membe
r_id=test1&txn_id=123&amount=100
● Response
Name
Type
Description
status_code
int
Possible values are described below:
Code
Description
0
Success
1
Invalid Member ID
2
Invalid Host ID
3
Invalid Transaction ID
5
System Error
7
Zero Amount
9
Invalid Wallet Type
10
Invalid Purpose
12
Duplicate order number
balance
uint64
Current balance of the player (in cents)
message
string
Extra message
PlayStar Gaming System - Integration Service API
Page 37 of 100
■ Response Example
{
"status_code": 0,
"balance": 1283200,
“message”: “”
}
PlayStar Gaming System - Integration Service API
Page 38 of 100
(4) Withdraw
For transferring funds out of the player account, the withdraw API call should
be used.
● Request
Name
Type
Description
host_id
string
Unique ID of Host System (provided by PS)
member_id
string
Unique ID of the player (Max. 64 characters)
txn_id
uint64
Unique ID of the transaction on Host side.
※ This field will be ignored if purpose is 2.
※ Nonrepeatable, Maximum length 20
characters
amount
uint64
Amount of funds to be transfer out (in cents).
purpose
uint16
Optional. The purpose of wallet, possible values are
described below:
Value
Description
0
General (Default)
■ Example
https://{PS-API-
SERVER}/funds/withdraw/?host_id=a62b545a3c56ec719257e82d60dbc518&mem
ber_id=test1&txn_id=124&amount=100
● Response
Name
Type
Description
status_code
int
Possible values are described below:
Code
Description
0
Success
1
Invalid Member ID
2
Invalid Host ID
3
Invalid Transaction ID
5
System Error
7
Zero Amount
8
Insufficient Funds
9
Invalid Wallet Type
10
12
Invalid Purpose
Duplicate order number
balance
uint64
Current balance of the player (in cents)
message
string
Extra message
PlayStar Gaming System - Integration Service API
Page 39 of 100
■ Response Example
{
"status_code": 0,
"balance": 1283200,
“message”: “”
}
PlayStar Gaming System - Integration Service API
Page 40 of 100
(5) Withdraw All
For transferring all funds out of the player account, the withdraw all API call
should be used.
● Request
Name
Type
Description
host_id
string
Unique ID of Host System (provided by PS)
member_id
string
Unique ID of the player (Max. 64 characters)
txn_id
uint6
4
Unique ID of the transaction on Host side.
※ This field will be ignored if purpose is 2.
※ Nonrepeatable, Maximum length 20 characters
purpose
uint1
6
Optional. The purpose of wallet, possible values are
described below:
Value
Description
0
General (Default)
■ Example
https://{PS-API-
SERVER}/funds/withdrawall/?host_id=a62b545a3c56ec719257e82d60dbc518&me
mber_id=test1&txn_id=124
● Response
Name
Type
Description
status_code
int
Possible values are described below:
Code
Description
0
Success
1
Invalid Member ID
2
Invalid Host ID
3
Invalid Transaction ID
5
System Error
8
Insufficient Funds
9
Invalid Wallet Type
10
12
Invalid Purpose
Duplicate order number
amount
uint64
Amount of funds to be transfer out (in cents).
message
string
Extra message
PlayStar Gaming System - Integration Service API
Page 41 of 100
■ Response Example
{
"status_code": 0,
"amount": 1283200,
“message”: “”
}
PlayStar Gaming System - Integration Service API
Page 42 of 100
(6) Log
PS provides a data feed to obtain logs of transferring funds.
● Request
Name
Type
Description
host_id
string
Unique ID of Host System (provided by PS)
member_id
string
Optional. Unique ID of the player (Max. 64 characters)
purpose
uint16
Optional. The purpose of wallet, possible values are
described below:
Value
Description
0
General (Default)
type
int
Optional. The type of transferring funds. Possible values
are described below:
Value
Description
0
Deposit
1
Withdraw
txn_id
uint64
Optional. Unique ID of the transaction on Host side.
※ When this field is present, the fields "member_id",
"start_dtm" and "end_dtm" are ignored
※ Maximum length 20 characters
start_dtm
string
Optional. The start date-time of date-time range to
search on. (default is today's date)
The format is yyyy-MM-ddTHH:mm:ss
end_dtm
string
Optional. The end date-time of date-time range to
search on. (default is today's date)
■ Example
https://{PS-API-
SERVER}/funds/log/?host_id=a62b545a3c56ec719257e82d60dbc518&member_id
=test1
PlayStar Gaming System - Integration Service API
Page 43 of 100
● Response
Name
Type
Description
txn_id
uint64
Unique ID of the transaction on Host side.
type
int
The type of transferring funds. Possible values are
described below:
Value
Description
0
Deposit
1
Withdraw
member_id
string
Unique ID of the player (Max. 64 characters)
amount
uint64
Amount of funds to be transfer out (in cents).
dtm
string
The occurred date/time.
balance
uint64
The balance after the transaction.
■ Response Example
[
{"txn_id":123,"type":0,"member_id":"test1","amount":100,
"dtm":"2016-02-28T15:30:56","balance":100},
{"txn_id":139,"type":1,"member_id":"test1","amount":120,
"dtm":"2016-02-28T16:28:05","balance":0}
]
PlayStar Gaming System - Integration Service API
Page 44 of 100
7. Data Feeds (Host → PS)
PS provides the following data feeds which can be utilized for the front-end website
of Host.
(1) Game List
(2) Top Winners
(3) Jackpot Pools
(4) Jackpot Winners
(5) Jackpot Daily Contribution
(6) Game History
(7) Daily Summary
(8) Hourly Summary
(9) Minutely Summary
(10) Error Accounts
(11) Uncompleted Games
(12) Eventlist
(13) EventRank
(14) Eventawardlog
(15) Event Score Award Log
(16) Red Envelope Award Log
(17) GetBannedPlayer
(18) Ban/Unban
PlayStar Gaming System - Integration Service API
Page 45 of 100
(1) Game List
PS provides a data feed to obtain a list of all available games for a host system.
● Request
Name
Type
Description
host_id
string
Unique ID of Host System (provided by PS)
type
int
Optional. Possible values as below:
Type
Description
0
All Games (default)
1
Most Favorite Games
2
List Slot Games By Category
3
List Games By Game Type
category
uint32
Optional
Be used when type=2, use 4 byte (32 Bits) to store game
categories, one bit per category, up to 32. Possible values
as below:
Category
Description
1
New
2
Hot
4
Exciting/Challenge
8
Mystery Jackpot
string
Be used when type=3, Possible values as below:
Type
Description
SLOT
Slot Game - General
SLOT-TM
Slot Game - Tile-Matching Series
CARD
Card Games
※This field will be ignored if type is not 2 or 3.
order
string
Optional
Type
Description
0
Recommend (default)
1
Game ID
■ Example
https://{PS-API-
SERVER}/feed/gamelist?host_id=a62b545a3c56ec719257e82d60dbc518
PlayStar Gaming System - Integration Service API
Page 46 of 100
● Response
Name
Type
Description
game_id
string
Unique ID of PS Games (Max. 64 characters)
type
string
Type of PS Games (Max. 32 characters).
Possible values as below:
Type
Description
SLOT
Slot Machine
subgame_id
uint16
Sub-Game ID of PS Games. (0 means not set)
group_id
uint16
Group ID of PS Games. (0 means not set)
game_name
object
The name of PS Games in multiple languages.
Currently only support English (en-US), Chinese
Simplified (zh-CN), Traditional Chinese (zh-TW).
jackpot_group
int
Jackpot Group ID (0 means not set)
category
uint32
[SLOT] Game Category.
volatility
uint16
[SLOT] Game Volatility (1~5)
feature
string
[SLOT] Game Feature (Max. 16 characters)
min_bet
uint64
Minimum Bet (in cents)
max_bet
uint64
Maximum Bet (in cents)
■ Response Example
[
{
"game_id": "PSS-ON-00003",
"type": "SLOT",
"subgame_id": 0,
"group_id": 0,
"game_name": {
"en-US": "SLOT-3",
"zh-TW": "SLOT-3",
"zh-CN": "SLOT-3"
},
"jackpot_group": 1,
"category": 1,
"volatility":2,
"feature": "243 Ways",
"min_bet": 30,
"max_bet": 60000
},
{
"game_id": "PSS-ON-00006",
"type": "SLOT",
"subgame_id": 0,
"group_id": 0,
"game_name": {
"en-US": "SLOT-6",
"zh-TW": "SLOT-6",
"zh-CN": "SLOT-6"
PlayStar Gaming System - Integration Service API
Page 47 of 100
},
"jackpot_group": 1,
"category": 2,
"volatility":2,
"feature": "20 Lines",
"min_bet": 20,
"max_bet": 60000
}
]
PlayStar Gaming System - Integration Service API
Page 48 of 100
(2) Top Winners
PS provides a data feed to obtain a list of top winners for a host system.
(only if winning times of bet amount is more than 50)
● Request
Name
Type
Description
host_id
string
Unique ID of Host System (provided by PS)
member_id
string
Optional. Unique ID of player (Max. 64 characters)
game_id
string
Optional. Unique ID of PS Games (Max. 64
characters)
start_dt
string
Optional. The start date of date range to search on.
(default is today's date)
Format of the date entered must be yyyy-MM-dd.
end_dt
string
Optional. The end date of date range to search on.
(default is today's date)
row_count
uint16
Optional. The number of top winners to be sent back
calc_by
int
Optional. The base of calculation.
Possible values are described below:
Value
Description
0
Win times of bet amount (Default)
1
Win amount
type
int
Optional. The win type of calculation. Possible values
are described below:
Value
Description
0
All Wins (Default)
1
Base Game Wins Only
2
Bonus Game Wins Only
min_times
uint16
Optional. The minimum times of bet amount.
max_times
uint16
Optional. The maximum times of bet amount.
win_times
variant
Optional. The specific times of bet amount.
Possible values are described below:
Value
Type
Description
max
string
The maximum times of bet
amount.
N,...
uint16
(array)
The specific times of bet
amount (comma separated)
※ When this field is present, the fields "min_times"
and "max_times" are ignored.
PlayStar Gaming System - Integration Service API
Page 49 of 100
■ Example
https://{PS-API-
SERVER}/feed/topwinner/?host_id=a62b545a3c56ec719257e82d60dbc518&row_
count=5
● Response
Name
Type
Description
member_id
string
Unique ID of the player (Max. 64 characters)
sn
uint64
Unique ID of the game round.
bet
uint
Amount of bet.
game_id
string
Unique ID of PS Games (Max. 64 characters)
game_name
object
The name of PS Games in multiple languages.
Currently only support English (en-US), Chinese
Simplified (zh-CN), Traditional Chinese (zh-TW).
(Max. 32 characters)
total_win
uint64
Amount of win.
dtm
string
The end date/time of the game round.
■ Response Example
[
{
"member_id":"test1","sn":3392,"bet": 100000,"game_id":"PSS-ON-00006",
"game_name": {"en-US": "SLOT-6","zh-TW": "SLOT-6","zh-CN": "SLOT-6"},
"total_win": 7820000,"dtm":"2016-02-28T15:30:56"
},
{
"member_id":"test2","sn":3512,"bet":3000,"game_id":"PSS-ON-00003",
"game_name": {"en-US": "SLOT-3","zh-TW": "SLOT-3","zh-CN": "SLOT-3"},
"total_win": 1333500,"dtm":"2016-02-28T16:10:16"
},
{
"member_id": "test3","sn":3773,"bet": 3000,"game_id":"PSS-ON-00003",
"game_name": {"en-US": "SLOT-3","zh-TW": "SLOT-3","zh-CN": "SLOT-3"},
"total_win": 299500,"dtm":"2016-02-28T16:49:27"
},
{
"member_id": "test4","sn":3922,"bet": 3000,"game_id":"PSS-ON-00003",
"game_name": {"en-US": "SLOT-3","zh-TW": "SLOT-3","zh-CN": "SLOT-3"},
"total_win": 228500,"dtm":"2016-02-28T17:11:31"
}
]
PlayStar Gaming System - Integration Service API
Page 50 of 100
(3) Jackpot Pools
PS provides a data feed to obtain a list of jackpot pools for a host system.
● Request
Name
Type
Description
host_id
string
Unique ID of Host System (provided by PS)
group_id
int
Optional. Unique ID of jackpot groups
■ Example
https://{PS-API-
SERVER}/feed/jackpot/?host_id=a62b545a3c56ec719257e82d60dbc518&group_id
=1
● Response
Name
Type
Description
pool_id
uint64
ID of jackpot pools. It also means the level of
jackpot pools.
pool_amount
uint64
Current amount of jackpot pools
■ Response Example
[
{ "pool_id": 0, "pool_amount": 20035 }, // mini
{ "pool_id": 1, "pool_amount": 100200 }, // minor
{ "pool_id": 2, "pool_amount": 1000205 }, // major
{ "pool_id": 3, "pool_amount": 6000112 } // grand
]
PlayStar Gaming System - Integration Service API
Page 51 of 100
(4) Jackpot Winners
PS provides a data feed to obtain a list of jackpot winners for a host system.
● Request
Name
Type
Description
host_id
string
Unique ID of Host System (provided by PS)
start_dtm
string
Optional. The start date-time of date range to search
on. (default is today's date)
Format of the date entered must be yyyy-MM-
ddTHH:mm:ss.
end_dtm
string
Optional. The end date-time of date range to search
on. (default is today's date)
dtm_type
int
Optional. The type of date range to search on.
Value
Description
0
The end date-time of game (Default)
1
The hit date-time of jackpot
host_type
int
Optional. Host Type
Possible values are described below:
Value
Description
0
General (Default)
1
Master Account：Return all data of
sub-accounts (For master and sub-
account hierarchy)
jp_type
int
Optional. Jackpot Type
Possible values are described below:
Value
Description
1
Mystery (Default)
2
Red envelope
■ Example
https://{PS-API-
SERVER}/feed/jackpotwinner/?host_id=a62b545a3c56ec719257e82d60dbc518
PlayStar Gaming System - Integration Service API
Page 52 of 100
● Response
Name
Type
Description
member_id
string
Unique ID of the player (Max. 64 characters)
sn
uint64
Unique ID of the game round.
bet
uint
Amount of bet.
game_id
string
Unique ID of PS Games (Max. 64 characters)
game_name
object
The name of PS Games in multiple languages.
Currently only support English (en-US), Chinese
Simplified (zh-CN), Traditional Chinese (zh-TW).
(Max. 32 characters)
jackpot_win
uint64
Amount of win.
dtm
string
The hit date/time of the jackpot award.
jackpot_data
object
array
The jackpot data of the game round.
Name
Type
Description
sn
uint64
Unique ID of the jackpot win.
type
uint32
The type of jackpot win.
gid
uint32
The group ID of the jackpot win.
pid
uint32
The award ID of the jackpot win.
win
uint64
The amount of the jackpot win.
dtm
DateTi
me
The date/time of the jackpot win.
■ Response Example
◆ Query with host_type=0
[
{
"member_id":"test1","sn":3392,"bet":1000,"game_id":"PSS-ON-00006",
"game_name": {"en-US": "SLOT-6","zh-TW": "SLOT-6","zh-CN": "SLOT-6"},
"jackpot_win": 7820000,"dtm":"2016-02-28T15:30:56",
"jackpot_data":[{"sn":1,"type":1,"gid":1,"pid":1,"win":7820000,"dtm":"2016-
02-28T15:31:00"}]
},
{
"member_id":"test2","sn":3512,"bet":3000,"game_id":"PSS-ON-00003",
"game_name": {"en-US": "SLOT-3","zh-TW": "SLOT-3","zh-CN": "SLOT-3"},
"jackpot_win": 1333500,"dtm":"2016-02-28T16:10:16",
"jackpot_data":[{"sn":1,"type":1,"gid":1,"pid":1,"win":1333500,"dtm":"2016-
02-28T16:11:00"}]
},
{
"member_id":"test3","sn":3773,"bet":3000,"game_id":"PSS-ON-00003",
"game_name": {"en-US": "SLOT-3","zh-TW": "SLOT-3","zh-CN": "SLOT-3"},
"jackpot_win": 299500,"dtm":"2016-02-28T16:49:27",
"jackpot_data":[{"sn":1,"type":1,"gid":1,"pid":1,"win":299500,"dtm":"2016-
02-28T16:50:00"}]
}
PlayStar Gaming System - Integration Service API
Page 53 of 100
]
◆ Query with host_type=1
{
"HOST-NAME-A":[
{
"member_id":"test1","sn":3392,"bet":1000,"game_id":"PSS-ON-00006",
"game_name": {"en-US": "SLOT-6","zh-TW": "SLOT-6","zh-CN": "SLOT-6"},
"jackpot_win": 7820000,"dtm":"2016-02-28T15:30:56",
"
jackpot_data":[{"sn":1,"type":1,"gid":1,"pid":1,"win":7820000,"dtm":"2016-02-
28T15:31:00"}]
},
{
"member_id":"test2","sn":3512,"bet":3000,"game_id":"PSS-ON-00003",
"game_name": {"en-US": "SLOT-3","zh-TW": "SLOT-3","zh-CN": "SLOT-3"},
"jackpot_win": 1333500,"dtm":"2016-02-28T16:10:16",
"jackpot_data":[{"sn":1,"type":1,"gid":1,"pid":1,"win":1333500,"dtm":"20
16-02-28T16:11:00"}]
},
{
"member_id":"test3","sn":3773,"bet":3000,"game_id":"PSS-ON-00003",
"game_name": {"en-US": "SLOT-3","zh-TW": "SLOT-3","zh-CN": "SLOT-3"},
"jackpot_win": 299500,"dtm":"2016-02-28T16:49:27",
"jackpot_data":[{"sn":1,"type":1,"gid":1,"pid":1,"win":299500,"dtm":"201
6-02-28T16:50:00"}]
}
],
"HOST-NAME-B":[
{
"member_id":"test1","sn":4392,"bet":1000,"game_id":"PSS-ON-00006",
"game_name": {"en-US": "SLOT-6","zh-TW": "SLOT-6","zh-CN": "SLOT-6"},
"jackpot_win": 3310000,"dtm":"2016-02-28T16:30:56",
"jackpot_data":[{"sn":1,"type":1,"gid":1,"pid":1,"win":3310000,"dtm":"20
16-02-28T16:31:00"}]
},
{
"member_id":"test2","sn":4512,"bet":3000,"game_id":"PSS-ON-00003",
"game_name": {"en-US": "SLOT-3","zh-TW": "SLOT-3","zh-CN": "SLOT-3"},
"jackpot_win": 233500,"dtm":"2016-02-28T17:10:16",
"jackpot_data":[{"sn":1,"type":1,"gid":1,"pid":1,"win":233500,"dtm":"201
6-02-28T17:11:00"}]
},
{
"member_id":"test3","sn":4773,"bet":3000,"game_id":"PSS-ON-00003",
"game_name": {"en-US": "SLOT-3","zh-TW": "SLOT-3","zh-CN": "SLOT-3"},
PlayStar Gaming System - Integration Service API
Page 54 of 100
"jackpot_win": 192500,"dtm":"2016-02-28T18:49:27",
"jackpot_data":[{"sn":1,"type":1,"gid":1,"pid":1,"win":192500,"dtm":"201
6-02-28T18:50:00"}]
}
]
}
PlayStar Gaming System - Integration Service API
Page 55 of 100
(5) Jackpot Daily Contribution
PS provides a data feed to obtain daily contribution of jackpot for a host
system.
● Request
Name
Type
Description
host_id
string
Unique ID of Host System (provided by PS)
start_dt
string
The start date of date range to search on.
Format of the date entered must be yyyy-MM-dd.
end_dt
string
The end date of date range to search on.
host_type
int
Optional. Host Type
Possible values are described below:
Value
Description
0
General (Default)
1
Master Account：Return all data of sub-
accounts (For master and sub-account
hierarchy)
■ Example
https://{PS-API-
SERVER}/feed/jackpotdailycontrib/?host_id=a62b545a3c56ec719257e82d60dbc51
8&start_dt=2016-02-28&end_dt=2016-02-29
● Response
Name
Type
Description
tc
double
Total contribution (in cents, round off to 2
nd
decimal
place).
PlayStar Gaming System - Integration Service API
Page 56 of 100
■ Response Example
◆ General (host_type=0)
{
"2016-02-28": {
"tc": 444651.05
},
"2016-02-29": {
"tc": 2682480.1
}
}
◆ Master Account (host_type=1)
{
"2016-02-28": {
"HOST-NAME-A": {
"tc": 444651.05
},
"HOST-NAME-B": {
"tc": 2682480.1
}
},
"2016-02-29": {
"HOST-NAME-A": {
"tc": 434131.15
}
}
}
PlayStar Gaming System - Integration Service API
Page 57 of 100
(6) Game History
PS provides a data feed to obtain players’ game history in a date range for a
host system.
※ NOTE: The calculation method for net revenue is bets placed minus rebates
and Limited-activation Game Award payouts.
● Request
Name
Type
Description
host_id
string
Unique ID of Host System (provided by PS)
member_id
string
Optional. Unique ID of player. (Max. 64 characters)
※ Return all players’ data if this field is not given.
※ When this field is present, the "host_type" is
ignored.
start_dtm
string
The start date-time of date-time range to search
on. The format is yyyy-MM-ddTHH:mm:ss
end_dtm
string
The end date-time of date-time range to search on.
sn
uint64
Optional. Unique ID of the game round.
※ When this field is present, the fields
"member_id", "game_id", "start_dtm" and
"end_dtm" are ignored.
game_id
string
Optional. Unique ID of PS Games (Max. 64
characters)
row_count
uint16
Optional. The number of records to be sent back
host_type
int
Optional. Host Type
Possible values are described below:
Value
Description
0
General (Default)
1
Master Account：Return all data of
sub-accounts (For master and sub-
account hierarchy)
detail_type
int
Optional. With or without Bonus data.
Possible values are described below:
Value
Description
0
With detail data (Default)
1
Without detail data
game_type
string
Optional. Game Type
Possible values are described below:
Value
Description
SLOT
Slot Games
CARD
Card Games
PlayStar Gaming System - Integration Service API
Page 58 of 100
■ Example
https://{PS-API-
SERVER}/feed/gamehistory/?host_id=a62b545a3c56ec719257e82d60dbc518&me
mber_id=player1&start_dtm=2016-02-28T02:00:00&end_dtm=2016-02-
29T02:01:00&type=0&host_type=0
● Response
Name
Type
Description
sn
uint64
Unique ID of the game round.
gid
string
Unique ID of PS Games (Max. 64 characters)
sid
uint16
Sub-Game ID of PS Games
s_tm
string
The begin time of the game round.
The format is yyyy-MM-dd HH:mm:ss
e_tm
string
The end time of the game round.
The format is yyyy-MM-dd HH:mm:ss
tm
string
The end time of the game round. The format is HH:mm:ss
bet
uint64
The amount of money bet (in cents)
dm
uint64
The denomination of the game round.
win
int64
The amount of money win (in cents, including bonus win,
gamble win)
bn
uint64
The amount of bonus win (in cents)
bd
object
array
The bonus data of the game round that only slot game and
exists if bonus is triggered.
Name
Type
Description
sn
uint64
Unique ID of the game round.
win
uint64
The amount of win of the game
round. (in cents)
dtm
DateTime
The end date/time of the game
round.
rd
string
The result data of the game round
ex
string
The extra data of the game round
offln
uint16
Auto completed by system when
player's offline. (0=No, 1=Yes)
gb
uint64
The amount of gamble win (in cents)
jp
uint64
The amount of jackpot win (in cents)
gt
string
The game type of PS Games.
Value
Description
SLOT
Slot Games
CARD
Card Games
jd
object
array
The jackpot data of the game round.
Name
Type
Description
sn
uint64
Unique ID of the jackpot win.
type
uint32
The type of jackpot win.
PlayStar Gaming System - Integration Service API
Page 59 of 100
gid
uint32
The group ID of the jackpot win.
pid
uint32
The award ID of the jackpot win.
win
uint64
The amount of the jackpot win.
dtm
DateTime
The date/time of the jackpot win.
jc
double
The amount of jackpot contribution (in cents, round off to
2
nd
decimal place)
betamt
double
Valid bet (Only Card Games)
winamt
Int64
Valid win (Only Card Games)
■ Response Example
◆ Query with member_id
{
"2016-02-28":[
{"sn":1,"gid":"PSS-ON-
00001","sid":0,"tm":"01:10:11","bet":500,"dm":100,"win":500,
"bn":100,"gb":0,"jp":0,
"bd":[
{"sn":1,"win":10,"dtm":"2016-02-08T01:10:14"},
{"sn":2,"win":10,"dtm":"2016-02-08T01:10:17"},
{"sn":3,"win":10,"dtm":"2016-02-08T01:10:20"},
{"sn":4,"win":10,"dtm":"2016-02-08T01:10:23"},
{"sn":5,"win":10,"dtm":"2016-02-08T01:10:26"},
{"sn":6,"win":10,"dtm":"2016-02-08T01:10:29"},
{"sn":7,"win":10,"dtm":"2016-02-08T01:10:32"},
{"sn":8,"win":10,"dtm":"2016-02-08T01:10:35"},
{"sn":9,"win":10,"dtm":"2016-02-08T01:10:38"},
{"sn":10,"win":10,"dtm":"2016-02-08T01:10:41"}
],"gt":"SLOT","jc":0
},
{"sn":2,"gid":"PSS-ON-
00002","sid":0,"tm":"02:20:12","bet":400,"dm":100,"win":400,
"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"sn":3,"gid":"PSS-ON-
00003","sid":0,"tm":"03:30:13","bet":300,"dm":100,"win":300,
"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"sn":4,"gid":"PSS-ON-
00004","sid":0,"tm":"04:40:14","bet":500,"dm":100,"win":500,
"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0}
],
"2016-02-29":[
{"sn":5,"gid":"PSS-ON-
00001","sid":0,"tm":"05:50:15","bet":500,"dm":100,"win":500,
"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"sn":6,"gid":"PSS-ON-
00002","sid":0,"tm":"06:10:16","bet":400,"dm":100,"win":400,
"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"sn":7,"gid":"PSS-ON-
PlayStar Gaming System - Integration Service API
Page 60 of 100
00003","sid":0,"tm":"07:20:17","bet":300,"dm":100,"win":300,
"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"sn":8,"gid":"PSS-ON-
00004","sid":0,"tm":"08:30:18","bet":500,"dm":100,"win":500,
"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0}
]
}
◆ Query without member_id (and host_type=0)
{
"2016-02-28":{
"player1": [
{"sn":1,"gid":"PSS-ON-00001","sid":0,"tm":"01:10:11","bet":500,"dm":100,
"win":500,"bn":100,"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"sn":2,"gid":"PSS-ON-00002","sid":0,"tm":"02:20:12","bet":400,"dm":100,
"win":400,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"sn":3,"gid":"PSS-ON-00003","sid":0,"tm":"03:30:13","bet":300,"dm":100,
"win":300,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"sn":4,"gid":"PSS-ON-00004","sid":0,"tm":"04:40:14","bet":500,"dm":100,
"win":500,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0}
],
"player2": [
{"sn":5,"gid":"PSS-ON-00001","sid":0,"tm":"01:10:11","bet":500,"dm":100,
"win":500,"bn":100,"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"sn":6,"gid":"PSS-ON-00002","sid":0,"tm":"02:20:12","bet":400,"dm":100,
"win":400,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"sn":7,"gid":"PSS-ON-00003","sid":0,"tm":"03:30:13","bet":300,"dm":100,
"win":300,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"sn":8,"gid":"PSS-ON-00004","sid":0,"tm":"04:40:14","bet":500,"dm":100,
"win":500,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0}
]
},
"2016-02-29":{
"player1": [
{"sn":9,"gid":"PSS-ON-00001","sid":0,"tm":"05:50:15","bet":500,"dm":100,
"win":500,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"sn":10,"gid":"PSS-ON-00002","sid":0,"tm":"06:10:16","bet":400,"dm":100,
"win":400,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"sn":11,"gid":"PSS-ON-00003","sid":0,"tm":"07:20:17","bet":300,"dm":100,
"win":300,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"sn":12,"gid":"PSS-ON-00004","sid":0,"tm":"08:30:18","bet":500,"dm":100,
"win":500,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0}
],
"player2": [
{"sn":13,"gid":"PSS-ON-00001","sid":0,"tm":"05:50:15","bet":500,"dm":100,
"win":500,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0},
PlayStar Gaming System - Integration Service API
Page 61 of 100
{"sn":14,"gid":"PSS-ON-00002","sid":0,"tm":"06:10:16","bet":400,"dm":100,
"win":400,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"sn":15,"gid":"PSS-ON-00003","sid":0,"tm":"07:20:17","bet":300,"dm":100,
"win":300,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"sn":16,"gid":"PSS-ON-00004","sid":0,"tm":"08:30:18","bet":500,"dm":100,
"win":500,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0}
]
}
}
◆ Query without member_id (and host_type=1)
{
"2016-02-28":{
"HOST-NAME-A": {
"player1": [
{"sn":1,"gid":"PSS-ON-
00001","sid":0,"tm":"01:10:11","bet":500,"dm":100,"win":500,"bn":100,
"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"sn":2,"gid":"PSS-ON-
00002","sid":0,"tm":"02:20:12","bet":400,"dm":100,"win":400,"bn":0,
"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"sn":3,"gid":"PSS-ON-
00003","sid":0,"tm":"03:30:13","bet":300,"dm":100,"win":300,"bn":0,
"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"sn":4,"gid":"PSS-ON-
00004","sid":0,"tm":"04:40:14","bet":500,"dm":100,"win":500,"bn":0,
"gb":0,"jp":0,"gt":"SLOT","jc":0}
],
"player2": [
{"sn":5,"gid":"PSS-ON-
00001","sid":0,"tm":"01:10:11","bet":500,"dm":100,"win":500,"bn":100,
"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"sn":6,"gid":"PSS-ON-
00002","sid":0,"tm":"02:20:12","bet":400,"dm":100,"win":400,"bn":0,
"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"sn":7,"gid":"PSS-ON-
00003","sid":0,"tm":"03:30:13","bet":300,"dm":100,"win":300,"bn":0,
"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"sn":8,"gid":"PSS-ON-
00004","sid":0,"tm":"04:40:14","bet":500,"dm":100,"win":500,"bn":0,
"gb":0,"jp":0,"gt":"SLOT","jc":0}
]
},
"HOST-NAME-B": {
"player1": [
{"sn":1,"gid":"PSS-ON-
PlayStar Gaming System - Integration Service API
Page 62 of 100
00001","sid":0,"tm":"01:10:11","bet":500,"dm":100,"win":500,"bn":100,
"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"sn":2,"gid":"PSS-ON-
00002","sid":0,"tm":"02:20:12","bet":400,"dm":100,"win":400,"bn":0,
"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"sn":3,"gid":"PSS-ON-
00003","sid":0,"tm":"03:30:13","bet":300,"dm":100,"win":300,"bn":0,
"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"sn":4,"gid":"PSS-ON-
00004","sid":0,"tm":"04:40:14","bet":500,"dm":100,"win":500,"bn":0,
"gb":0,"jp":0,"gt":"SLOT","jc":0}
],
"player2": [
{"sn":5,"gid":"PSS-ON-
00001","sid":0,"tm":"01:10:11","bet":500,"dm":100,"win":500,"bn":100,
"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"sn":6,"gid":"PSS-ON-
00002","sid":0,"tm":"02:20:12","bet":400,"dm":100,"win":400,"bn":0,
"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"sn":7,"gid":"PSS-ON-
00003","sid":0,"tm":"03:30:13","bet":300,"dm":100,"win":300,"bn":0,
"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"sn":8,"gid":"PSS-ON-
00004","sid":0,"tm":"04:40:14","bet":500,"dm":100,"win":500,"bn":0,
"gb":0,"jp":0,"gt":"SLOT","jc":0}
]
}
},
"2016-02-29":{
"HOST-NAME-A": {
"player1": [
{"sn":9,"gid":"PSS-ON-
00001","sid":0,"tm":"05:50:15","bet":500,"dm":100,"win":500,"bn":0,
"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"sn":10,"gid":"PSS-ON-
00002","sid":0,"tm":"06:10:16","bet":400,"dm":100,"win":400,"bn":0,
"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"sn":11,"gid":"PSS-ON-
00003","sid":0,"tm":"07:20:17","bet":300,"dm":100,"win":300,"bn":0,
"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"sn":12,"gid":"PSS-ON-
00004","sid":0,"tm":"08:30:18","bet":500,"dm":100,"win":500,"bn":0,
"gb":0,"jp":0,"gt":"SLOT","jc":0}
],
"player2": [
{"sn":13,"gid":"PSS-ON-
00001","sid":0,"tm":"05:50:15","bet":500,"dm":100,"win":500,"bn":0,
PlayStar Gaming System - Integration Service API
Page 63 of 100
"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"sn":14,"gid":"PSS-ON-
00002","sid":0,"tm":"06:10:16","bet":400,"dm":100,"win":400,"bn":0,
"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"sn":15,"gid":"PSS-ON-
00003","sid":0,"tm":"07:20:17","bet":300,"dm":100,"win":300,"bn":0,
"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"sn":16,"gid":"PSS-ON-
00004","sid":0,"tm":"08:30:18","bet":500,"dm":100,"win":500,"bn":0,
"gb":0,"jp":0,"gt":"SLOT","jc":0}
]
}
}
}
(7) Daily Summary
PS provides a data feed to obtain a summary of daily players' activities.
※ NOTE: The calculation method for net revenue is bets placed minus rebates
and Limited-activation Game Award payouts.
● Request
Name
Type
Description
host_id
string
Unique ID of Host System (provided by PS)
start_dt
string
The start date of date range to search on. Format of
the date entered must be yyyy-MM-dd.
end_dt
string
The end date of date range to search on.
member_id
string
Optional. Unique ID of the player (Max. 64
characters)
group_by
uint16
Optional. Grouped by the following fields
Value
Description
0
Unique ID of player and game (Default)
1
Unique ID of player
2
Unique ID of game
3
Unique ID of Host
4
Game type
5
Unique ID of Player and game type
host_type
int
Optional. Host Type
Possible values are described below:
Value
Description
0
General (Default)
1
Master Account：Return all data of sub-
accounts (For master and sub-account
hierarchy)
game_id
string
Optional. Unique ID of PS Games
PlayStar Gaming System - Integration Service API
Page 64 of 100
game_type
string
Optional. Game Type
Possible values are described below:
Value
Description
SLOT
Slot Games
CARD
Card Games
■ Example
https://{PS-API-
SERVER}/feed/dailysummary/?host_id=a62b545a3c56ec719257e82d60dbc518&st
art_dt=2016-02-28&end_dt=2016-02-29&member_id=player1
PlayStar Gaming System - Integration Service API
Page 65 of 100
● Response
Name
Type
Description
gid
string
Unique ID of PS Games (Max. 64 characters)
sid
uint16
Sub-Game ID of PS Games
rnd
uint32
The daily amount of game rounds
bet
uint64
The daily amount of money bet (in cents)
win
uint64
The daily amount of money win (in cents, including bonus
win, gamble win)
bn
uint64
The daily amount of bonus win (in cents)
gb
uint64
The daily amount of gamble win (in cents)
jp
uint64
The daily amount of jackpot win (in cents)
gt
string
The game type of PS Games.
Value
Description
SLOT
Slot Games
CARD
Card Games
jc
float
The daily amount of jackpot contribution (in cents, round off
to 2
nd
decimal place)
■ Response Example
◆ Query without meber_id
{
"2016-02-28":{
"player1":[
{"gid":"PSS-ON-
00001","rnd":10,"bet":500,"win":500,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"gid":"PSS-ON-
00002","rnd":10,"bet":400,"win":400,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0}
],
"player2":[
{"gid":"PSS-ON-
00003","rnd":10,"bet":300,"win":300,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"gid":"PSS-ON-
00004","rnd":10,"bet":500,"win":500,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0}
]
},
"2016-02-29":{
"player1":[
{"gid":"PSS-ON-
00001","rnd":10,"bet":500,"win":500,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"gid":"PSS-ON-
00002","rnd":10,"bet":400,"win":400,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0}
],
"player2":[
{"gid":"PSS-ON-
00003","rnd":10,"bet":300,"win":300,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"gid":"PSS-ON-
PlayStar Gaming System - Integration Service API
Page 66 of 100
00004","rnd":10,"bet":500,"win":500,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0}
]
}
}
◆ Query with member_id=player1
{
"2016-02-28":{
"player1":[
{"gid":"PSS-ON-
00001","rnd":10,"bet":500,"win":500,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"gid":"PSS-ON-
00002","rnd":10,"bet":400,"win":400,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0}
]
},
"2016-02-29":{
"player1":[
{"gid":"PSS-ON-00001","sid":0,"rnd":10,"bet":500,"win":500,"bn":0,
"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"gid":"PSS-ON-00002","sid":0,"rnd":10,"bet":400,"win":400,"bn":0,
"gb":0,"jp":0,"gt":"SLOT","jc":0}
]
}
}
◆ Query with group_by = 1
{
"2016-02-28":{
"player1": [{"rnd":20,"bet":900,"win":900,"bn":0,"gb":0,"jp":0,"jc":0}],
"player2": [{"rnd":20,"bet":800,"win":800,"bn":0,"gb":0,"jp":0,"jc":0}]
},
"2016-02-29":{
"player1": [{"rnd":20,"bet":900,"win":900,"bn":0,"gb":0,"jp":0,"jc":0}],
"player2": [{"rnd":20,"bet":800,"win":800,"bn":0,"gb":0,"jp":0,"jc":0}]
}
}
◆ Query with group_by = 2
{
"2016-02-28":{
"PSS-ON-
00001":[{"rnd":10,"bet":500,"win":500,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0}],
"PSS-ON-
PlayStar Gaming System - Integration Service API
Page 67 of 100
00002":[{"rnd":10,"bet":400,"win":400,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0}],
"PSS-ON-
00003":[{"rnd":10,"bet":300,"win":300,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0}],
"PSS-ON-
00004":[{"rnd":10,"bet":500,"win":500,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0}]
},
"2016-02-29":{
"PSS-ON-
00001":[{"rnd":10,"bet":500,"win":500,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0}],
"PSS-ON-
00002":[{"rnd":10,"bet":400,"win":400,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0}],
"PSS-ON-
00003":[{"rnd":10,"bet":300,"win":300,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0}],
"PSS-ON-
00004":[{"rnd":10,"bet":500,"win":500,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0}]
}
}
◆ Query with group_by = 3
{
"2016-02-28":{
"HOST-NAME-
A":[{"rnd":40,"bet":1700,"win":1700,"bn":0,"gb":0,"jp":0,"jc":0}]
},
"2016-02-29":{
"HOST-NAME-
A":[{"rnd":40,"bet":1700,"win":1700,"bn":0,"gb":0,"jp":0,"jc":0}]
}
}
◆ Query with group_by = 4
{
"2016-02-28":{
"SLOT":[{"rnd":40,"bet":1700,"win":1700,"bn":0,"gb":0,"jp":0,"jc":0}]
},
"2016-02-29":{
"SLOT":[{"rnd":40,"bet":1700,"win":1700,"bn":0,"gb":0,"jp":0,"jc":0}]
}
}
◆ Query with group_by = 5
{
"2016-02-28":{
PlayStar Gaming System - Integration Service API
Page 68 of 100
"player1":[
{"gt":"SLOT","rnd":10,"bet":500,"win":500,"bn":0,"gb":0,"jp":0,"jc":0}
],
"player2":[
{"gt":"SLOT","rnd":10,"bet":500,"win":500,"bn":0,"gb":0,"jp":0,"jc":0}
]
},
"2016-02-29":{
"player1":[
{"gt":"SLOT","rnd":10,"bet":500,"win":500,"bn":0,"gb":0,"jp":0,"jc":0}
],
"player2":[
{"gt":"SLOT","rnd":10,"bet":500,"win":500,"bn":0,"gb":0,"jp":0,"jc":0}
]
}
}
◆ Query with host_type = 1 and group_by=3
{
"2016-02-28":{
"HOST-NAME-
A":[{"rnd":40,"bet":1700,"win":1700,"bn":0,"gb":0,"jp":0,"jc":0}],
"HOST-NAME-B":[{"rnd":10,"bet":300,"win":300,"bn":0,"gb":0,"jp":0,"jc":0}]
},
"2016-02-29":{
"HOST-NAME-
A":[{"rnd":40,"bet":1700,"win":1700,"bn":0,"gb":0,"jp":0,"jc":0}],
"HOST-NAME-B":[{"rnd":10,"bet":300,"win":300,"bn":0,"gb":0,"jp":0,"jc":0}]
}
}
PlayStar Gaming System - Integration Service API
Page 69 of 100
(8) Hourly Summary
PS provides a data feed to obtain a summary of hourly players' activities.
※ NOTE: The calculation method for net revenue is bets placed minus rebates and
Limited-activation Game Award payouts.
● Request
Name
Type
Description
host_id
string
Unique ID of Host System (provided by PS)
start_dt
string
The start date of date range to search on. Format of
the date entered must be yyyy-MM-ddTHH:00:00, the
value of minute and second will be ignored.
end_dt
string
The end date of date range to search on. Format of
the date entered must be yyyy-MM-ddTHH:00:00, the
value of minute and second will be ignored.
member_id
string
Optional. Unique ID of the player (Max. 64 characters)
group_by
uint16
Optional. Grouped by the following fields
Value
Description
0
Unique ID of player and game (Default)
1
Unique ID of player
2
Unique ID of game
3
Unique ID of Host
4
Game type
5
Unique ID of player and game type
host_type
int
Optional. Host Type
Possible values are described below:
Value
Description
0
General (Default)
1
Master Account：Return all data of sub-
accounts (For master and sub-account
hierarchy)
game_id
string
Optional. Unique ID of PS Games
game_type
string
Optional. Game Type
Possible values are described below:
Value
Description
SLOT
Slot Games
CARD
Card Games
PlayStar Gaming System - Integration Service API
Page 70 of 100
■ Example
https://{PS-API-
SERVER}/feed/hourlysummary/?host_id=a62b545a3c56ec719257e82d60dbc518&
start_dt=2016-02-28T12:00:00&end_dt=2016-02-
29T11:00:00&member_id=player1
● Response
Name
Type
Description
gid
string
Unique ID of PS Games (Max. 64 characters)
sid
uint16
Sub-Game ID of PS Games
rnd
uint32
The daily amount of game rounds
bet
uint64
The daily amount of money bet (in cents)
win
uint64
The daily amount of money win (in cents, including bonus
win, gamble win)
bn
uint64
The daily amount of bonus win (in cents)
gb
uint64
The daily amount of gamble win (in cents)
jp
uint64
The daily amount of jackpot win (in cents)
gt
string
The game type of PS Games.
Value
Description
SLOT
Slot Games
CARD
Card Games
jc
float
The daily amount of jackpot contribution (in cents, round off
to 2
nd
decimal place)
■ Response Example
◆ Query without meber_id
{
"2016-02-28T17:00:00":{
"player1":[
{"gid":"PSS-ON-
00001","rnd":10,"bet":500,"win":500,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"gid":"PSS-ON-
00002","rnd":10,"bet":400,"win":400,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0}
],
"player2":[
{"gid":"PSS-ON-
00003","rnd":10,"bet":300,"win":300,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"gid":"PSS-ON-
00004","rnd":10,"bet":500,"win":500,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0}
]
},
"2016-02-29T10:00:00":{
"player1":[
PlayStar Gaming System - Integration Service API
Page 71 of 100
{"gid":"PSS-ON-
00001","rnd":10,"bet":500,"win":500,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"gid":"PSS-ON-
00002","rnd":10,"bet":400,"win":400,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0}
],
"player2":[
{"gid":"PSS-ON-
00003","rnd":10,"bet":300,"win":300,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"gid":"PSS-ON-
00004","rnd":10,"bet":500,"win":500,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0}
]
}
}
◆ Query with member_id=player1
{
"2016-02-28T17:00:00":{
"player1":[
{"gid":"PSS-ON-
00001","rnd":10,"bet":500,"win":500,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"gid":"PSS-ON-
00002","rnd":10,"bet":400,"win":400,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0}
]
},
"2016-02-29T10:00:00":{
"player1":[
{"gid":"PSS-ON-
00001","rnd":10,"bet":500,"win":500,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"gid":"PSS-ON-
00002","rnd":10,"bet":400,"win":400,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0}
]
}
}
◆ Query with group_by = 1
{
"2016-02-28T17:00:00":{
"player1": [{"rnd":20,"bet":900,"win":900,"bn":0,"gb":0,"jp":0,"jc":0}],
"player2": [{"rnd":20,"bet":800,"win":800,"bn":0,"gb":0,"jp":0,"jc":0}]
},
"2016-02-29T10:00:00":{
"player1": [{"rnd":20,"bet":900,"win":900,"bn":0,"gb":0,"jp":0,"jc":0}],
"player2": [{"rnd":20,"bet":800,"win":800,"bn":0,"gb":0,"jp":0,"jc":0}]
PlayStar Gaming System - Integration Service API
Page 72 of 100
}
}
◆ Query with group_by = 2
{
"2016-02-28T17:00:00":{
"PSS-ON-
00001":[{"rnd":10,"bet":500,"win":500,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0}],
"PSS-ON-
00002":[{"rnd":10,"bet":400,"win":400,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0}],
"PSS-ON-
00003":[{"rnd":10,"bet":300,"win":300,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0}],
"PSS-ON-
00004":[{"rnd":10,"bet":500,"win":500,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0}]
},
"2016-02-29T10:00:00":{
"PSS-ON-
00001":[{"rnd":10,"bet":500,"win":500,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0}],
"PSS-ON-
00002":[{"rnd":10,"bet":400,"win":400,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0}],
"PSS-ON-
00003":[{"rnd":10,"bet":300,"win":300,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0}],
"PSS-ON-
00004":[{"rnd":10,"bet":500,"win":500,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0}]
}
}
◆ Query with group_by = 3
{
"2016-02-28T17:00:00":{
"HOST-NAME-
A":[{"rnd":40,"bet":1700,"win":1700,"bn":0,"gb":0,"jp":0,"jc":0}]
},
"2016-02-29T10:00:00":{
"HOST-NAME-
A":[{"rnd":40,"bet":1700,"win":1700,"bn":0,"gb":0,"jp":0,"jc":0}]
}
}
◆ Query with group_by = 4
{
"2016-02-28T17:00:00":{
"SLOT":[{"rnd":40,"bet":1700,"win":1700,"bn":0,"gb":0,"jp":0,"jc":0}]
},
PlayStar Gaming System - Integration Service API
Page 73 of 100
"2016-02-29T10:00:00":{
"SLOT":[{"rnd":40,"bet":1700,"win":1700,"bn":0,"gb":0,"jp":0,"jc":0}]
}
}
◆ Query with group_by = 5
{
"2016-02-28T17:00:00":{
"player1":[
{"gt":"SLOT","rnd":10,"bet":500,"win":500,"bn":0,"gb":0,"jp":0,"jc":0}
],
"player2":[
{"gt":"SLOT","rnd":10,"bet":500,"win":500,"bn":0,"gb":0,"jp":0,"jc":0}
]
},
"2016-02-29T10:00:00":{
"player1":[
{"gt":"SLOT","rnd":10,"bet":500,"win":500,"bn":0,"gb":0,"jp":0,"jc":0}
],
"player2":[
{"gt":"SLOT","rnd":10,"bet":500,"win":500,"bn":0,"gb":0,"jp":0,"jc":0}
]
}
}
◆ Query with host_type = 1 and group_by=3
{
"2016-02-28T17:00:00":{
"HOST-NAME-
A":[{"rnd":40,"bet":1700,"win":1700,"bn":0,"gb":0,"jp":0,"jc":0}],
"HOST-NAME-B":[{"rnd":10,"bet":300,"win":300,"bn":0,"gb":0,"jp":0,"jc":0}]
},
"2016-02-29T10:00:00":{
"HOST-NAME-
A":[{"rnd":40,"bet":1700,"win":1700,"bn":0,"gb":0,"jp":0,"jc":0}],
"HOST-NAME-B":[{"rnd":10,"bet":300,"win":300,"bn":0,"gb":0,"jp":0,"jc":0}]
}
}
(9) Minutely Summary
PS provides a data feed to obtain a summary of minutely players' activities.
※ NOTE: The calculation method for net revenue is bets placed minus rebates
PlayStar Gaming System - Integration Service API
Page 74 of 100
and Limited-activation Game Award payouts.
● Request
Name
Type
Description
host_id
string
Unique ID of Host System (provided by PS)
start_dt
string
The start date of date range to search on. Format of
the date entered must be yyyy-MM-ddTHH:mm:00,
the value of second will be ignored.
end_dt
string
The end date of date range to search on. Format of
the date entered must be yyyy-MM-ddTHH:mm:00,
the value of second will be ignored
member_id
string
Optional. Unique ID of the player (Max. 64 characters)
group_by
uint16
Optional. Grouped by the following fields
Value
Description
0
Unique ID of player and game (Default)
1
Unique ID of player
2
Unique ID of game
3
Unique ID of Host
4
Game type
5
Unique ID of player and game type
host_type
int
Optional. Host Type
Possible values are described below:
Value
Description
0
General (Default)
1
Master Account：Return all data of sub-
accounts (For master and sub-account
hierarchy)
game_id
string
Optional. Unique ID of PS Games
game_type
string
Optional. Game Type
Possible values are described below:
Value
Description
SLOT
Slot Games
CARD
Card Games
minute_type
string
Optional. Minute Type
Value
Description
0
Once every minute (Default)
1
Twice a minute
2
Three times a minute
category
String
Optional.
Value
Description
0
All(Default)
1
Include jp_game
2
Not include jp_game
PlayStar Gaming System - Integration Service API
Page 75 of 100
■ Example
https://{PS-API-
SERVER}/feed/minutelysummary/?host_id=a62b545a3c56ec719257e82d60dbc51
8&start_dt=2016-02-28T12:01:00&end_dt=2016-02-
29T11:01:00&member_id=player1
● Response
Name
Type
Description
gid
string
Unique ID of PS Games (Max. 64 characters)
sid
uint16
Sub-Game ID of PS Games
rnd
uint32
The daily amount of game rounds
bet
uint64
The daily amount of money bet (in cents)
win
uint64
The daily amount of money win (in cents, including
bonus win, gamble win)
bn
uint64
The daily amount of bonus win (in cents)
gb
uint64
The daily amount of gamble win (in cents)
jp
uint64
The daily amount of jackpot win (in cents)
gt
string
The game type of PS Games.
Value
Description
SLOT
Slot Games
CARD
Card Games
jc
float
The daily amount of jackpot contribution (in cents,
round off to 2
nd
decimal place)
■ Response Example
◆ Query without meber_id
{
"2016-02-28T17:01:00":{
"player1":[
{"gid":"PSS-ON-
00001","rnd":10,"bet":500,"win":500,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"gid":"PSS-ON-
00002","rnd":10,"bet":400,"win":400,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0}
],
"player2":[
{"gid":"PSS-ON-
00003","rnd":10,"bet":300,"win":300,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"gid":"PSS-ON-
00004","rnd":10,"bet":500,"win":500,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0}
]
},
"2016-02-29T10:01:00":{
"player1":[
PlayStar Gaming System - Integration Service API
Page 76 of 100
{"gid":"PSS-ON-
00001","rnd":10,"bet":500,"win":500,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"gid":"PSS-ON-
00002","rnd":10,"bet":400,"win":400,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0}
],
"player2":[
{"gid":"PSS-ON-
00003","rnd":10,"bet":300,"win":300,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"gid":"PSS-ON-
00004","rnd":10,"bet":500,"win":500,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0}
]
}
}
◆ Query with member_id=player1
{
"2016-02-28T17:01:00":{
"player1":[
{"gid":"PSS-ON-
00001","rnd":10,"bet":500,"win":500,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"gid":"PSS-ON-
00002","rnd":10,"bet":400,"win":400,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0}
]
},
"2016-02-29T10:01:00":{
"player1":[
{"gid":"PSS-ON-
00001","rnd":10,"bet":500,"win":500,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0},
{"gid":"PSS-ON-
00002","rnd":10,"bet":400,"win":400,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0}
]
}
}
◆ Query with group_by = 1
{
"2016-02-28T17:01:00":{
"player1": [{"rnd":20,"bet":900,"win":900,"bn":0,"gb":0,"jp":0,"jc":0}],
"player2": [{"rnd":20,"bet":800,"win":800,"bn":0,"gb":0,"jp":0,"jc":0}]
},
"2016-02-29T10:01:00":{
PlayStar Gaming System - Integration Service API
Page 77 of 100
"player1": [{"rnd":20,"bet":900,"win":900,"bn":0,"gb":0,"jp":0,"jc":0}],
"player2": [{"rnd":20,"bet":800,"win":800,"bn":0,"gb":0,"jp":0,"jc":0}]
}
}
◆ Query with group_by = 2
{
"2016-02-28T17:01:00":{
"PSS-ON-
00001":[{"rnd":10,"bet":500,"win":500,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0}],
"PSS-ON-
00002":[{"rnd":10,"bet":400,"win":400,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0}],
"PSS-ON-
00003":[{"rnd":10,"bet":300,"win":300,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0}],
"PSS-ON-
00004":[{"rnd":10,"bet":500,"win":500,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0}]
},
"2016-02-29T10:01:00":{
"PSS-ON-
00001":[{"rnd":10,"bet":500,"win":500,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0}],
"PSS-ON-
00002":[{"rnd":10,"bet":400,"win":400,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0}],
"PSS-ON-
00003":[{"rnd":10,"bet":300,"win":300,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0}],
"PSS-ON-
00004":[{"rnd":10,"bet":500,"win":500,"bn":0,"gb":0,"jp":0,"gt":"SLOT","jc":0}]
}
}
◆ Query with group_by = 3
{
"2016-02-28T17:01:00":{
"HOST-NAME-
A":[{"rnd":40,"bet":1700,"win":1700,"bn":0,"gb":0,"jp":0,"jc":0}]
},
"2016-02-29T10:01:00":{
"HOST-NAME-
A":[{"rnd":40,"bet":1700,"win":1700,"bn":0,"gb":0,"jp":0,"jc":0}]
}
}
◆ Query with group_by = 4
{
"2016-02-28T17:01:00":{
PlayStar Gaming System - Integration Service API
Page 78 of 100
"SLOT":[{"rnd":40,"bet":1700,"win":1700,"bn":0,"gb":0,"jp":0,"jc":0}]
},
"2016-02-29T10:01:00":{
"SLOT":[{"rnd":40,"bet":1700,"win":1700,"bn":0,"gb":0,"jp":0,"jc":0}]
}
}
◆ Query with group_by = 5
{
"2016-02-28T17:01:00":{
"player1":[
{"gt":"SLOT","rnd":10,"bet":500,"win":500,"bn":0,"gb":0,"jp":0,"jc":0}
],
"player2":[
{"gt":"SLOT","rnd":10,"bet":500,"win":500,"bn":0,"gb":0,"jp":0,"jc":0}
]
},
"2016-02-29T10:01:00":{
"player1":[
{"gt":"SLOT","rnd":10,"bet":500,"win":500,"bn":0,"gb":0,"jp":0,"jc":0}
],
"player2":[
{"gt":"SLOT","rnd":10,"bet":500,"win":500,"bn":0,"gb":0,"jp":0,"jc":0}
]
}
}
◆ Query with host_type = 1 and group_by=3
{
"2016-02-28T17:01:00":{
"HOST-NAME-
A":[{"rnd":40,"bet":1700,"win":1700,"bn":0,"gb":0,"jp":0,"jc":0}],
"HOST-NAME-B":[{"rnd":10,"bet":300,"win":300,"bn":0,"gb":0,"jp":0,"jc":0}]
},
"2016-02-29T10:01:00":{
"HOST-NAME-
A":[{"rnd":40,"bet":1700,"win":1700,"bn":0,"gb":0,"jp":0,"jc":0}],
"HOST-NAME-B":[{"rnd":10,"bet":300,"win":300,"bn":0,"gb":0,"jp":0,"jc":0}]
}
}
PlayStar Gaming System - Integration Service API
Page 79 of 100
(10) Error Accounts
PS provides a data feed to obtain error accounts which are occurred if Result
calls are failed for some reasons.
● Request
Name
Type
Description
host_id
string
Unique ID of Host System (provided by PS)
start_dt
string
The start date of date range to search on. Format of the
date entered must be yyyy-MM-dd.
end_dt
string
The end date of date range to search on.
■ Example
https://{PS-API-
SERVER}/feed/erroraccounts/?host_id=a62b545a3c56ec719257e82d60dbc518&st
art_dt=2016-02-28&end_dt=2016-02-28
● Response
Name
Type
Description
sn
uint64
Unique ID of the game round.
gid
string
Unique ID of PS Games (Max. 64 characters)
sid
uint16
Sub-Game ID of PS Games
pid
string
Unique ID of the player (Max. 64 characters)
bet
uint64
The amount of money bet (in cents)
win
uint64
The amount of money win (in cents, including bonus
win, gamble win, jackpot win)
err
int32
Error code. Possible values are described below:
Value
Description
1
Network Error
2
JSON Parsing Error
3
Data Scheme Error
4
Host Response Error (status_code is not 0)
5
Negative Error (balance is negative)
tm
string
Error occurred time.
■ Response Example
{
"2015-02-28":[
{"sn":1,"gid":"PSS-ON-
00001","sid":0,"pid":"player1","bet":500,"win":500,"err":1,"tm":"05:50:15"},
{"sn":2,"gid":"PSS-ON-
00003","sid":0,"pid":"player2","bet":300,"win":0,"err":2,"tm":"22:10:33"}
]
}
PlayStar Gaming System - Integration Service API
Page 80 of 100
PlayStar Gaming System - Integration Service API
Page 81 of 100
(11) Uncompleted Games
PS provides a data feed to obtain players’ uncompleted game rounds in a date
range for a host system.
● Request
Name
Type
Description
host_id
string
Unique ID of Host System (provided by PS)
member_id
string
Optional. Unique ID of player. (Max. 64 characters)
※ Return all players’ data if this field is not given.
game_id
string
Optional. Unique ID of PS Games (Max. 64 characters)
start_dtm
string
The start date-time of date-time range to search on.
The format is yyyy-MM-ddTHH:mm:ss
end_dtm
string
The end date-time of date-time range to search on.
■ Example
https://{PS-API-
SERVER}/feed/uncompletedgames/?host_id=a62b545a3c56ec719257e82d60dbc
518&member_id=player1&start_dtm=2016-02-28T02:00:00&end_dtm=2016-02-
29T02:01:00
● Response
Name
Type
Description
pid
string
Unique ID of player (Max. 64 characters)
gid
string
Unique ID of PS Games (Max. 64 characters)
sn
uint64
Unique ID of the game round.
tm
string
The time of the game round. The format is format is
HH:mm:ss
bet
uint64
The amount of money bet (in cents)
■ Response Example
{
"2016-02-28": [
{"pid":"player1","gid":"PSS-ON-
00001","sn":2434081949,"tm":"03:06:55","bet":300},
{"pid":"player1","gid":"PSS-ON-
00003","sn":2434081950,"tm":"15:07:07","bet":300}
]
}
PlayStar Gaming System - Integration Service API
Page 82 of 100
(12) Eventlist
PS provides a data feed to obtain event list
● Request
Name
Type
Description
host_id
string
Unique ID of Host System (provided by PS)
event_id
string
Unique ID of Event (provided by PS)
weeknum
Uint64
Optional. Week number
※ Return all weeks’ data if this field is not given.
rank_id
string
Optional. rank ID
rank_type
string
Optional. rank type
Value
Description
1
Play times
2
Total bet
3
Total win
game_type
string
Optional.game id/game type
■ Example
https://{PS-API-
SERVER}/feed/eventlist?host_id=a62b545a3c56ec719257e82d60dbc518&event_i
d=2021030201
&weeknum=1&rank_id=1&rank_type=3&game_type=slot
● Response
Name
Type
Description
rank_id
string
Rank ID
rank_type
string
Rank type
start_time
string
The start date-time of event.
The format is yyyy-MM-ddTHH:mm:ss
end_time
string
The end date-time of event.
The format is yyyy-MM-ddTHH:mm:ss
type
string
Game id/ game type
Top_row_coun
t
uint64
Total number of event
■ Response Example
{
"2021030201":
PlayStar Gaming System - Integration Service API
Page 83 of 100
{"1":
[{"rank_id":1,"rank_type":3,"start_time":"2021-03-02
08:00:00","end_time":"2021-03-10 07:59:59","type":"SLOT","top_row_count":0},
{"rank_id":3,"rank_type":3,"start_time":"2021-03-02
08:00:00","end_time":"2021-03-10
07:59:59","type":"CARD","top_row_count":0},
]}}
PlayStar Gaming System - Integration Service API
Page 84 of 100
(13) Event Rank
PS provides a data feed to obtain event rank。
● Request
Name
Type
Description
host_id
string
Unique ID of Host System (provided by PS)
event_id
string
Unique ID of Event (provided by PS)
weeknum
Uint64
Optional. Week number
※ Return all weeks’ data if this field is not given.
rank_id
Uint64
Optional. Rank ID
■ Example
https://{PS-API-
SERVER}/feed/eventrank?host_id=a62b545a3c56ec719257e82d60dbc518&event_
id=2021030201
&weeknum=1&rank_id=1
● Response
Name
Type
Description
ranknum
string
Rank number
member_id
string
Unique ID of player (Max. 64 characters)
game_time
uint64
Game times
bet
uint64
Total bet
win
uint64
Total win
update_time
string
The last date-time of playing game.
The format is yyyy-MM-ddTHH:mm:ss
■ Response Example
{"1":
{"3":
[{"ranknum":1,"member_id":"adam","game_time":47,"bet":969638545
0,"win":2232669100,"update_time":"2021-03-05 15:39:04"},
{"ranknum":2,"member_id":"lucy","game_time":4,"bet":446513310,"
win":893026220,"update_time":"2021-03-04 15:13:33"}]
}
}
PlayStar Gaming System - Integration Service API
Page 85 of 100
(14) Event award log
PS provides a data feed to obtain event award log。
● Request
Name
Type
Description
host_id
string
Unique ID of Host System (provided by PS)
event_id
string
Optional. Unique ID of Event (provided by PS)
※ Return all events’ data if this field is not given.
weeknum
Uint64
Optional. Week number
※ Return all weeks’ data if this field is not given.
rank_id
Uint64
Optional. RankID
member_id
string
Optional. Unique ID of player
start_dtm
string
Optional. The start date-time of event.
The format is yyyy-MM-ddTHH:mm:ss
end_dtm
string
Optional. The end date-time of event.
The format is yyyy-MM-ddTHH:mm:ss
sn
Uint64
sn
■ Example
https://{PS-API-
SERVER}/feed/eventawardlog?host_id=a62b545a3c56ec719257e82d60dbc518&ev
ent_id=2021030201
&weeknum=1&rank_id=1&member_id=john&start_dtm=2021-03-
19T02:00:00&end_dtm=2021-03-20T02:01:00
● Response
Name
Type
Description
event_id
string
Unique ID of Event
weeknum
Uint64
Week number
rank_id
Uint64
Rank ID
member_id
string
Unique ID of player
send_time
string
The occurred date/time.
amount
uint64
Amount of funds to be transfer out (in cents).
balance
uint64
The balance after the transation
sn
uint64
sn
■ Response Example
[
PlayStar Gaming System - Integration Service API
Page 86 of 100
{
"event_id": "2021030201",
"weeknum": 1,
"rank_id": 1,
"member_id": "john",
"send_time": "2021-03-19 14:22:58",
"amount": 200,
"balance": 300,
"sn": 1
}
]
PlayStar Gaming System - Integration Service API
Page 87 of 100
(15) Event Score Award Log
PS provides a data feed to obtain event score award log。
● Request
Name
Type
Description
host_id
string
Unique ID of Host System (provided by PS)
event_score_list_i
d
int
Optional. Unique ID of EventScore (provided by PS)
※ Return all events’ data if this field is not given.
weeknum
Uint64
Optional. Week number
※ Return all weeks’ data if this field is not given.
rank_id
Uint64
Optional. RankID
member_id
string
Optional. Unique ID of player
start_dtm
string
Optional.The start date-time of event.
The format is yyyy-MM-ddTHH:mm:ss
end_dtm
string
Optional.The end date-time of event.
The format is yyyy-MM-ddTHH:mm:ss
sn
Uint64
sn
■ Example
https://{PS-API-
SERVER}/feed/eventScoreawardlog?host_id=a62b545a3c56ec719257e82d60dbc5
18&event_score_list_id
=1&weeknum=1&rank_id=1&member_id=john&start_dtm=2021-03-
19T02:00:00&end_dtm=2021-03-20T02:01:00
● Response
Name
Type
Description
event_score_list_i
d
int
Unique ID of EventScore
weeknum
Uint6
4
Week number
rank_id
Uint6
4
Rank ID
member_id
string
Unique ID of player
send_time
string
The occurred date/time.
amount
uint64
Amount of funds to be transfer out (in cents).
balance
uint64
The balance after the transation
PlayStar Gaming System - Integration Service API
Page 88 of 100
sn
uint64
sn
■ Response Example
[
{
"event_score_list_id": 1,
"weeknum": 1,
"rank_id": 1,
"member_id": "john",
"send_time": "2021-03-19 14:22:58",
"amount": 200,
"balance": 300,
"sn": 1
}
]
PlayStar Gaming System - Integration Service API
Page 89 of 100
(16) Limited-activation Game Award payouts
PS provides a data feed to red envelope award log。
● Request
Name
Type
Description
host_id
string
Unique ID of Host System (provided by PS)
event_type
int
Optional. Event Type
Possible values are described below:
Value
Description
2
Limited-activation Game Award
start_dtm
string
Optional.The start date-time of event.
The format is yyyy-MM-ddTHH:mm:ss
end_dtm
string
Optional.The end date-time of event.
The format is yyyy-MM-ddTHH:mm:ss
■ Example
https://{PS-API-
SERVER}/event/sendawardlog?host_id=439f4fae336342184a5bf10672269e4e&ev
ent_type=2&start_dtm=2023-05-24T13:00:00&end_dtm=2023-05-24T14:00:00
● Response
Name
Type
Description
member_id
string
Unique ID of player.
amount
int
Amount of the bonus reward (in cents).
dtm
string
The occurred date/time.
sn
int
Unique ID of the game round.
■ Response Example
[{
"member_id": "member001",
"amount": 50000,
"dtm": "2023-05-15 00:00:00",
"sn": 991,
},
{
"member_id": "member002",
"amount": 50000,
"dtm": "2023-05-15 00:00:00",
"sn": 992,
}]
PlayStar Gaming System - Integration Service API
Page 90 of 100
(17) GetBannedPlayer
※ NOTE: The following APIs require an "Admin" whitelist to set up additionally.
● Request
Name
Type
Description
host_id
string
Unique ID of Host System (provided by PS)
■ Example
https://{PS-API-
SERVER}/admin/getbannedplayer/?host_id=a62b545a3c56ec719257e82d60dbc51
8
● Response
Name
Type
Description
status_code
int
status:
code
Description
0
SUCCESS
2
Host ID invalid
5
System error
11
Dummy2 api error
list
list
Banned player list
■ Response Example
{
"status_code": 0,
"list": [
"timmy9999",
"timmy9997",
"timmy9998"
]
}
PlayStar Gaming System - Integration Service API
Page 91 of 100
(18) Ban/Unban
※ NOTE: The following APIs require an "Admin" whitelist to set up additionally.
● Request
Name
Type
Description
host_id
string
Unique ID of Host System (provided by PS)
type
int
1:ban, 2:Unban
player_list
list
list ex.leo,leo2,leo3
■ Example
https://{PS-API-SERVER}/admin/banplayeraction/?
host_id=a62b545a3c56ec719257e82d60dbc518&type=1&player_list=leo&player_l
ist=leo2
● Response
Name
Type
Description
status_code
int
status:
code
Description
0
1
SUCCESS
MemberID ID invalid
2
Host ID invalid
5
System error
11
Dummy2 api error
■ Response Example
{
"status_code": 0
}
PlayStar Gaming System - Integration Service API
Page 92 of 100
8. Game Administration (Host → PS)
PS provides the following functions for game administration.
※ NOTE: The following APIs require an "Admin" whitelist to set up additionally.
※ In order to operate the APIs, please inform the customer support ahead.
(1) Clear Recovery
(2) Update Host API Info
(3) Get Host API Info
(4) Kick Out
(5) Update Member Info
(6) Get Member Info
PlayStar Gaming System - Integration Service API
Page 93 of 100
(1) Clear Recovery (Host → PS)
In order to operate the APIs, please inform the customer support ahead to help
you with the additional set up of the whitelist.
PS provides this function to clear recovery data of specified member.
● Request
Name
Type
Description
host_id
string
Unique ID of Host System (provided by PS)
member_id
string
Unique ID of the player (Max. 64 characters).
game_id
string
Unique ID of PS Games (Max. 64 characters)
■ Example
https://{PS-API-
SERVER}/admin/clearrecovery/?host_id=a62b545a3c56ec719257e82d60dbc518&
member_id=test1&game_id=PSS-ON-00003
● Response
Name
Type
Description
status_code
int
Possible values are described below:
Code
Description
0
Success
1
Invalid Member ID or Recover Data
2
Invalid Host ID
■ Response Example
{
"status_code": 0
}
PlayStar Gaming System - Integration Service API
Page 94 of 100
(2) Update Host API Info. (Host → PS)
In order to operate the APIs, please inform the customer support ahead to help
you with the additional set up of the whitelist.
PS provides this function to update host API information.
● Request
Name
Type
Description
host_id
string
Unique ID of Host System (provided by PS)
base_url
string
Optional. The base URL of the host API.
auth
string
Optional. The relative path of Authenticate.
logout
string
Optional. The relative path of Logout.
bet
string
Optional. The relative path of Bet.
result
string
Optional. The relative path of Result.
refundbet
string
Optional. The relative path of Refund Bet.
bonusawar
d
string
Optional. The relative path of Bonus Award.
resultex
string
Optional. The relative path of Result (Exceptional Case).
getbalance
string
Optional. The relative path of Get Balance.
■ Example
https://{PS-API-
SERVER}/admin/updatehostapiinfo/?host_id=a62b545a3c56ec719257e82d60dbc
518&base_url=http%3A%2F%2Fapi.hostname.com%3A1234%2Fapi
● Response
Name
Type
Description
status_code
int
Possible values are described below:
Code
Description
0
Success
2
Invalid Host ID
4
Invalid Format
11
Dummy2 Maintenance
host_api_info
object
The updated host API information.
■ Response Example
{
"status_code": 0,
"host_api_info": {
"base_url": "http://api.hostname.com:1234/api",
"auth": "auth",
"logout": "logout",
"bet": "bet",
"result": "result",
"refundbet": "refundbet",
PlayStar Gaming System - Integration Service API
Page 95 of 100
"bonusaward": "bonusaward",
"resultex": "resultex",
"getbalance": "getbalance"
}
}
PlayStar Gaming System - Integration Service API
Page 96 of 100
(3) Get Host API Info. (Host → PS)
In order to operate the APIs, please inform the customer support ahead to help
you with the additional set up of the whitelist.
PS provides this function to retrieve host API information.
● Request
Name
Type
Description
host_id
string
Unique ID of Host System (provided by PS)
■ Example
https://{PS-API-
SERVER}/admin/gethostapiinfo/?host_id=a62b545a3c56ec719257e82d60dbc518
● Response
Name
Type
Description
status_code
int
Possible values are described below:
Code
Description
0
Success
2
Invalid Host ID
host_api_info
object
The host API information.
■ Response Example
{
"status_code": 0,
"host_api_info": {
"base_url": "http://api.hostname.com:1234/api",
"auth": "auth",
"logout": "logout",
"bet": "bet",
"result": "result",
"refundbet": "refundbet",
"bonusaward": "bonusaward",
"resultex": "resultex",
"getbalance": "getbalance"
}
}
PlayStar Gaming System - Integration Service API
Page 97 of 100
(4) Kick Out (Host → PS)
In order to operate the APIs, please inform the customer support ahead to help
you with the additional set up of the whitelist.
PS provides this function to kick players out of the games.
● Request
Name
Type
Description
host_id
string
Unique ID of Host System (provided by PS)
member_id
string
Optional. Unique ID of the player (Max. 64 characters)
game_id
string
Optional. Unique ID of PS Games (Max. 64 characters)
subgame_id
uint16
Optional. Sub-Game ID of PS Games
■ Example
https://{PS-API-
SERVER}/admin/kickout/?host_id=a62b545a3c56ec719257e82d60dbc518
● Response
Name
Type
Description
status_code
int
Possible values are described below:
Code
Description
0
Success
4
Invalid Host ID
6
No player online
■ Response Example
{
"status_code": 0
}
PlayStar Gaming System - Integration Service API
Page 98 of 100
(5) Update Member Info. (Host → PS)
In order to operate the APIs, please inform the customer support ahead to help
you with the additional set up of the whitelist.
PS provides this function to update member information (Only provided for
customized game settings).
● Request
Name
Type
Description
host_id
string
Unique ID of Host System (provided by PS)
member_id
string
Unique ID of the player (Max. 64 characters)
default_rate_index
uint16
Default rate index for all games
■ Example
https://{PS-API-
SERVER}/admin/updatememberinfo/?host_id=a62b545a3c56ec719257e82d60db
c518&member_id=test&default_rate_index=0
● Response
Name
Type
Description
status_code
int
Possible values are described below:
Code
Description
0
Success
1
Invalid Member ID
2
Invalid Host ID
5
System Error
member_info
object
The updated member information.
■ Response Example
{
"status_code": 0,
"member_info": {
"default_rate_index": 0
}
}
PlayStar Gaming System - Integration Service API
Page 99 of 100
(6) Get Member Info. (Host → PS)
In order to operate the APIs, please inform the customer support ahead to help
you with the additional set up of the whitelist.
PS provides this function to retrieve member information (Only provided for
customized game settings).
● Request
Name
Type
Description
host_id
string
Unique ID of Host System (provided by PS)
member_id
string
Unique ID of the player (Max. 64 characters)
■ Example
https://{PS-API-
SERVER}/admin/getmemberinfo/?host_id=a62b545a3c56ec719257e82d60dbc518
&member_id=test
● Response
Name
Type
Description
status_code
int
Possible values are described below:
Code
Description
0
Success
1
Invalid Member ID
2
Invalid Host ID
member_info
object
The member information.
■ Response Example
{
"status_code": 0,
"member_info": {
"default_rate_index": 0
}
}
PlayStar Gaming System - Integration Service API
Page 100 of 100
Appendix
● Support Languages
Language
Description
en-US
English
zh-CN
Chinese Simplified
zh-TW
Chinese Traditional
th-TH
Thai (Thailand)
ms-MY
Malay (Malaysia)
ko-KR
Korean (Korea)
vi-VN
Vietnamese (Vietnam)
id-ID
Indonesian (Indonesia)
ja-JP
Japanese
ru-RU
Russian
po-BR
Portugal
es-SP
Español
tr-TR
Türkçe
