主题
在线退款
简述
- 商户在线退款申请接口
请求 URL
/pay/merchant/refund
请求参数
- body
| 参数名 | 必选 | 类型 | 长度 | 说明 |
|---|---|---|---|---|
| merchantId | 是 | String | 32 | 商户编码 |
| merRefundOrderId | 是 | String | 64 | 商户退款订单号,在商户系统保证唯一 |
| origOrderId | 条件 | String | 32 | 平台原交易订单号,与 origMerOrderId 上送其一 |
| origMerOrderId | 条件 | String | 64 | 商户原交易订单号,与 origOrderId 上送其一 |
| refundAmt | 是 | String | 12 | 退款金额,两位小数,格式:100.00 |
| refundCurrency | 是 | String | 10 | 退款币种 |
| refundDesc | 否 | String | 128 | 退款说明 |
| serverNotifyUrl | 否 | String | 255 | 服务端退款结果通知地址。商户如果传该字段,以此 URL 为准给商户服务端回调;如果未传该字段,以后端配置的 URL 给商户服务端回调 |
请求示例
json
{
"merchantId": "M12345678",
"merRefundOrderId": "255456464654564564484",
"origOrderId": "TRD2025011015332312345",
"origMerOrderId": "",
"refundAmt": "20.00",
"refundCurrency": "SAR",
"refundDesc": "refund",
"serverNotifyUrl": "https://xxxx.com/notify"
}1
2
3
4
5
6
7
8
9
10
2
3
4
5
6
7
8
9
10
响应参数
- data
| 参数名 | 类型 | 说明 |
|---|---|---|
| merchantId | String | 商户编码 |
| refundOrderId | String | 平台退款订单号 |
| merRefundOrderId | String | 商户退款订单号,同请求 |
| refundAmt | String | 交易金额 两位小数 格式:100.00 |
| refundCurrency | String | 退款币种 |
| refundTime | String | 退款时间,格式:YYYY-MM-DD HH:MM:SS |
| refundChannel | String | 退款渠道,固定值:original(原路退款) |
| refundStatus | String | 退款状态:init:初始化 pending:处理中 success:退款成功 fail:失败 |
| origOrdInfo | Object | 原交易信息,对象格式,(Object:origOrdInfo) |
Object:origOrdInfo
| 参数名 | 类型 | 说明 |
|---|---|---|
| origOrderId | String | 原交易订单号 |
| origMerOrderId | String | 原交易商户订单号 |
| origOrderAmt | String | 原交易金额 |
| origRefundedAmt | String | 原交易已成功退款金额 |
| origRemainAmt | String | 原交易剩余退款金额 |
响应示例
json
{
"code": 10000,
"message": "success",
"data": {
"merchantId": "M12345678",
"refundOrderId": "REF202412131543011234578",
"merRefundOrderId": "202412131543011234572332",
"refundAmt": "20.00",
"refundCurrency": "SAR",
"refundTime": "2024-12-13 18:05:03",
"refundChannel": "original",
"refundStatus": "pending",
"origOrdInfo": {
"origOrderId": "TRD20241210153120123456",
"origMerOrderId": "20241210153323032323",
"origOrderAmt": "100.00",
"origRefundedAmt": "20.00",
"origRemainAmt": "80.00"
}
}
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
