Common
Balance
Institution
Payment
OTC
Convert
Payout
Gift Card
Subscription
curl --request POST \
--url https://openplatform.gateapi.io/v1/pay/order/refund/query \
--header 'Content-Type: application/json' \
--header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>' \
--header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
--header 'X-GatePay-Signature: <x-gatepay-signature>' \
--header 'X-GatePay-Timestamp: <x-gatepay-timestamp>' \
--data '
{
"refundRequestId": "156123911"
}
'{
"status": "SUCCESS",
"code": "000000",
"data": {
"refundRequestId": "156123911",
"prepayId": "1647557960944",
"orderAmount": "1.91",
"refundAmount": "0.8",
"refundStatus": "SUCCESS"
},
"errorMessage": ""
}Query Web Payment Refund
Query the status and details of a refund order by merchant-generated refund request ID.
curl --request POST \
--url https://openplatform.gateapi.io/v1/pay/order/refund/query \
--header 'Content-Type: application/json' \
--header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>' \
--header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
--header 'X-GatePay-Signature: <x-gatepay-signature>' \
--header 'X-GatePay-Timestamp: <x-gatepay-timestamp>' \
--data '
{
"refundRequestId": "156123911"
}
'{
"status": "SUCCESS",
"code": "000000",
"data": {
"refundRequestId": "156123911",
"prepayId": "1647557960944",
"orderAmount": "1.91",
"refundAmount": "0.8",
"refundStatus": "SUCCESS"
},
"errorMessage": ""
}Documentation Index
Fetch the complete documentation index at: https://docs.gate.com/llms.txt
Use this file to discover all available pages before exploring further.
Overview
This page documents thePOST /v1/pay/order/refund/query endpoint. The full schema, parameters, and examples are rendered from the linked OpenAPI definition above.
Notes
- Authentication uses the standard GatePay signed headers.
- This page documents the standard merchant endpoint.
- For shared signing rules, see /api-reference/version/100/en/common/securityAndSignature.
Headers
Merchant client ID, obtained from GatePay platform
"4186d0c6-6a35-55a9-8dc6-5312769dbff8"
HMAC-SHA256 signature for request validation
"672d5650dcc9bb22ebf25fa16c28d03c0e159d742a9176d4340a5da326d75dc8a2ec24c97fa6fc5d1533dd6e968863747e1d86a45e562cbe899f9ed7e9ca7f77"
Timestamp in milliseconds, must be within 5 minutes of server time
"1672905655498"
Random nonce for replay attack prevention
"3525756760"
Body
Request body for querying refund order.
Refund order ID generated by the merchant. Must be unique and no more than 32 characters.