# 1.4 退款回调接口
# 请求URL
/xxx
# 请求方式
- POST
# 请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| eventName | 是 | string | 事件名称 (payment.refund.success, payment.refund.failed, payment.refund.cancel) |
| mchRefundOrderId | 是 | string | 商户-退款编号, 商户系统唯一标识 |
| refundTransactionId | 是 | string | PayCools Refund Transaction ID |
| originalTransactionId | 是 | string | PayCools Origin Transaction ID |
| refundAmount | 是 | int | Refund Amount |
| refundStatus | 是 | string | Refund Status |
| refundCreateTime | 是 | string | Refund Create Time |
| refundReturnTime | 是 | string | Refund Return Time |
| refundReason | 是 | string | Refund Reason |
| failedCode | 否 | int | Failed Code |
| failedMessage | 否 | string | Failed Message |
| sign | 是 | string | Sign签名 |
# 回调签名参考 回调签名参考 (opens new window)
# callback example
// payment refund success callback
{
"eventName": "payment.refund.success",
"mchRefundOrderId": "CCP20220428011068111",
"refundTransactionId": "C4X20220428011068485",
"originalTransactionId": "R2022042801106815674",
"refundAmount":1000, // 单位: 分
"refundStatus":"COMPLETE",
"refundCreateTime":"2022-05-31 09:38:06",
"refundReturnTime":"2022-05-31 09:38:06",
"refundReason":"refund reson",
"sign": "xxxxxxxxxxxxx"
}
// payment refund failed callback
{
"eventName": "payment.refund.success",
"mchRefundOrderId": "CCP20220428011068111",
"refundTransactionId": "C4X20220428011068485",
"originalTransactionId": "R2022042801106815674",
"refundAmount":1000, // 单位: 分
"refundStatus":"FAILED",
"refundCreateTime":"2022-05-31 09:38:06",
"refundReturnTime":"2022-05-31 09:38:06",
"refundReason":"refund reson",
"failedCode": -10009,//退款失败时返回
"failedMessage": "Channel Refund Failed"//退款失败时返回
"sign": "xxxxxxxxxxxxx"
}
# 返回示例
{
"code":1,
"msg":"success",
"data":{
}
}
← 1.3 退款支持渠道列表 1.5 退款状态 →