Skip to main content
POST
Query refund order

Overview

This page documents the POST /v1/pay/order/refund/query endpoint. The full schema, parameters, and examples are rendered from the linked OpenAPI definition above.

Notes

Headers

X-GatePay-Certificate-ClientId
string
required

Merchant client ID, obtained from GatePay platform

Example:

"4186d0c6-6a35-55a9-8dc6-5312769dbff8"

X-GatePay-Signature
string
required

HMAC-SHA512 signature for request validation

Example:

"672d5650dcc9bb22ebf25fa16c28d03c0e159d742a9176d4340a5da326d75dc8a2ec24c97fa6fc5d1533dd6e968863747e1d86a45e562cbe899f9ed7e9ca7f77"

X-GatePay-Timestamp
string
required

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

Example:

"1672905655498"

X-GatePay-Nonce
string
required

Random nonce for replay attack prevention

Example:

"3525756760"

Body

application/json

Request body for querying refund order.

refundRequestId
string
required

Refund order ID generated by the merchant. Must be unique and no more than 32 characters.

Response

200 - application/json

Refund order detail

Response body for querying refund order.

status
string
required

SUCCESS or FAIL

code
string
required

Error code

errorMessage
string

Error message

data
object

Refund order information