catalogs
Global Parameter List ..........................................................................................................................
Global Parameters ..............................................................................................................................
Interface List ..........................................................................................................................................
External interfaces .............................................................................................................................
Add Player Account ..........................................................................................................................
recharge ..............................................................................................................................................
withdraw .............................................................................................................................................
Get Player Balance ............................................................................................................................
Get Agent Balance ............................................................................................................................
Login name to get player ID ...........................................................................................................
Getting low-balance users ..............................................................................................................
Reset Player Password .....................................................................................................................
Force Player Offline ...............................................................................................................................
Appendices .............................................................................................................................................
Project Status Code Dictionary .......................................................................................................
page 1/18
1 Global Parameter List
1.1 Global Parameters
Description of request parameters：
Parameter
parameter name Example values
Description
agent_id 1 agent id
timestamp 1709867667 A 10-digit timestamp.
A 32-character
lowercase
token bb2d4c312195711cc2fca531b7d8cc48 string,signature=MD5
(agent_id:timestamp:
secret_key)
2 Interface List
page 2/18
2.1 External interfaces
2.1.1 Add Player Account
Interface URL：[Link] name/api/external/addUser
Content-Type：multipart/form-data
Request method：post
Description of the request body parameters:
Parameter Required Parameter
parameter name Example values
type or not Description
account Test_user String Yes login name
login_pwd 123123 String Yes login password
Return parameter description: (200) Successful
Parameter Parameter
parameter name Example values
type Description
code 0 Number Response Codes
Return to text
msg Success String
description
data Object Return data
data.account_name Test_user String player login name
data.user_id 88886468 String Player id
count 0 Number
Return Example: (200) Successful
page 3/18
{
"code": 0,
"msg": "Success",
"data": {
"account_name": "Test_user",
"user_id": "88886468"
},
"count": 0
Return parameter description: (201) Failure
Parameter Parameter
parameter name Example values
type Description
No request parameter KEY/VALUE type
2.1.2 Recharge
Interface URL：[Link] name/api/external/recharge
Content-Type：multipart/form-data
Request method：post
Description of the request body parameters:
Parameter Required Parameter
parameter name Example values
type or not Description
user_id 88880188 String Yes Player id
page 4/18
amount 5 String Yes recharge amount
Agent's recharge
order_id 100001 String Yes
order ID
Return parameter description: (200) Successful
Parameter Parameter
parameter name Example values
type Description
code 0 Number Response Codes
Return to text
msg Success String
description
data Object Return data
data.agent_balance 36390057 String agent balance
[Link] 5 String recharge amount
agent recharge order
data.pay_order_id pay:11:100001 String
id
data.transaction_id pay:11:100001 String platform order id
data.transaction_time 1709798588 String Trading Order Time
data.user_balance 150000 String user balance
count 0 Number
Return Example: (200) Successful
"code": 0,
"msg": "Success",
"data": {
"agent_balance": "36390057",
page 5/18
"amount": "5",
"pay_order_id": "pay:11:100001",
"transaction_id": "pay:11:100001",
"transaction_time": "1709798588",
"user_balance": "150000"
},
"count": 0
2.1.3 Withdraw
Interface URL：[Link] name/api/external/withdraw
Content-Type：multipart/form-data
Request method：post
Description of the request body parameters:
Parameter Required Parameter
parameter name Example values
type or not Description
user_id 88880188 String Yes Player id
amount 5 String Yes recharge amount
Agent's withdraw
order_id 100002 String Yes
order ID
Return parameter description: (200) Successful
page 6/18
Parameter Parameter
parameter name Example values
type Description
code 0 Number Response Codes
Return to text
msg Success String
description
data Object Return data
data.agent_balance 36440057 String agent balance
[Link] 5 String recharge amount
data.transaction_id wdw:11:100002 String Platform order id
data.transaction_time 1709798910 String Trading Order Time
data.user_balance 100000 String user balance
agent withdraw order
data.wdw_order_id wdw:11:100002 String
id
count 0 Number
Return Example: (200) Successful
"code": 0,
"msg": "Success",
"data": {
"agent_balance": "36440057",
"amount": "5",
"transaction_id": "wdw:11:100002",
"transaction_time": "1709798910",
"user_balance": "100000",
page 7/18
"wdw_order_id": "wdw:11:100002"
},
"count": 0
2.1.4 Get Player Balance
Interface URL：[Link] name/api/external/userBalance
Content-Type：multipart/form-data
Request method：post
Description of the request body parameters:
Parameter Required Parameter
parameter name Example values
type or not Description
user_id 88880212 String Yes Player id
Return parameter description: (200) Successful
Parameter Parameter
parameter name Example values
type Description
code 0 Number Response Codes
Return to text
msg Success String
description
data Object Return data
data.user_balance 60 String user balance
count 0 Number
page 8/18
Return Example: (200) Successful
"code": 0,
"msg": "Success",
"data": {
"user_balance": "60"
},
"count": 0
2.1.5 Get Agent Balance
Interface URL：[Link] name/api/external/agentBalance
Content-Type：multipart/form-data
Request method：post
Description of the request body parameters:
Parameter Required Parameter
parameter name Example values
type or not Description
No request parameter KEY/VALUE type
Return parameter description: (200) Successful
page 9/18
Parameter Parameter
parameter name Example values
type Description
code 0 Number Response Codes
Return to text
msg Success String
description
data Object Return data
data.agent_balance 3649.0057 String agent balance
count 0 Number
Return Example: (200) Successful
"code": 0,
"msg": "Success",
"data": {
"agent_balance": "3649.0057"
},
"count": 0
2.1.6 Login name to get player ID
Interface URL：[Link] name/api/external/getUserID
Content-Type：multipart/form-data
Request method：post
page 10/18
Description of the request body parameters:
Parameter Required Parameter
parameter name Example values
type or not Description
account_name user020301 String Yes player login name
Return parameter description: (200) Successful
Parameter Parameter
parameter name Example values
type Description
code 0 Number Response Codes
Return to text
msg Success String
description
data Object Return data
data.user_id 88880212 String Player id
count 0 Number
Return Example: (200) Successful
"code": 0,
"msg": "Success",
"data": {
"user_id": "88880212"
},
"count": 0
page 11/18
2.1.7 Getting low-balance users
Interface URL：[Link] name/api/external/external/getLowDepositUsers
Content-Type：multipart/form-data
Request method：post
Description of the request body parameters:
Parameter Required Parameter
parameter name Example values
type or not Description
query_date 2024-03-07 String yes query date
page 1 Integer yes pagination
page_size 20 Integer yes Number of pages
Return Example: (200) Successful
Parameter Parameter
parameter name Example values
type Description
code 0 Number Response Codes
Return to text
msg Success String
description
data Object Return data
data.account_name user011110 String player login name
data.agent_id 11 Number agent id
data.day_recharge 10 Number Same Day Recharge
data.user_balance 10 String user balance
data.user_id 88880188 String Player id
count 1 Number total number of
page 12/18
articles
Return Example: (200) Successful
"code": 0,
"msg": "Success",
"data": [
"account_name": "user011110",
"agent_id": 11,
"day_recharge": 10,
"user_balance": 10,
"user_id": 88880188
],
"count": 1
2.1.8 Reset Player Password
Interface URL：[Link] name/api/external/resetPassword
page 13/18
Content-Type：multipart/form-data
Request method：post
Description of the request body parameters:
Parameter Required Parameter
parameter name Example values
type or not Description
user_id 88880212 String Yes Player id
login_pwd 123123 String Yes login password
Return parameter description: (200) Successful
Parameter Parameter
parameter name Example values
type Description
code 0 Number Response Codes
Return to text
msg Success String
description
data Object Return data
count 0 Number
Return Example: (200) Successful
"code": 0,
"msg": "Success",
"data": null,
"count": 0
page 14/18
2.1.9 Force Player Offline
Interface URL：[Link] name/api/external/playerOffline
Content-Type：multipart/form-data
Request method：post
Description of the request body parameters:
Parameter Required Parameter
parameter name Example values
type or not Description
user_id 88880212 String Yes Player id
Return parameter description: (200) Successful
Parameter Parameter
parameter name Example values
type Description
code 0 Number Response Codes
Return to text
msg Success String
description
data Object Return data
count 0 Number
Return Example: (200) Successful
"code": 0,
"msg": "Success",
"data": null,
"count": 0
page 15/18
}
page 16/18
3 Appendices
3.1 Project Status Code Dictionary
status code description
1 Invalid agent ID
2 Invalid request parameters
3 Invalid token
4 Token expired
5 Access ip is not white ip
6 Insufficient agent balance
7 Insufficient user balance
8 Invalid user ID
9 User account frozen
10 User is in game
11 Invalid amount
12 Recharge failed, please try again later
13 Recharge permission denied
14 Withdrawal failed, please try again later
15 Withdrawal amount exceeds daily limit
page 17/18
16 Withdrawal under review
17 Withdrawal permission denied
18 Account name format error,contain letters, numbers, and underscores
19 Agent no register user permission
20 Account name already exists
21 System failed
22 Num of register ip exceeds the upper limit
23 Password digits 6 to 32 characters
400 Parameter error
page 18/18