Description
- Query user settlement information
Request URL
Request Method
- Transmission protocol: HTTPS
- Request method: POST
- Parameters are passed in the body in JSON format (see request example)
- The following header needs to be added: Content-Type: application/json;charset=utf-8
- The following header needs to be added: Authorization authentication header
Request Parameters
| Parameter Name |
Required |
Type |
Description |
| out_order_id |
Special Optional |
string |
Merchant-defined unique order ID, cannot be empty at the same time as the SUD order number.
If both out_order_id and order_id exist, order_id has higher priority than out_order_id |
| order_id |
Special Optional |
string |
SUD order number, cannot be empty at the same time as the merchant-defined order number |
Request Example
{
"out_order_id": "1659497694000",
"order_id": "1659497694003"
}
Response Parameters
| Parameter Name |
Required |
Type |
Description |
| ret_code |
Yes |
int |
Response code |
| ret_msg |
Yes |
string |
Response message |
| data |
Yes |
AppServerUserSettleResp |
Response data |
| Parameter Name |
Required |
Type |
Description |
| order_id |
Yes |
string |
SUD order number |
| out_order_id |
Yes |
string |
Merchant-defined unique order number |
| mg_id |
Yes |
string |
Game ID |
| room_id |
Yes |
string |
Room ID |
| match_id |
Yes |
string |
Game session ID |
| uid |
Yes |
string |
Player UID, empty character for robot |
| is_ai |
Yes |
int32 |
0: ordinary user, 1: robot |
| score |
Yes |
int32 |
The points the player settled for this time |
| remain_score |
Yes |
int32 |
The remaining points of the player's settlement this time |
| commission_score |
No |
int32 |
Commission deduction points |
| settle_at |
Yes |
string |
Settlement timestamp (seconds) |
Response Example
{
"ret_code": 0,
"ret_msg": "",
"data": {
"order_id": "1575032972267098112",
"out_order_id": "1664184984",
"mg_id": "1557194155570024449",
"room_id": "90091",
"match_id": "ce56b6lzi1a7-cf75pcvbs7j1-cx5h93twefnc",
"uid": "5cb0d3a5",
"is_ai": 0,
"score": -100,
"remain_score": 0,
"commission_score": 0,
"settle_at": "1664334968522"
}
}
Business Error Codes
| Error Code |
Error Description |
Solution |
| 10002 |
Parameter error |
Check the request parameters and make the necessary modifications before resubmitting the request |
| 70503 |
Order does not exist |
Check if the order number entered is correct and resubmit the request |
| 70504 |
No user settlement information is associated with the order |
Check the order number entered or wait for the corresponding user settlement before resubmitting the request |