入参列表
请求参数 | 描述 | 类型 | 是否必须传入 |
customerId | 支付平台分配给开发者的业务id | string | 是 |
txId | 支付平台订单id | string | txId、orderId 二选一 |
orderId | 业务订单id | string | txId、orderId 二选一 |
refundId | 支付平台退款id | string | refundId、customerRefundId 二选一 |
customerRefundId | 标识一次退款请求,无批次默认1 | string | refundId、customerRefundId 二选一 |
timestamp | 请求时间戳 毫秒级 | Int | 是 |
traceId | 请求标识id | string | 是 |
version | 接口版本,目前1.0 | string | 是 |
signType | 签名校验类型,默认MD5 | string | 是 |
sign | 校验签名 | string | 是 |
返回列表
【errno及msg映射】
errno | Msg |
0 | Success |
8004010001 | 签名不正确 |
8004010002 | customerId参数为空 |
8004010003 | 参数错误 |
8004010004 | 内部错误 |
8004010005 | timestamp参数为空 |
【data返回体】
参数 |
子参数 |
描述 |
customerId |
无 |
业务方id |
orderId |
无 |
业务订单 id |
txId |
无 |
支付平台订单id |
refundCount |
无 |
退款次数 |
payChannel |
无 |
付款渠道 |
payChannelId |
无 |
付款渠道 id |
batchRefundList(列表,未传 refundId 或 customerRefundId 将返回全部批次) |
refundId |
支付平台退款 id |
customerRefundId |
客户退款 id |
refundStatus |
退款状态 REFUND_CREATE(退款中)、REFUND_FAIL(退款失败,可重新发起,需采用相同退款参数)、REFUND_SUCCESS(退款成功)、REFUND_NOT_SUPPORT(渠道不支持退款)、REFUND_CHANGE(退款异常,需要人工干预) |
refundStatusDesc |
退款状态描述 |
refundAmount |
退款金额 |
failReason |
支付失败原因 |
extData |
退款请求透传数据 |
leftAmount |
无 |
剩余可退款金额 |
返回示例
{
"errno": 0,
"msg": "SUCCESS",
"data": {
"customerId": 1,
"orderId": "1234567",
"txId": "80817829888213710",
"refundCount": 1,
"payChannel": 2,
"payChannelId": 2,
"leftAmount": 0,
"batchRefundList": [
{
"refundId": 71,
"customerRefundId": "",
"refundStatus": REFUND_STATUS,
"refundStatusDesc": "退款成功",
"failReason": null,
"refundAmount": 1,
"extData": ""
}
]
}
}