接口描述
用于对已交易成功对订单执行退款操作。
请求方式
POST
生产调用地址
https://cqopen.upaas.unionpay.com/v2/order/refund
测试调用地址
https://openapi.mayihaike.com/v2/order/refund
HTTP报文体参数
| 中文名称 | 英文名称 | 域类型 | 域长度 | 默认值 | 请求要求 | 备注 | |
|---|---|---|---|---|---|---|---|
| 退款备注 | remark | string | 20 | O-选填 | 退款备注
|
||
| 退款金额 | amount | string | decimal(10,2) | M-必填 | 退款金额,为避免签名问题,请转换成字符串后传递。
|
||
| 扫码交易流水号 | merchant_trade_no | string | 64 | O-选填 | 扫码交易流水号,与商家订单号或平台订单号或收单机构流水号四者必传其一
|
||
| 收单机构流水号 | trade_no | string | 64 | O-选填 | 收单机构流水号,与商家订单号或平台订单号或扫码交易流水号四者必传其一
|
||
| 商家订单号 | merchant_order_no | string | 64 | O-选填 | 商家订单号,与平台订单号或收单机构流水号或扫码交易流水号四者必传其一
|
||
| 平台订单号 | order_number | string | 32 | O-选填 | 平台订单号,与商家订单号或收单机构流水号或扫码交易流水号四者必传其一
|
||
| 商家退款单号 | merchant_refund_no | string | 64 | M-必填 | 商家退款单号
|
||
| 门店编号 | store_num | string | 10 | M-必填 | 门店编号
|
||
| 收银员编号 | staff_num | string | 8 | M-必填 | 收银员编号
|
同步应答参数
| 中文名称 | 英文名称 | 域类型 | 域长度 | 默认值 | 请求要求 | 备注 | |
|---|---|---|---|---|---|---|---|
| 商家退款单号 | merchant_refund_no | string | 64 | M-必填 | 商家退款单号
|
||
| 退款失败原因 | fail_reason | string | 64 | M-必填 | 退款失败原因,取决于收单机构,可能为空。
|
||
| 退款状态 | refund_status | int | 1 | M-必填 | 退款状态:0-退款中,1-退款成功,2-退款失败。
|
||
| 退款时间 | refund_at | int | 11 | M-必填 | 退款成功unixtimestamp,收单机构未明确告知结果和退款失败时为0。
|
||
| 退款金额 | refund_amount | string | decimal(10,2) | M-必填 | 退款金额
|
||
| 平台退款单号 | refund_no | string | 32 | M-必填 | 平台退款单号
|
示例代码
{
"code": "000000",
"message": "请求成功",
"data": {
"refund_no": "4200729124053593878827008",
"refund_amount": "0.01",
"refund_at": 0,
"refund_status": 0,
"fail_reason": "",
"merchant_refund_no": "61596006390",
"sign": "1229566c94521b2d8938812b7ff880ac"
}
}
当 refund_status = 0 时,可调用退款查询接口。鉴于各收单机构差异,退款状态可能需要一天时间退款才会到账。