Initiate merchant refund

Initiate a refund for a previously created order. Returns the acquirer refund identifier and the initial refund status (e.g. REFUNDING). Use this API to submit merchant-initiated refunds.

Header Parameters

X-R-Ts*string

request timestamp in milliseconds

X-R-Ak*string

merchant's appKey

X-R-Signature*string

request signature

X-R-Key-Version?string

merchant's private key version, default is 1

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

create refund order request

merchantRefundSn*string

Merchant's external refund identifier (merchantRefundSn).

Max length: 64 characters.
Allowed characters: letters, numbers and _ - | * @

outerOrderSn*string

Merchant's original order identifier (outerOrderSn). Use this to link the refund to the original payment.

reason*string

Refund reason provided by the merchant. This should clearly explain why the refund is requested.

refundAmount?number

Used for partial refund of order. if not specified, it defaults to a full refund.

Response Body

`/`

`application/json`

curl -X POST "https://example.com/openapi/v2/refund/create" \  -H "X-R-Ts: 1762327084929" \  -H "X-R-Ak: string" \  -H "X-R-Signature: string" \  -H "Content-Type: application/json" \  -d '{    "merchantRefundSn": "MRF20260101002",    "outerOrderSn": "ORD20260101001",    "reason": "Product out of stock — customer requested refund",    "refundAmount": 50  }'

"open api common response"

{  "code": "paramFormatError",  "message": "request param invalid"}

{  "code": "authorizationInvalid",  "message": "authorizationInvalid invalid"}

{  "code": "notInWhiteList",  "message": "request ip not in the white list"}

{  "code": "frequencyLimited",  "message": "Too many requests, please try again later"}

Header Parameters

Request Body

Response Body

200*/*

400application/json

401application/json

403application/json

429application/json

`/`

`application/json`

`application/json`

`application/json`

`application/json`