Sign in
withdraw

Query withdrawal order status

Query the status and details of a batch withdrawal order and its sub-orders by batch ID and detail status.

post/v1/pay/withdraw/query

Headers

X-GatePay-Certificate-ClientIdstring required
Example:4186d0c6-6a35-55a9-8dc6-5312769dbff8

The clientId assigned when the merchant registers an application in the Gate merchant console.

X-GatePay-Signaturestring required

Request signature. GatePay uses this signature to verify whether the request is valid.

X-GatePay-Timestampstring required
Example:1672905655498

Millisecond timestamp; the difference from server time must not exceed 30 seconds.

X-GatePay-Noncestring required
Example:9578

Random string. Must comply with HTTP header rules; recommended length is within 32 characters, composed of digits and letters.

Request body

batch_idstring required

Unique batch ID generated by the merchant at /v1/pay/withdraw.

detail_statusstring required

Query status of sub-orders <br> ALL: all sub-orders <br>INIT ：new added sub-orders <br>PENDING: pending sub-orders <br>PROCESSING: submitted withdrawal request, pending confirmation <br>CHECK: in review <br>FAIL: failed sub-orders <br>DONE: successful sub-orders.

Response

Withdrawal batch details

statusstring required

Main order status: INIT (newly created order), PROCESSING (newly created payout order is in processing), PARTIAL (partially successful), FAIL (fully failed), SUCCESS (fully successful)

codestring required

Error code

errorMessagestring

Error message

Changes

Changed in 2 of the 5 revisions of this API.11

  • 566e48c200531See the full diff
    • ○

      added the optional property data/withdraw_list/items/fee_type to the response with the 200 status

      response-optional-property-added

  • 4feb16b0979e1See the full diff
    • ●

      removed the optional property data/withdraw_list/items/fee_type from the response with the 200 status

      response-optional-property-removed