Skip to main content
GET
/
open
/
otc
/
api
/
recharge
/
list
Query OTC Recharge Order List
curl --request GET \
  --url https://openplatform.gateapi.io/open/otc/api/recharge/list \
  --header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>' \
  --header 'X-GatePay-MerchantId: <x-gatepay-merchantid>' \
  --header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
  --header 'X-GatePay-Signature: <x-gatepay-signature>' \
  --header 'X-GatePay-Timestamp: <x-gatepay-timestamp>'
{
  "code": "<string>",
  "status": "<string>",
  "errorMessage": "<string>",
  "data": {
    "total": 123,
    "page": 123,
    "list": [
      {
        "orderId": "<string>",
        "otcOrderId": "<string>",
        "currency": "<string>",
        "amount": "<string>",
        "fiatCurrency": "<string>",
        "fiatAmount": "<string>",
        "cfRate": "<string>",
        "bankId": "<string>",
        "bankNumber": "<string>",
        "paid": true,
        "status": "<string>",
        "card_info": {
          "id": 123,
          "uid": 123,
          "entity": "<string>",
          "bank_account_name": "<string>",
          "bank_name": "<string>",
          "bank_country": "<string>",
          "bank_address": "<string>",
          "bank_code": "<string>",
          "branch_code": "<string>",
          "iban": "<string>",
          "swift": "<string>",
          "remittance_line_number": "<string>",
          "agent_bank_name": "<string>",
          "agent_bank_swift": "<string>",
          "transferRemark": "<string>",
          "memo": "<string>",
          "is_default": true,
          "bank_id": "<string>"
        },
        "createTime": 123,
        "promoCode": "<string>",
        "transferRemark": "<string>",
        "paymentReceiptFileUrl": "<string>"
      }
    ]
  }
}

​
Overview

This page documents the GET /open/otc/api/recharge/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-MerchantId
integer<int64>
required

Merchant ID.

Query Parameters

​
status
enum<string>

Filter by order status.

Available options:
PENDING,
PROCESSING,
DONE,
CANCEL,
ERROR
​
startTime
integer<int64>
required

Start of the query time range (epoch millis). Required.

​
endTime
integer<int64>
required

End of the query time range (epoch millis). Required.

​
page
integer<int64>

Page number. Use -1 to fetch all records without pagination.

​
count
integer<int64>

Number of records per page. Required when page >= 0. Max 1000.

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