GAgate

Checkout Order Details

Changed on

Query checkout order details by prepay ID or merchant trade number. Either prepayId or merchantTradeNo is required.

get/v2/pay/order/query

Request

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

Query parameters

prepayIdstring

Pre-order ID (either prepayId or merchantTradeNo required)

merchantTradeNostring

Merchant order number (either prepayId or merchantTradeNo required)

Headers

X-GatePay-Certificate-ClientIdstring required
Example:4186d0c6-6a35-55a9-8dc6-5312769dbff8

Merchant client ID, obtained from GatePay platform

X-GatePay-Signaturestring required
Example:672d5650dcc9bb22ebf25fa16c28d03c0e159d742a9176d4340a5da326d75dc8a2ec24c97fa6fc5d1533dd6e968863747e1d86a45e562cbe899f9ed7e9ca7f77

HMAC-SHA256 signature for request validation

X-GatePay-Timestampstring required
Example:1672905655498

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

X-GatePay-Noncestring required
Example:9578

Random nonce for replay attack prevention

Response

Order details retrieved successfully

statusstring

Payment status

codestring

Error code

errorMessagestring

Error message

Example response

{
  "data": {
    "totalInstitutionFeeAmount": "0",
    "card": {
      "brand": "visa",
      "last4": "4242",
      "expMonth": 11,
      "expYear": 2027,
      "funding": "credit",
      "country": "US"
    },
    "payDetails": [
      {
        "institutionFeeAmount": "0"
      }
    ]
  }
}

Changes