Skip to main content
WEBHOOK
refund
{
  "id": "<string>",
  "type": "refund.created",
  "object": "event",
  "created": "2023-11-07T05:31:56Z",
  "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)

Body

application/json

Refund event payload in json

​
id
string

Unique identifier for the event

​
type
enum<string>

Type of event that occurred

Available options:
refund.created,
refund.succeeded,
refund.failed
​
object
string

Type of this json payload, 'event' if this is an event

Example:

"event"

​
created
string<date-time>

Timestamp when the event occurred

​
data
object

Response

200

Return a 200 status to indicate that the data was received successfully