Skip to main content
GET
/
payment
/
open
/
institution
/
v1
/
pay
/
address
/
query
Query Order
curl --request GET \
  --url https://openplatform.gateapi.io/payment/open/institution/v1/pay/address/query \
  --header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>' \
  --header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
  --header 'X-GatePay-Signature: <x-gatepay-signature>' \
  --header 'X-GatePay-Timestamp: <x-gatepay-timestamp>'
{
  "status": "SUCCESS",
  "code": "000000",
  "errorMessage": "",
  "data": {
    "prepayId": "1661239048576446",
    "merchantId": 10002,
    "merchantTradeNo": "43959345943769874395",
    "transactionId": "347827943294834379",
    "goodsName": "abc",
    "fromAddress": "",
    "currency": "BTC",
    "orderAmount": "9.88",
    "payCurrency": "USDT",
    "payAmount": "197600",
    "surchargeAmount": "",
    "fiatCurrency": "",
    "fiatAmount": "",
    "fiatRate": "",
    "rate": "20000",
    "status": "PENDING",
    "createTime": 1663657128148,
    "expireTime": 1664089128000,
    "transactTime": 1663829928000,
    "order_name": "orderName",
    "totalFeeAmount": "0",
    "totalSettleAmount": "",
    "payDetails": [],
    "transaction_info": {
      "done_amount": "10.11",
      "done_amount_total": "10.11",
      "confirming_list": [
        {
          "amount": "0.35",
          "confirm": 3
        },
        {
          "amount": "0.65",
          "confirm": 4
        }
      ],
      "done_tx_item_list": [
        {
          "chain": "BSC",
          "address": "0x5E86088F084dD253fBd6d5ad955af6f53EFC8073",
          "fullCurrType": "USDT_BSC",
          "amount": "10.11",
          "txId": "D1758212402891",
          "utcCreateTime": "2025-09-18 08:20:03",
          "utcUpdateTime": "2025-09-18 08:20:03",
          "fromAddress": "LHDwcMPVPXXvrmSlRVeEcxsLUCvtThHLa"
        }
      ],
      "confirming_tx_item_list": [
        {
          "chain": "BSC",
          "address": "0x5E86088F084dD253fBd6d5ad955af6f53EFC8022",
          "fullCurrType": "USDT_BSC",
          "amount": "10.11",
          "txId": "D1758212402811",
          "utcCreateTime": "2025-09-18 08:20:03",
          "utcUpdateTime": "2025-09-18 08:20:03",
          "fromAddress": "LHDwcMPVPXXvrmSlRVeEcxsLUCvtThHLa"
        }
      ]
    },
    "channelId": "123456",
    "chain": "ETN",
    "address": "0x67C30f439D7734f393c2F4a587B198b8F4086Ccb"
  }
}

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 GET /payment/open/institution/v1/pay/address/query endpoint. The full schema, parameters, and examples are rendered from the linked OpenAPI definition above.

​
Notes

  • Provide at least one of prepayId or merchantTradeNo.
  • If both query parameters are provided, they must refer to the same address payment order.
  • The response is the current order snapshot for status and on-chain confirmation tracking, not the callback payload structure.
  • Authentication uses the standard GatePay signed headers.
  • This page documents the institutional path version of the same endpoint.
  • For shared signing rules, see /api-reference/version/100/en/common/securityAndSignature.

​
Institution Notes

  • Institutional requests must include X-GatePay-On-Behalf-Of to specify the institutional sub-account to operate on.

Headers

​
X-GatePay-Certificate-ClientId
string
required

Merchant client ID, obtained from GatePay platform

​
X-GatePay-Signature
string
required

HMAC-SHA256 signature for request validation

​
X-GatePay-Timestamp
string
required

Timestamp in milliseconds, must not differ from server time by more than 5 minutes

​
X-GatePay-Nonce
string
required

Random nonce for replay attack prevention

Query Parameters

​
prepayId
string

Prepay order ID for address payment; use with merchantTradeNo as either-or, and provide at least one

​
merchantTradeNo
string

Merchant system transaction number; use with prepayId as either-or, and provide at least one

Response

200 - application/json

SUCCESS

​
status
string

Payment status

​
code
string

Error code

​
errorMessage
string

Error message

​
data
object

Address payment order details