GAgate

Query OTC Withdrawal Order List

Changed on

Query OTC withdrawal orders in batch.

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

Request

  • Base URL
    https://openplatform.gateapi.io
  • URL
    https://openplatform.gateapi.io/withdraw/open/otc/api/order/list
  • Auth
    none declared. Required headers: X-GatePay-Certificate-ClientId, X-GatePay-Signature, X-GatePay-Timestamp, X-GatePay-Nonce

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), REFUND (refunded after successful off-ramp).

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

  • 873496ac0fbfRevision changes
    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

  • e229d41eecc7Revision changes
    • info

      added the optional property /// to the response with the status