Refund List & Details
Query capabilities for refund orders. Both belong to the Management API (/mch/*) with Sa-Token auth.
Endpoints
| Endpoint | Path | Method | Description |
|---|---|---|---|
| Refund page | /mch/order/refund/page | GET | Paginated refund query |
| Refund detail | /mch/order/refund/get-by-id | GET | Get refund details by ID |
Refund Page
Request
GET /mch/order/refund/page
- Auth: Sa-Token (
Accesstokenheader) - Response:
Result<PageResult<RefundOrderResult>>
Parameters
Passed via query string — pagination + filters:
Pagination (PageParam):
| Parameter | Type | Default | Description |
|---|---|---|---|
| current | int | 1 | Current page |
| size | int | 10 | Page size |
Filters (RefundOrderQuery, all optional):
| Parameter | Type | Match | Description |
|---|---|---|---|
| mchNo | string | EQ | Merchant number |
| appId | string | EQ | Application ID |
| refundNo | string | LIKE | System refund number (fuzzy) |
| bizRefundNo | string | LIKE | Merchant refund number (fuzzy) |
| tradeNo | string | LIKE | Original fund trade number (fuzzy) |
| tradeType | string | EQ | Trade type (original payment form) |
| bizOrderNo | string | LIKE | Merchant order number (fuzzy) |
| status | string | EQ | Refund status (RefundOrderStatusEnum) |
| product | string | EQ | Payment product |
| storeNo | string | EQ | Store number |
| createTimeStart | string | GE | Created time start (yyyy-MM-dd HH:mm:ss, GMT+8) |
| createTimeEnd | string | LE | Created time end (yyyy-MM-dd HH:mm:ss, GMT+8) |
Example
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-xxxxResponse
Result<PageResult<RefundOrderResult>>:
| Field | Type | Description |
|---|---|---|
| records | object[] | Refund list (each item same as Refund - Response) |
| total | long | Total records |
| size | long | Page size |
| current | long | Current page |
Example
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
}
}Refund Detail
Request
GET /mch/order/refund/get-by-id
- Auth: Sa-Token (
Accesstokenheader) - Response:
Result<RefundOrderResult>
Parameters
| Parameter | Location | Type | Required | Description |
|---|---|---|---|---|
| id | query | long | Yes | Refund order ID |
Example
http
GET /mch/order/refund/get-by-id?id=1853123456789012345 HTTP/1.1
Host: your-domain.com
Accesstoken: xxxx-xxxx-xxxxExample
Returns full RefundOrderResult (27 fields; same as Refund - Response):
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": "Customer requested refund",
"createTime": "2024-12-01T04:00:00Z"
}
}