退款 Webhook
退款状态异步通知。
接口
POST/merchant-callback-url认证
Merchant Credential。详见 认证。
重要说明
警告
该接口的响应时间请务必在3s内响应，如超3s响应，系统将当做回调失败处理！
请求头
| 名称 | 位置 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|---|
Content-Type | header | string | 是 | application/json | |
X-Nonce | header | string | 是 | a9f3c1d47e8b9a2c4d1f9e8a7b6c5d4e | |
X-Merchant-Id | header | string | 是 | 2492265300 | |
X-Timestamp | header | string | 是 | 1638123456 | |
Digest | header | string | 是 | SHA-256=Jr9cX0nM6yT7uF9GQ5G8ZC5M8vRZrQZP9+VbQ8Z8z0Q= | |
Authorization | header | string | 是 | Signature keyId="m123456",alg="ES256",headers="(request-target) x-timestamp x-nonce digest",signature="MEUCIQD8VxkzR7q5hF3k9dY0v6mKk7K0Nq9nYw+7Ck8LJr9mYAIgC5VQ7J0Z9YqL5F8Wc6E2Yw5qf1z8bYyYcR9kX8pY=" |
请求体
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
event | string | 是 | 事件 |
mchOrderNo | string | 是 | 商户订单号 |
platOrderNo | string | 是 | 平台订单号 |
orderStatus | string | 是 | 订单状态 (enum=PENDING, SUCCESS, FAILED, REFUND) |
amount | number | 是 | 订单金额 — 订单创建时金额 |
payAmount | number | 是 | 实际支付金额 |
msg | string | 是 | 信息 — 错误信息 |
payTime | integer | 是 | 付款时间 — 秒级时间戳 |
e2eId | string | 是 | 银行交易ID — 订单成功/退款时返回 |
payerName | string | 是 | 订单成功时返回 |
payerDocument | string | 是 | 订单成功时返回 |
refundAmount | number | 是 | 本次退款金额，多次退款时需注意 |
refundId | string | 是 | 退款ID |
originE2eId | string | 是 | 退款订单原始E2eid |
refundTotalAmount | number | 是 | 已退款总金额 |
refundSn | string | 是 | 退款商户编号 |
status | string | 是 | 退款状态 (enum=PENDING, SUCCESS, FAILED) |
请求示例
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"
}