Skip to content

退款列表与详情

更新时间:2026/7/26 21:23:52

提供退款订单的查询能力,均属管理 API(/mch/*),Sa-Token 认证。

接口列表

接口名称接口地址方法描述
退款分页/mch/order/refund/pageGET分页查询退款单
退款详情/mch/order/refund/get-by-idGET根据 ID 查询退款单详情

退款分页

请求地址

GET /mch/order/refund/page

  • 认证:Sa-Token(请求头 Accesstoken
  • 响应:Result<PageResult<RefundOrderResult>>

请求参数

通过查询字符串传递,分页参数 + 查询条件:

分页参数(PageParam):

参数类型默认描述
currentint1当前页码
sizeint10每页条数

查询条件(RefundOrderQuery,均可选):

参数类型匹配方式描述
mchNostringEQ商户号
appIdstringEQ应用号
refundNostringLIKE系统退款号(模糊匹配)
bizRefundNostringLIKE商户退款号(模糊匹配)
tradeNostringLIKE原支付资金交易号(模糊匹配)
tradeTypestringEQ交易类型(原支付形态)
bizOrderNostringLIKE商户业务订单号(模糊匹配)
statusstringEQ退款状态(RefundOrderStatusEnum
productstringEQ支付产品
storeNostringEQ门店号
createTimeStartstringGE创建时间起始(yyyy-MM-dd HH:mm:ss,GMT+8)
createTimeEndstringLE创建时间结束(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>>

参数类型描述
recordsobject[]退款单列表(每项结构同 申请退款 - 响应参数
totallong总记录数
sizelong每页条数
currentlong当前页码

响应示例

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>

请求参数

参数位置类型必填描述
idquerylong退款单 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"
  }
}

基于 GNU LGPL v3.0 协议开源