GameVault

Add player accounts, recharge, withdraw, balances, password reset and forcing players offline.

Base URL: http://domain name/api/external
Authentication: MD5 token (agent_id:timestamp:secret_key)
Sections: 11

GAMEVAULT API Documentation.docx DOCX, 36 KB

Global Parameters#

Description of request parameters：

parameter name	Example values	Parameter Description
agent_id	1	agent id
timestamp	1709867667	A 13-digit timestamp.
token	bb2d4c312195711cc2fca531b7d8cc48	A 32-character uppercase string,signature=MD5(agent_id:timestamp:secret_key).ToUpper

Add Player Account#

Interface URL：http://domain name/api/external/addUser

Content-Type：multipart/form-data

Request method：POST

Description of the request body parameters:

parameter name	Example values	Parameter type	Required or not	Parameter Description
account	Test_user	String	Yes	login name
login_pwd	123123	String	Yes	login password

Return parameter description: (200) Successful

parameter name	Example values	Parameter type	Parameter Description
code	0	Number	Response Codes
msg	Success	String	Return to text 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

{
	"code": 0,
	"msg": "Success",
	"data": {
		"account_name": "Test_user",
		"user_id": "88886468"
	},
	"count": 0
}

Return parameter description: (201) Failure

parameter name	Example values	Parameter type	Parameter Description
No request parameter KEY/VALUE type

Recharge#

Interface URL：http://domain name/api/external/recharge

Content-Type：multipart/form-data

Request method：POST

Description of the request body parameters:

parameter name	Example values	Parameter type	Required or not	Parameter Description
user_id	88880188	String	Yes	Player id
amount	5	String	Yes	recharge amount
order_id	100001	String	Yes	Agent's recharge order ID

Return parameter description: (200) Successful

parameter name	Example values	Parameter type	Parameter Description
code	0	Number	Response Codes
msg	Success	String	Return to text description
data		Object	Return data
data.agent_balance	36390057	String	agent balance
data.amount	5	String	recharge amount
data.pay_order_id	pay:11:100001	String	agent recharge order 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",
		"amount": "5",
		"pay_order_id": "pay:11:100001",
		"transaction_id": "pay:11:100001",
		"transaction_time": "1709798588",
		"user_balance": "150000"
	},
	"count": 0
}

Withdraw#

Interface URL：http://domain name/api/external/withdraw

Content-Type：multipart/form-data

Request method：POST

Description of the request body parameters:

parameter name	Example values	Parameter type	Required or not	Parameter Description
user_id	88880188	String	Yes	Player id
amount	5	String	Yes	recharge amount
order_id	100002	String	Yes	Agent's withdraw order ID

Return parameter description: (200) Successful

parameter name	Example values	Parameter type	Parameter Description
code	0	Number	Response Codes
msg	Success	String	Return to text description
data		Object	Return data
data.agent_balance	36440057	String	agent balance
data.amount	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
data.wdw_order_id	wdw:11:100002	String	agent withdraw order 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",
		"wdw_order_id": "wdw:11:100002"
	},
	"count": 0
}

Get Player Balance#

Interface URL：http://domain name/api/external/userBalance

Content-Type：multipart/form-data

Request method：POST

Description of the request body parameters:

parameter name	Example values	Parameter type	Required or not	Parameter Description
user_id	88880212	String	Yes	Player id

Return parameter description: (200) Successful

parameter name	Example values	Parameter type	Parameter Description
code	0	Number	Response Codes
msg	Success	String	Return to text description
data		Object	Return data
data.user_balance	60	String	user balance
count	0	Number

Return Example: (200) Successful

{
	"code": 0,
	"msg": "Success",
	"data": {
		"user_balance": "60"
	},
	"count": 0
}

Get Agent Balance#

Interface URL：http://domain name/api/external/agentBalance

Content-Type：multipart/form-data

Request method：POST

Description of the request body parameters:

parameter name	Example values	Parameter type	Required or not	Parameter Description
No request parameter KEY/VALUE type

Return parameter description: (200) Successful

parameter name	Example values	Parameter type	Parameter Description
code	0	Number	Response Codes
msg	Success	String	Return to text 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
}

Interface URL：http://domain name/api/external/getUserID

Content-Type：multipart/form-data

Request method：POST

Description of the request body parameters:

parameter name	Example values	Parameter type	Required or not	Parameter Description
account_name	user020301	String	Yes	player login name

Return parameter description: (200) Successful

parameter name	Example values	Parameter type	Parameter Description
code	0	Number	Response Codes
msg	Success	String	Return to text 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
}

Getting low-balance users#

Interface URL：http://domain name/api/external/external/getLowDepositUsers

Content-Type：multipart/form-data

Request method：POST

Description of the request body parameters:

parameter name	Example values	Parameter type	Required or not	Parameter 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 name	Example values	Parameter type	Parameter Description
code	0	Number	Response Codes
msg	Success	String	Return to text 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 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
}

Reset Player Password#

Interface URL：http://domain name/api/external/resetPassword

Content-Type：multipart/form-data

Request method：POST

Description of the request body parameters:

parameter name	Example values	Parameter type	Required or not	Parameter Description
user_id	88880212	String	Yes	Player id
login_pwd	123123	String	Yes	login password

Return parameter description: (200) Successful

parameter name	Example values	Parameter type	Parameter Description
code	0	Number	Response Codes
msg	Success	String	Return to text description
data		Object	Return data
count	0	Number

Return Example: (200) Successful

{
	"code": 0,
	"msg": "Success",
	"data": null,
	"count": 0
}

Force Player Offline#

Interface URL：http://domain name/api/external/playerOffline

Content-Type：multipart/form-data

Request method：POST

Description of the request body parameters:

parameter name	Example values	Parameter type	Required or not	Parameter Description
user_id	88880212	String	Yes	Player id

Return parameter description: (200) Successful

parameter name	Example values	Parameter type	Parameter Description
code	0	Number	Response Codes
msg	Success	String	Return to text description
data		Object	Return data
count	0	Number

Return Example: (200) Successful

{
	"code": 0,
	"msg": "Success",
	"data": null,
	"count": 0
}

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
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

Global Parameters#

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#

Project Status Code Dictionary#