Skip to content

Refund List & Details

Updated: 7/26/26, 9:23:52 PM

Query capabilities for refund orders. Both belong to the Management API (/mch/*) with Sa-Token auth.

Endpoints

EndpointPathMethodDescription
Refund page/mch/order/refund/pageGETPaginated refund query
Refund detail/mch/order/refund/get-by-idGETGet refund details by ID

Refund Page

Request

GET /mch/order/refund/page

  • Auth: Sa-Token (Accesstoken header)
  • Response: Result<PageResult<RefundOrderResult>>

Parameters

Passed via query string — pagination + filters:

Pagination (PageParam):

ParameterTypeDefaultDescription
currentint1Current page
sizeint10Page size

Filters (RefundOrderQuery, all optional):

ParameterTypeMatchDescription
mchNostringEQMerchant number
appIdstringEQApplication ID
refundNostringLIKESystem refund number (fuzzy)
bizRefundNostringLIKEMerchant refund number (fuzzy)
tradeNostringLIKEOriginal fund trade number (fuzzy)
tradeTypestringEQTrade type (original payment form)
bizOrderNostringLIKEMerchant order number (fuzzy)
statusstringEQRefund status (RefundOrderStatusEnum)
productstringEQPayment product
storeNostringEQStore number
createTimeStartstringGECreated time start (yyyy-MM-dd HH:mm:ss, GMT+8)
createTimeEndstringLECreated 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-xxxx

Response

Result<PageResult<RefundOrderResult>>:

FieldTypeDescription
recordsobject[]Refund list (each item same as Refund - Response)
totallongTotal records
sizelongPage size
currentlongCurrent 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 (Accesstoken header)
  • Response: Result<RefundOrderResult>

Parameters

ParameterLocationTypeRequiredDescription
idquerylongYesRefund order ID

Example

http
GET /mch/order/refund/get-by-id?id=1853123456789012345 HTTP/1.1
Host: your-domain.com
Accesstoken: xxxx-xxxx-xxxx

Example

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"
  }
}

Released under the GNU LGPL v3.0