Skip to content

Sync Refund

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

Description

Actively sync refund status from the payment channel. Called when refund status is progress, to fetch the latest result. Useful when channel callbacks are delayed or manual confirmation is needed.

Request

POST /mch/order/refund/sync?id={refundOrderId}

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

Parameter is in query string

id is a query parameter (@RequestParam), not request body. The body should be empty.

Parameters

ParameterLocationTypeRequiredDescription
idquerylongYesRefund order ID (numeric)

Example

http
POST /mch/order/refund/sync?id=1853123456789012345 HTTP/1.1
Host: your-domain.com
Accesstoken: xxxx-xxxx-xxxx
Content-Type: application/json

Response

Result<RefundOrderResult>, data structure same as Refund - Response. Main fields returned:

FieldTypeDescription
idlongRefund order ID
refundNostringSystem refund number
statusstringRefund status after sync (RefundOrderStatusEnum)
finishTimestringRefund completion time (UTC)
errorMsgstringError message (on failure)

Example

json
{
  "code": 0,
  "message": "success",
  "data": {
    "id": "1853123456789012345",
    "refundNo": "R2024120112345700001",
    "status": "success",
    "finishTime": "2024-12-01T06:00:00Z"
  }
}

Released under the GNU LGPL v3.0