Skip to main content
GET
/
refund
/
{id}
cURL
curl --request GET \
  --url https://uat-api.clinkbill.com/api/refund/{id} \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-Timestamp: <api-key>'
{
  "code": 200,
  "msg": "success",
  "data": {
    "createTime": 1754819711382,
    "refundId": "rfd_abc123xyz",
    "orderId": "order_def456uvw",
    "customerId": "cus_ghi789rst",
    "refundAmount": 19.99,
    "refundCurrency": "USD",
    "status": "success",
    "refundReason": "Customer Initiated Refund",
    "metadata": "{\"arn\":\"8377252556170253\", \"merchantReferenceId\":\"sample_id\"}"
  }
}

Authorizations

​
X-API-KEY
string
header
required

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

​
X-Timestamp
string
header
required

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

Path Parameters

​
id
string
required

Unique identifier of the refund

Response

200 - application/json

Refund details retrieved 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