# 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 int 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":10000, // 单位: 分
    "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":10000, // 单位: 分
    "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":{
	}
}