v1

latestOpenAPI 3.1.02026-07-2182453.1 KB

Query Order

Check the details of the new address payment order, the specified parameters must correspond to the address payment order, otherwise an error message will be returned.

get/v1/pay/address/query

Query parameters

prepayIdstring

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

merchantTradeNostring

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

Headers

X-GatePay-Certificate-ClientIdstring required

Merchant client ID, obtained from GatePay platform

X-GatePay-Signaturestring required

HMAC-SHA256 signature for request validation

X-GatePay-Timestampstring required

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

X-GatePay-Noncestring required

Random nonce for replay attack prevention

Response

SUCCESS

statusstring

Payment status

codestring

Error code

errorMessagestring

Error message

Example response

{
  "data": {
    "totalInstitutionFeeAmount": "0",
    "payDetails": [
      {
        "institutionFeeAmount": "0"
      }
    ]
  }
}