Skip to main content
GET
Query Order

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

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

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