Skip to main content
POST
/
withdraw
/
open
/
institution
/
otc
/
api
/
order
/
list
Query OTC Withdrawal Order List
curl --request POST \
  --url https://openplatform.gateapi.io/withdraw/open/institution/otc/api/order/list \
  --header 'Content-Type: application/json' \
  --header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>' \
  --header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
  --header 'X-GatePay-On-Behalf-Of: <x-gatepay-on-behalf-of>' \
  --header 'X-GatePay-Signature: <x-gatepay-signature>' \
  --header 'X-GatePay-Timestamp: <x-gatepay-timestamp>' \
  --data '
{
  "status": "<string>",
  "type": "<string>",
  "cryptoCurrency": "<string>",
  "fiatCurrency": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "page": 123,
  "pageSize": 123,
  "clientOrderId": "<string>"
}
'
{
  "code": "<string>",
  "status": "<string>",
  "errorMessage": "<string>",
  "data": {
    "page": 123,
    "pageSize": 123,
    "total": 123,
    "data": [
      {
        "orderId": "<string>",
        "status": "<string>",
        "cryptoCurrency": "<string>",
        "fiatCurrency": "<string>",
        "cryptoAmount": "<string>",
        "fiatAmount": "<string>",
        "fiatRate": "<string>",
        "bankAccountId": "<string>",
        "clientOrderId": "<string>",
        "type": "<string>",
        "createTime": 123,
        "updateTime": 123,
        "errMsg": "<string>",
        "tradeFee": "<string>",
        "finalFiatAmount": "<string>",
        "bankSlipInfo": "<string>",
        "promCode": "<string>"
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.gate.com/llms.txt

Use this file to discover all available pages before exploring further.

Overview

This page documents the POST /withdraw/open/institution/otc/api/order/list endpoint. The full schema, parameters, and examples are rendered from the linked OpenAPI definition above.

Notes

Headers

X-GatePay-Certificate-ClientId
string
required

Merchant application client ID used to identify the calling app.

X-GatePay-Signature
string
required

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

X-GatePay-Timestamp
string
required

Unix timestamp used for replay protection and signature verification.

X-GatePay-Nonce
string
required

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

X-GatePay-On-Behalf-Of
string
required

Required delegated-subject header. Provide the initiating account ID for this request. For institution merchant APIs, this is typically the target sub-account ID; for institution charge and transfer APIs, it can be either an institution account ID or a sub-account ID.

Body

application/json
status
string

Filter by order status.

type
string

Filter by OTC order type.

cryptoCurrency
string

Filter by cryptocurrency code.

fiatCurrency
string

Filter by fiat currency code.

startTime
string

Start of the query time range.

endTime
string

End of the query time range.

page
integer

Page number.

pageSize
integer

Number of records per page.

clientOrderId
string

Filter by merchant-defined order ID.

Response

200 - application/json

Success

code
string

Business response code.

status
string

Top-level request status.

errorMessage
string

Error message when the request fails.

data
object

Paged order list payload.