Skip to main content

Query Withdraw Order

Query withdrawal order details.

Request Information

  • Request URL: /gateway/api/v2/payouts
  • Request Method: GET
  • Content-Type: application/x-www-form-urlencoded; charset=utf-8

Request Headers

ParameterTypeDescription
AuthorizationString{authorization} Authorization ID assigned to the platform by the system

Request Parameters

ParameterRequiredTypeDescription
offsetNoInteger(10)Query offset, default 0
limitNoInteger(10)Number of orders to return, default 25, max 500
payout_idNoString(10)System order ID
payout_cl_idNoString(32)Merchant order ID
create_time__gteNoInteger(10)Creation time start (Unix timestamp in seconds)
create_time__lteNoInteger(10)Creation time end (Unix timestamp in seconds)

Response Example

Success Response

{
"error_code": "0000",
"data": [
{
"amount": 30000,
"real_amount": 0,
"fee": 0,
"payout_id": "POT00000145",
"payout_cl_id": "xinxin_1596380261_10",
"platform_id": "PF0060",
"platform_channel_id": "PFC00000142",
"status": 3,
"memo": "",
"create_time": 1596425140,
"update_time": 1596425770,
"sign": "459408960e8e7173f6eae20c2bb8339f"
},
{
"amount": 30000,
"real_amount": 0,
"fee": 0,
"payout_id": "POT00000144",
"payout_cl_id": "xinxin_1596380261_11",
"platform_id": "PF0060",
"platform_channel_id": "PFC00000142",
"status": 3,
"memo": "",
"create_time": 1596424960,
"update_time": 1596425590,
"sign": "151ed70de39dc222f3444bc84947975a"
}
],
"total": 2
}

Error Response Example

{
"error_code": "0006",
"error_msg": "Invalid Authorization!"
}

Response Parameter Description

ParameterTypeDescription
error_codeStringError code
error_msgStringError message (returned when error_code is not "0000")
statusIntegerOrder status (refer to Order Status List)
signStringOrder signature, refer to Signature Specification

Remarks

  • All query conditions are concatenated as QueryString in key=value format joined by &
  • authorization is the authorization ID assigned to the platform by the system. If not obtained, please contact system personnel.
  • Each returned order has a signature (sign), all fields participate in the signature
  • Orders are sorted by creation time in descending order (newest first)
  • Creation time start and end must both be provided to take effect, use Unix timestamp