#

Description
- Query Order
Request URL
- Test environment: see query_order field in Obtain Server End API Configurations
- Production environment: see query_order field in Obtain Server End API Configurations
Request Method
- Transport protocol: HTTPS
- Request method: POST
- Parameters are passed in the body in JSON format (see request example).
- The header needs to add: Content-Type: application/json; charset=utf-8
- The header needs to add: Authentication header Authorization
Request Header [Authorization]
Request Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| out_order_id | Special Optional | string | Merchant's unique custom order ID, cannot be empty at the same time as order_id. When out_order_id and order_id exist at the same time, order_id has a higher priority than out_order_id. |
| order_id | Special Optional | string | SUD order number, cannot be empty at the same time as out_order_id. |
Request Example
{
"out_order_id": "1659497694000",
"order_id": "1659497694003"
}
Response Parameters
- BaseResp
| Parameter | Required | Type | Description |
|---|---|---|---|
| ret_code | Yes | int | Response code |
| ret_msg | Yes | string | Response message |
| data | Yes | AppServerQueryOrderResp | Response data |
- AppServerQueryOrderResp
| Parameter | Required | Type | Description |
|---|---|---|---|
| order_id | Yes | string | SUD Order Number |
| out_order_id | Yes | string | Merchant's unique custom order number |
| out_group_id | No | string | Merchant's custom order group ID |
| mg_id | Yes | string | Game ID |
| room_id | Yes | string | Room ID |
| cmd | Yes | string | Action triggered |
| from_uid | Yes | string | Paying user UID |
| to_uid | Yes | string | Target user UID |
| value | Yes | int32 | Gaming value |
| payload | Special Optional | object | Additional data |
| status | Yes | string | Order status: CREATED (order created, pending execution), EXECUTING (executing), EXECUTE_FAIL (execution failed), EXECUTE_SUCCESS (execution successful) |
Response Example
{
"ret_code": 0,
"ret_msg": "",
"data": {
"order_id": "1573254561852952576",
"out_order_id": "1659497694001",
"out_group_id": "165949769",
"mg_id": "1461228379255603251",
"room_id": "9009",
"cmd": "test",
"value": 1,
"status": "EXECUTE_FAIL"
}
}
Business Error Code
| Error Code | Error Description | Solution |
|---|---|---|
| 10002 | Parameter error | Check the request parameters, modify and resend the request |
| 70503 | Order does not exist | Check whether the order number passed in is correct, modify and resend the request |