Refund Webhook
Asynchronous refund status notification.
Endpoint
POST/merchant-callback-urlAuthentication
Merchant Credential. See Authentication.
Important Notes
WARNING
You must respond within 3 seconds. Responses slower than 3s are treated as callback failures!
Request headers
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
Content-Type | header | string | Yes | application/json | |
X-Nonce | header | string | Yes | a9f3c1d47e8b9a2c4d1f9e8a7b6c5d4e | |
X-Merchant-Id | header | string | Yes | 2492265300 | |
X-Timestamp | header | string | Yes | 1638123456 | |
Digest | header | string | Yes | SHA-256=Jr9cX0nM6yT7uF9GQ5G8ZC5M8vRZrQZP9+VbQ8Z8z0Q= | |
Authorization | header | string | Yes | Signature keyId="m123456",alg="ES256",headers="(request-target) x-timestamp x-nonce digest",signature="MEUCIQD8VxkzR7q5hF3k9dY0v6mKk7K0Nq9nYw+7Ck8LJr9mYAIgC5VQ7J0Z9YqL5F8Wc6E2Yw5qf1z8bYyYcR9kX8pY=" |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
event | string | Yes | Event |
mchOrderNo | string | Yes | Merchant order number |
platOrderNo | string | Yes | Platform order number |
orderStatus | string | Yes | Order status (enum=PENDING, SUCCESS, FAILED, REFUND) |
amount | number | Yes | Order amount — Amount at order creation |
payAmount | number | Yes | Actual paid amount |
msg | string | Yes | Message — Error message |
payTime | integer | Yes | Payment time — Unix timestamp (seconds) |
e2eId | string | Yes | Bank transaction ID — Returned when the order succeeds or is refunded |
payerName | string | Yes | Returned when the order succeeds |
payerDocument | string | Yes | Returned when the order succeeds |
refundAmount | number | Yes | Refund amount for this request; take care with multiple refunds |
refundId | string | Yes | Refund ID |
originE2eId | string | Yes | Original E2E ID of the refunded order |
refundTotalAmount | number | Yes | Total refunded amount |
refundSn | string | Yes | Refund merchant ID |
status | string | Yes | Refund status (enum=PENDING, SUCCESS, FAILED) |
Request example
json
{
"event": "PIX_QRCODE_REFUND",
"mchOrderNo": "20220721144249483",
"platOrderNo": "3KITxA1dEXhZ2IRXvwck",
"orderStatus": "REFUND",
"amount": 10000,
"payAmount": 10000,
"msg": "退款成功",
"payTime": 1658387041,
"e2eId": "D10316968202309101937aZOHAzdi39",
"payerName": "Name",
"payerDocument": "1234567890",
"refundAmount": 10000,
"refundTotalAmount": 10000,
"refundId": "311",
"originE2eId": "E00416968202309101937aZOHAzv6vkT",
"status": "SUCCESS"
}