Query OTC Withdrawal Order List

Query OTC withdrawal orders in batch.

post/withdraw/open/otc/api/order/list

Headers

X-GatePay-Certificate-ClientIdstring required

Merchant application client ID used to identify the calling app.

X-GatePay-Signaturestring required

HMAC signature generated from the request according to GatePay signing rules.

X-GatePay-Timestampstring required

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

X-GatePay-Noncestring required

Random nonce used together with the timestamp to prevent replay attacks.

Request body

statusstring

Filter by order status. Available values: PROCESSING (in processing), DISPATCHED (payout dispatched), DONE (completed), FAIL (failed).

typestring

Filter by OTC order type.

cryptoCurrencystring

Filter by cryptocurrency code.

fiatCurrencystring

Filter by fiat currency code.

startTimestring

Start of the query time range.

endTimestring

End of the query time range.

pageinteger

Page number.

pageSizeinteger

Number of records per page.

clientOrderIdstring

Filter by merchant-defined order ID.

Response

Success

codestring

Business response code.

statusstring

Top-level request status.

errorMessagestring

Error message when the request fails.

Changes

No recorded changes to this endpoint across all 3 revisions of this API.