GAgate

Query Order

Changed on

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

Request

  • Base URL
    https://openplatform.gateapi.io
  • URL
    https://openplatform.gateapi.io/v1/pay/address/query
  • Auth
    none declared. Required headers: X-GatePay-Certificate-ClientId, X-GatePay-Signature, X-GatePay-Timestamp, X-GatePay-Nonce

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

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

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"
      }
    ]
  }
}

Changes

  • e66c448f796eRevision changes
    • info

      added the optional property //// to the response with the status