#
Description
- In-game payment order
Request URL
- Test environment: see create_order field in Obtain Server End API Configurations
- Production environment: see create_order field in Obtain Server End API Configurations
Request Method
- Transmission protocol: HTTPS
- Request method: POST
- Parameters are transmitted in the body in JSON format (see request example)
- Add the following headers to the request: Content-Type: application/json;charset=utf-8
- Add the following headers to the request: Authentication header Authorization
Request Header [Authorization]
Request Parameters
Parameter | Required | Type | Description |
---|---|---|---|
out_order_id | Yes | string | Merchant-defined unique order ID (up to 64 characters) |
out_group_id | No | string | Merchant-defined order group ID (up to 64 characters, used to classify the same group of order IDs |
mg_id | Yes | string | Game ID |
room_id | Yes | string | Room ID |
cmd | Yes | string | Triggered action |
from_uid | Yes | string | Paying user UID |
to_uid | Yes | string | Target user UID |
value | Yes | int32 | Game value |
payload | Special Optional | object | Additional data (When the game client transparently transmits this parameter value to the app client, it needs to be transparently transmitted as is) |
Game cmd | value | payload Parameter Correspondence Table:
Texas Holdem, Game ID=1557194155570024449
cmd | value | payload | Description |
---|---|---|---|
add_score | Score | Enter score |
- TeenPatti, Game ID=1557194487352053761
cmd | value | payload | Description |
---|---|---|---|
add_score | Score | Enter score |
- Space Killing, Game ID=1559736844916183041
cmd | value | payload | Description |
---|---|---|---|
gift | 1 //0.5 tickets 2 //1 ticket 3 //1.5 tickets 4 //2 tickets 5 //2.5 tickets 6 //3 tickets 7 //3.5 tickets 8 //4 tickets 9 //4.5 tickets 10 //5 tickets |
Reward |
- Customized Rocket, Game ID=1583284410804244481
cmd | value | payload | Description |
---|---|---|---|
buy_component | Buy components | ||
fire_model | Launch rocket |
- Werewolf Killing, Game ID=1472142747708284929
cmd | value | payload | Description |
---|---|---|---|
buy_role | Specified role ID, example: {"role_id":1}. role_id description: 1 werewolf, 2 villager, 3 prophet, 4 witch, 5 hunter, 6 guard |
Buy role |
- Baseball, Game ID=1594978084509368321
cmd | value | payload | Description |
---|---|---|---|
buy_baseball | Number of purchased baseballs | Example: {"is_add":0}. is_add description: whether to increase the distance, 0 means not to increase, 1 means to increase | Hit N baseballs at a time, value indicates the number of purchased baseballs |
buy_combo_baseball | Number of purchased baseballs | Example: {"is_add":0}. is_add description: whether to increase the distance, 0 means not to increase, 1 means to increase | Combo baseball, hit one baseball each time, value indicates the number of purchased baseballs |
- Who is spy, Game ID=1599672757949743105
Event | value | cmd Additional Data (payload) | Description |
---|---|---|---|
buy_props | Money spent | Example: {"index":0}. index description: 0 means egg, 1 means flower | value indicates consumption |
- Ludo, Game ID=1468180338417074177
Event | value | cmd Additional Data (payload) | Description |
---|---|---|---|
reroll_the_dice | Specific price | Current step number, example: {"seq":1} | Reroll dice, value indicates current price |
- UMO, Game ID=1472142559912517633
Event | value | cmd Additional Data (payload) | Description |
---|---|---|---|
auto_umo | Automatically shout UMO, can be purchased anytime in the game |
- Deminers, Game ID=1472142640866779138
Event | value | cmd Additional Data (payload) | Description |
---|---|---|---|
change_hand | Specific price | Change hand, can be changed up to 1 time at the beginning of each round |
- Crazy Racing, Game ID=1649319572314173442
Event | value | cmd Additional Data (payload) | Description |
---|---|---|---|
add_score | Betting amount | Example: {"betChip":[20,20,0]} | Betting amount of the three cars respectively |
- 777/Slots, Game ID=1641329941723648002
Event | value | cmd Additional Data (payload) | Description |
---|---|---|---|
add_score | Betting amount | Example: {"betChip":500} | Enter score |
- gobang Professional Edition, Game ID = 1676069429630722049
Event | value | cmd Additional Data (payload) | Description |
---|---|---|---|
retract | Retract Price | Retracts a single move. "Value" represents the current price. |
- Jump Jump, Game ID=1680881367829176322
Event | Value | CMD Additional Data (Payload) | Description |
---|---|---|---|
hit | Price for guaranteed hit | Single guaranteed hit, where value represents the current price. | |
addHeart | Price for adding a heart | Single heart addition, where value represents the current price. | |
item_event_use_hit | Use once in item mode to hit | ||
item_event_use_add_heart | Use once in item mode to add a heart |
- Monopoly, Game ID=1704460412809043970
Event | Value | Cmd Additional Data (Payload) | Description |
---|---|---|---|
chess_skins_1 |
Price to use the skin | {"rounds":5,"quality":4} //Default duration is 5 rounds; default character quality for payment is 4 |
Enables Skin #1 for chess pieces, granting a 10% rent bonus. Fails if user is bankrupt. |
chess_skins_2 |
Price to use the skin | {"rounds":5,"quality":4} //Default duration is 5 rounds; default character quality for payment is 4 |
Applies Skin #2 to chess pieces, reducing rent by 10%. Fails if user is bankrupt. |
chess_skins_3 |
Price to use the skin | {"rounds":2,"quality":4} //Default duration is 2 rounds; default character quality for payment is 4 |
Activates Skin #3 for chess pieces, allowing land seizure. Fails if user is bankrupt. |
paid_events_1 |
Price to initiate | {"rounds":5,"quality":2} //Default duration is 5 rounds; default card quality for payment is 2 |
Seizes all properties of a targeted player, suspending rent collection. Fails if user is bankrupt. |
paid_events_2 |
Price to initiate | {"rounds":5,"quality":2} //Default duration is 5 rounds; default card quality for payment is 2 |
Increases rent by 50% on all properties of a targeted player. Fails if user is bankrupt. |
paid_events_3 |
Price to initiate | {"rounds":5,"quality":2} //Default duration is 5 rounds; default card quality for payment is 2 |
Reduces rent by 50% on all properties of a targeted player. Fails if user is bankrupt. |
paid_events_4 |
Price to initiate | {"rounds":3,"quality":3} //Default duration is 3 rounds; default card quality for payment is 3 |
Doubles rent on all properties. |
paid_events_5 |
Price to initiate | {"rounds":3,"quality":3} //Default duration is 3 rounds; default card quality for payment is 3 |
Suspends rent collection on all properties. |
paid_events_6 |
Price to initiate | {"quality":1} //Default card quality for payment is 1 |
Imprisons a designated player. Fails if user is bankrupt/already imprisoned/player is in action. |
paid_events_7 |
Price to initiate | {"quality":1} //Default card quality for payment is 1 |
Releases a designated player from prison. Fails if user is bankrupt/already released. |
paid_events_8 |
Price to initiate | {"rounds":1,"quality":1} //Default stay rounds is 1; default card quality for payment is 1 |
Keeps a designated player on the current tile for x rounds. Fails if user is bankrupt. |
paid_events_9 |
Price to initiate | {"quality":2} //Default card quality for payment is 2 |
Destroys a building on a random property of the designated player. Fails if user is bankrupt. |
paid_events_10 |
Price to initiate | {"quality":1} //Default card quality for payment is 1 |
Randomly upgrades a building by 1 level on an upgradeable land of the designated player. Fails if user is bankrupt. |
paid_events_11 |
Price to initiate | {"quality":3} //Default card quality for payment is 3 |
Doubles cash for everyone. Fails if everyone has no cash. |
paid_events_12 |
Price to initiate | {"quality":3} //Default card quality for payment is 3 |
Cuts cash in half for everyone. Fails if everyone has no cash. |
paid_events_13 |
Price to initiate | {"quality":3} //Default card quality for payment is 3 |
Equally divides cash among everyone. Fails if everyone has no cash. |
paid_events_14 |
Price to initiate | {"quality":1} //Default card quality for payment is 1 |
Grants 1M cash to a designated player. Fails if user is bankrupt. |
paid_events_15 |
Price to initiate | {"quality":1} //Default card quality for payment is 1 |
Makes a designated player pay out 1M cash. Fails if user is bankrupt. |
paid_events_16 |
Price to initiate | {"quality":1} //Default card quality for payment is 1 |
Spawns a small cash pile (10K) on a random tile, stackable. Walking onto the tile claims it. |
paid_events_17 |
Price to initiate | {"quality":1} //Default card quality for payment is 1 |
Places a small fine (10K) on a random tile, stackable. Landing on the tile incurs the fine. |
paid_events_18 |
Price to initiate | {"quality":3} //Default card quality for payment is 3 |
Grants a rent exemption card to a designated player, usable once to skip rent, stackable and carries over. Fails if user is bankrupt/not in rent-paying phase/not their turn. |
paid_events_19 |
Price to initiate | {"quality":2} //Default card quality for payment is 2 |
Grants a reroll card to a designated player, usable once to reroll dice, stackable and carries over. Fails if user is bankrupt/not in dice-rolling phase/not their turn. |
paid_events_20 |
Price to initiate | {"point":12,"quality":3} //Specific roll point is random by default; default card quality for payment is 3 |
Gives a remote dice control card to a designated player, allowing them to set dice once, stackable and carries over. Fails if user is bankrupt/not in dice-rolling phase/not their turn. |
- Snake and Ladders, Game ID=1716668321022017537
Event | Value | CMD Additional Data (Payload) | Description |
---|---|---|---|
reroll | Price for rerolling | Single reroll, where value represents the current price. | |
shield | Price for shield | Single shield, where value represents the current price. |
- Match Pairs, Game ID=1734504890293981185
Event | Value | CMD Additional Data (Payload) | Description |
---|---|---|---|
refresh | Price for initiating this event | Gives the user 1 refresh item. | |
prompt | Price for initiating this event | Gives the user 1 hint item. | |
cloud | Price for initiating this event | Gives the user 1 cloud item. | |
lock | Price for initiating this event | Gives the user 1 lock item. | |
use_cloud | Price for initiating this event | Releases the effect of 1 cloud for the user. | |
use_wind | Price for initiating this event | Releases the effect of 1 wind for the user, counteracting 1 cloud effect. | |
use_lock | Price for initiating this event | Releases the effect of 1 lock for the user. | |
use_unlock | Price for initiating this event | Releases the effect of 1 unlock for the user, counteracting 1 lock effect. | |
use_rocket | Price for initiating this event | Releases the effect of 1 rocket for the user. |
- Baloot, Game ID=1759471374694019074
Event | Value | CMD Additional Data (Payload) | Description |
---|---|---|---|
buy_props | Money spent | Example: {"index":0} Index explanation: 0 for flowers, 1 for buckets | Value indicates the consumption. |
- Big Eater / Game ID: 1641330097642704898
Event | value | cmd Additional Data (payload) | Description |
---|---|---|---|
add_score | Betting amount | Example: {"betChip":500} | Enter score |
- Block Master, Game ID = 1800792634548629505
Event | value | cmd Additional data (payload) | Description |
---|---|---|---|
clear_line | price | Subtract lines | |
add_line | price | Add lines | |
decelerate | price | Decelerate | |
accelerate | price | Accelerate |
Request Example
{
"out_order_id": "1659497694000",
"out_group_id": "1659497694",
"mg_id": "1461228379255603251",
"room_id": "9009",
"cmd": "add_score",
"from_uid": "001",
"to_uid": "002",
"value": 100
}
Return Parameters
- BaseResp
Parameter | Required | Type | Description |
---|---|---|---|
ret_code | Yes | int | Response code |
ret_msg | Yes | string | Response information |
data | Yes | AppServerCreateOrderResp | Response data |
- AppServerCreateOrderResp
Parameter | Required | Type | Description |
---|---|---|---|
out_order_id | Yes | string | Merchant order ID |
order_id | Yes | string | SUD order ID |
Return Example
{
"ret_code": 0,
"ret_msg": "",
"data": {
"out_order_id": "1659497694000",
"order_id": "order_id_1"
}
}
Business Error Code
Error Code | Error Description | Solution |
---|---|---|
10002 | Parameter error | Check the request parameters, modify them and send the request again |
70501 | Order ID already exists | Modify the merchant-defined order ID to ensure uniqueness and send the request again |