退款列表与详情
提供退款订单的查询能力,均属管理 API(/mch/*),Sa-Token 认证。
接口列表
| 接口名称 | 接口地址 | 方法 | 描述 |
|---|---|---|---|
| 退款分页 | /mch/order/refund/page | GET | 分页查询退款单 |
| 退款详情 | /mch/order/refund/get-by-id | GET | 根据 ID 查询退款单详情 |
退款分页
请求地址
GET /mch/order/refund/page
- 认证:Sa-Token(请求头
Accesstoken) - 响应:
Result<PageResult<RefundOrderResult>>
请求参数
通过查询字符串传递,分页参数 + 查询条件:
分页参数(PageParam):
| 参数 | 类型 | 默认 | 描述 |
|---|---|---|---|
| current | int | 1 | 当前页码 |
| size | int | 10 | 每页条数 |
查询条件(RefundOrderQuery,均可选):
| 参数 | 类型 | 匹配方式 | 描述 |
|---|---|---|---|
| mchNo | string | EQ | 商户号 |
| appId | string | EQ | 应用号 |
| refundNo | string | LIKE | 系统退款号(模糊匹配) |
| bizRefundNo | string | LIKE | 商户退款号(模糊匹配) |
| tradeNo | string | LIKE | 原支付资金交易号(模糊匹配) |
| tradeType | string | EQ | 交易类型(原支付形态) |
| bizOrderNo | string | LIKE | 商户业务订单号(模糊匹配) |
| status | string | EQ | 退款状态(RefundOrderStatusEnum) |
| product | string | EQ | 支付产品 |
| storeNo | string | EQ | 门店号 |
| createTimeStart | string | GE | 创建时间起始(yyyy-MM-dd HH:mm:ss,GMT+8) |
| createTimeEnd | string | LE | 创建时间结束(yyyy-MM-dd HH:mm:ss,GMT+8) |
请求示例
http
GET /mch/order/refund/page?current=1&size=20&status=progress&createTimeStart=2024-12-01%2000:00:00 HTTP/1.1
Host: your-domain.com
Accesstoken: xxxx-xxxx-xxxx响应参数
Result<PageResult<RefundOrderResult>>:
| 参数 | 类型 | 描述 |
|---|---|---|
| records | object[] | 退款单列表(每项结构同 申请退款 - 响应参数) |
| total | long | 总记录数 |
| size | long | 每页条数 |
| current | long | 当前页码 |
响应示例
json
{
"code": 0,
"message": "success",
"data": {
"records": [
{
"id": "1853123456789012345",
"refundNo": "R2024120112345700001",
"bizRefundNo": "REFUND20241201001",
"bizOrderNo": "ORDER20241201001",
"amount": 100,
"status": "progress",
"createTime": "2024-12-01T04:00:00Z"
}
],
"total": 1,
"size": 20,
"current": 1
}
}退款详情
请求地址
GET /mch/order/refund/get-by-id
- 认证:Sa-Token(请求头
Accesstoken) - 响应:
Result<RefundOrderResult>
请求参数
| 参数 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| id | query | long | 是 | 退款单 ID |
请求示例
http
GET /mch/order/refund/get-by-id?id=1853123456789012345 HTTP/1.1
Host: your-domain.com
Accesstoken: xxxx-xxxx-xxxx响应示例
返回完整的 RefundOrderResult(27 字段,结构同 申请退款 - 响应参数):
json
{
"code": 0,
"message": "success",
"data": {
"id": "1853123456789012345",
"refundNo": "R2024120112345700001",
"bizRefundNo": "REFUND20241201001",
"bizOrderNo": "ORDER20241201001",
"tradeNo": "T2024120112345700001",
"amount": 100,
"orderAmount": 100,
"status": "success",
"finishTime": "2024-12-01T06:00:00Z",
"channel": "wechat",
"product": "WECHAT_PAY",
"reason": "用户申请退款",
"createTime": "2024-12-01T04:00:00Z"
}
}