Skip to main content
POST
Create Refund

Authorizations

X-API-KEY
string
header
required

Your secret API key obtained from the Clink dashboard (Developers section)

Headers

X-Timestamp
string
required

Current timestamp in milliseconds since Unix epoch (required for request signing)

Example:

"1783513683000"

Body

application/json

Parameters required to create a refund by API

orderId
string
required

Unique identifier of the order to refund

refundMerchantOrderId
string
required

Merchant-provided unique refund order ID. Reusing the same value returns the existing refund.

refundAmount
number
required

Refund amount

Example:

19.99

refundReasonType
enum<integer>

Refund reason type: 0 duplicate payment, 1 fraudulent activity, 2 customer initiated refund, 3 other

Available options:
0,
1,
2,
3
remark
string

Refund remark, up to 500 characters

Maximum string length: 500

Response

Refund created successfully

code
integer<int32>

Response status code, 200 when success

Example:

200

msg
string

Brief description of what happened, 'success' when happy case

Example:

"success"

data
object