#

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_combo":false}. is_add description: whether to increase the distance, 0 means not to increase, 1 means to increase. is_combo description: whether it is a combo, false means no combo, true means combo | Hit N baseballs at a time or combo baseball (hit one baseball each time), value indicates the number of purchased baseballs |
| item_event_buy_baseball | Number of purchased baseballs | Example: {"is_add":0,"is_combo":false}. is_add description: whether to increase the distance, 0 means not to increase, 1 means to increase. is_combo description: whether it is a combo, false means no combo, true means combo | Hit N baseballs at a time or combo baseball (hit one baseball each time) in item mode, value indicates the number of purchased baseballs |
- Who is spy, Game ID=1599672757949743105
| cmd | 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
| cmd | value | cmd Additional Data (payload) | Description |
|---|---|---|---|
| reroll_the_dice | Specific price | Current step number, example: {"seq":1} | Reroll dice, value indicates current price |
| specify_dice_roll | Specific price | {"point":6, "seq": 1} | Specify the number of dice points,random by default;Designated player receives 1 remote control dice card, which can specify the number of dice points once and can be carried in |
| item_event_reroll_the_dice | Current step number, example: {"seq":1} | Reroll dice | |
| item_event_specify_dice_roll | {"point":6, "seq": 1} | Specify the number of dice points,random by default;Designated player receives 1 remote control dice card, which can specify the number of dice points once and can be carried in |
- UMO, Game ID=1472142559912517633
| cmd | value | cmd Additional Data (payload) | Description |
|---|---|---|---|
| auto_umo | Automatically shout UMO, can be purchased anytime in the game | ||
| item_event_auto_umo | Use once in item mode to shout umo automatically |
- Deminers, Game ID=1472142640866779138
| cmd | 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 | |
| gift_cover_clouds | Example:{"count":1,"count_limit":20,"show_time":50} count:clouds count,default to 1 count_limit: limit of clouds,default to 20 show_time: clouds show time,default to 20 seconds |
Clouds | |
| gift_cover_big_chain | Example:{"show_time": 10} show_time:show time,default to 10 seconds |
Big chain | |
| gift_windy | Example:{"count":1} count: The number of clouds blown away, default to 1 |
Windy | |
| gift_discover_big_chain | Unlock the chain | ||
| gift_exchange_hands | Hand Swap | ||
| gift_add_card | Draw one card | ||
| gift_del_card | Discard one card | ||
| gift_give_remove_card | Give dismantle card | ||
| gift_give_throw_card | Give throwing mine cards | ||
| gift_next_bomb | Replace mines | ||
| gift_free_change_hand | Free change hands |
- Crazy Racing, Game ID=1649319572314173442
| cmd | 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
| cmd | value | cmd Additional Data (payload) | Description |
|---|---|---|---|
| add_score | Betting amount | Example: {"betChip":500} | Enter score |
- gobang Professional Edition, Game ID = 1676069429630722049
| cmd | value | cmd Additional Data (payload) | Description |
|---|---|---|---|
| retract | Retract Price | Retracts a single move. "Value" represents the current price. |
- Jump Jump, Game ID=1680881367829176322
| cmd | Value | CMD Additional Data (Payload) | Description |
|---|---|---|---|
| hit | Price for guaranteed hit | Example:{“round”:20} | 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 | Example:{“round”:20} | 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
| cmd | 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
| cmd | 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
| cmd | 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
| cmd | 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
| cmd | value | cmd Additional Data (payload) | Description |
|---|---|---|---|
| add_score | Betting amount | Example: {"betChip":500} | Enter score |
- Block Master, Game ID = 1800792634548629505
| cmd | value | cmd Additional data (payload) | Description |
|---|---|---|---|
| clear_line | price | Subtract lines | |
| add_line | price | Add lines | |
| decelerate | price | Decelerate | |
| accelerate | price | Accelerate | |
| gift_refresh_block | Refresh Blocks - Target refreshes next three blocks | ||
| gift_accelerate | Example:{"count":1} count:Gift quantity, duration increases by 4*count turns |
Accelerate - Target's next 4 blocks fall at 100% increased speed, lasting 4 falling blocks | |
| gift_decelerate | Example:{"count":1} count:Gift quantity, duration increases by 4*count turns |
Decelerate - Target's next 4 blocks fall at 100% decreased speed, lasting 4 falling blocks | |
| gift_normal_speed | Example:{"count":1} count:Gift quantity, duration increases by 4*count turns |
Normal Speed - Target's next 4 blocks unaffected by acceleration or deceleration, lasting 4 falling blocks | |
| gift_clear_line | Clear 1 Line - Target clears bottom 1 line | ||
| gift_generate_block_i | Example:{"count":1} count:Gift quantity, insert count large vertical bars |
Force I-Block - Target's next block is a large vertical bar (does not affect the originally queued block) | |
| gift_swap_button | Example:{"count":1} count:Gift quantity, duration increases by 4*count turns |
Swap Buttons - Target's left and right controls are swapped, lasting 4 falling blocks | |
| gift_clear_line_5 | Clear 5 Lines - Target clears bottom 5 lines |
- Chinese Chess,Game ID = 1899434556918988802
| cmd | value | cmd Additional Data (payload) | Description |
|---|---|---|---|
| cnchess_undo | price | Retracts a single move. |
- Fingertip Elimination, Game ID=1922225251677753346
| cmd | value | cmd Additional Data (payload) | Description |
|---|---|---|---|
| BLOCK_REFRESH | Price | Price of Refresh Item (Refreshes unused blocks) | |
| HAMMER | Price | Example: {"posX":3,"posY":6,"itemIndex":6} // Grid coordinates for using the hammer | Hammer Price |
| ROW_ELIMINATE | Price | Example: {"posX":3,"posY":6,"itemIndex":12} | Price of Row Elimination (Arrow) |
| BLOCK_ELIMINATE | Price | Example: {"posX":3,"posY":6,"itemIndex":14} | 9-Grid Elimination (Bomb) Price |
| COLUMN_ELIMINATE | Price | Example: {"posX":3,"posY":6,"itemIndex":13} | Column Elimination (Drill) Item Price |
- Bubble Shooter, Game ID=1819318615915831298
| cmd | value | cmd Additional Data (payload) | Description |
|---|---|---|---|
| shield | Price | shield | |
| star | Price | star bubble | |
| lightning | Price | lightning bubble | |
| colorful | Price | colorful bubble |
24.EightBall, Game ID=1739914495960793090
| cmd | value | cmd Additional Data (payload) | Description |
|---|---|---|---|
| gift_increase_friction | Example:"payload":{"count":5} | Lush Green Grass - Increase Friction | |
| gift_decrease_friction | Example:"payload":{"count":5} | Frozen Field - Decrease Friction | |
| gift_fake_black_8 | Example:"payload":{"count":5} | Disguise - Disguise a ball as the black 8-ball | |
| block_hole | Example:"payload":{"count":5} | Block the Hole - Block one pocket for one turn | |
| gift_increase_aimline | Example:"payload":{"count":5} | Far-Sighted - Extend the aiming line | |
| gift_decrease_aimline | Example:"payload":{"count":5} | Short-Sighted - Shorten the aiming line | |
| gift_enhance_cue_ball | Example:"payload":{"count":5} | Blazing Shield - Restore friction for one turn | |
| gift_wind_force | Example:"payload":{"count":5} | Harness the Wind - Apply wind field for one turn |
25.Monster Crush Boom Game ID=1689904909564116994
| cmd | value | cmd Additional Data (payload) | Description |
|---|---|---|---|
| gift_restore_health | Example:{"restore_health": 5} restore_health:Restore health points, default is 5 points |
Restore Health | |
| gift_increase_atk | Example:{"increase_atk": 1, "atk_bonus_duration": 1} increase_atk:Increase attack power, default is 1 point atk_bonus_duration:Duration in turns, default is 1 |
Increase Attack | |
| gift_increase_shield | Example:{"increase_shield": 1, "shield_duration": 1} increase_shield:Increase shield damage reduction, default is 1 point shield_duration:Duration in turns, default is 1 |
Increase Shield | |
| gift_extra_turn | Example:{"extra_turn": 1, "count_limit": 1} extra_turn:Number of extra turns, default is 1 count_limit:Storage limit for extra turns, default is 1 |
Extra Turn | |
| gift_respawn | Example:{"count": 1, "count_limit": 1} count:Quantity, default is 1 count_limit:Limit, default is 1 |
Respawn | |
| gift_battle_rainbows | Example:{"count": 1} count:Quantity, default is 1 |
Battle Rainbow |
26.LuckyMiner, Game ID=1947922061064572929
| cmd | value | cmd Additional Data (payload) | Description |
|---|---|---|---|
| gift_cheer_up | Example:{"count":1} count:Gift quantity, stacking increases bubble time and size |
Cheer Up - Creates a bubble avatar around the player (starting at 0.8x) lasting 3 seconds The player avatar becomes the center, attracting other bubble avatars, no gravity Stacking effects: 1.Bubble size: 10 becomes 0.9x, 100 becomes 1x, 1000 becomes 1.2x 2.Time extension |
|
| gift_nightmare | Nightmare - Visible area shrinks Gift sender avatar (demon frame) appears in the darkness, lasting 30 seconds Stacking effects: 1.Viewport continuously shrinks (has a minimum value) 2.Time extension |
||
| gift_exorcism_hook | Exorcism Hook - Hook ignores obstacles (passes through directly) Sender avatar (angel frame) on the hook, lasting 30 seconds Stacking effects: Time extension |
||
| gift_wild_swing | Wild Swing - Hook swing speed x5 Sender avatar (demon frame) on the hook, lasting 30 seconds Stacking effects: Time extension |
||
| gift_avert_danger | Avert Danger - All obstacles become ordinary treasure chests Sender avatar (angel frame) on ordinary treasure chests Stacking effects: Cannot stack |
||
| gift_riddler | Riddler - All items on the field become random items Sender avatar (demon frame) on random items Stacking effects: Cannot stack |
||
| gift_good_luck | Good Luck - All items on the field become premium treasure chests Sender avatar (angel frame) on premium treasure chests Stacking effects: Cannot stack |
||
| gift_annihilator | Annihilator - All items on the field become obstacles Sender avatar (demon frame) on obstacles Stacking effects: Cannot stack |
27.Monster Crush, Game ID=1664525565526667266
| cmd | value | cmd Additional Data (payload) | Description |
|---|---|---|---|
| gift_cover_clouds | Example:{"count":1} count:int32 Quantity count_limit: int32 Quantity limit show_time: int32 Display time |
Cover Clouds | |
| gift_cover_big_chain | Example:{"count":1} count:int32 Quantity show_time: int32 Display time |
Big Chain | |
| gift_windy | Example:{"count":1} count:int32 Number of clouds to blow away |
Windy | |
| gift_discover_big_chain | Unlock | ||
| gift_exchange_boards | Exchange Boards | ||
| gift_add_chains | Example:{"count":1} count:int32 Quantity count_limit: int32 Quantity limit |
Add Chains | |
| gift_add_ice_blocks | Example:{"count":1} count:int32 Quantity count_limit: int32 Quantity limit |
Add Ice Blocks | |
| gift_eliminate_chains | Example:{"count":1} count:int32 Quantity |
Remove Chains | |
| gift_eliminate_ice_blocks | Example:{"count":1} count:int32 Quantity |
Remove Ice Blocks | |
| gift_clear_all_chains | Clear All Chains | ||
| gift_clear_all_ice_blocks | Clear All Ice Blocks | ||
| gift_annoying_monster | Example:{"count":1} count:int32 Quantity count_limit: int32 Quantity limit |
Annoying Monster | |
| gift_send_rockets | Example:{"count":1} count:int32 Quantity count_limit: int32 Quantity limit |
Send Rockets | |
| gift_send_bombs | Example:{"count":1} count:int32 Quantity count_limit: int32 Quantity limit |
Send Bombs | |
| gift_send_rainbows | Example:{"count":1} count:int32 Quantity count_limit: int32 Quantity limit |
Send Rainbows |
28.Watermelon Merge, Game ID=1892865924243181570
| cmd | value | cmd Additional Data (payload) | Description |
|---|---|---|---|
| item_event_shake | Shake - Shakes the box | ||
| item_event_hammer | Example: {"fruitId":"1"} fruitId: Required for hammer prop: Target fruit ID. When a user clicks a fruit in the client, a request is initiated, and the server fills in this ID from the request |
Hammer - Clears a specified fruit Usage flow: Click the prop to enter the activated state - In the activated state, clicking a fruit triggers the prop, and the clicked fruit is eliminated - In the activated state, clicking the hammer cancels the activated state - In the activated state, clicking other areas keeps it in the activated state |
29.Run From Ghost, Game ID=2033469914201100290
| cmd | value | cmd Additional Data (payload) | Description |
|---|---|---|---|
| low_magic | Example: {"resourceId":319422657} resourceId: Coordinate encoding of the resource |
Low-level supply box | |
| mid_magic | Example: {"resourceId":319488225} resourceId: Coordinate encoding of the resource |
Mid-level supply box | |
| high_magic | Example: {"resourceId":319553793} resourceId: Coordinate encoding of the resource |
High-level supply box | |
| fishing_net | Example: {"resourceId":437138625} resourceId: Coordinate encoding of the resource |
Catcher | |
| spirit_currency | Example: {"spiritCurrencyCount":10000} spiritCurrencyCount: Number of ghost coins to buy |
Buy ghost coins | |
| spirit_skin | Example: {"skinConfigId":7} skinConfigId: Skin ID [3. A Yue (Basketball Boy) 4. Lin Xiaozhai (Otaku Girl) 5. Cole (Beak Doctor) 6. Evelyn (Nun) 7. Shen Yanqing (Groom) 8. Su Wanting (Bride) 9. Lu Mingzhe (Groom 2) 10. Bai Ruoxi (Bride 2)] |
Buy ghost skin |
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 |