Skip to main content
WEBHOOK
dispute
{
  "id": "<string>",
  "type": "dispute.created",
  "object": "event",
  "created": "<string>",
  "data": {
    "object": {
      "chargeBackId": "<string>",
      "channelCode": "<string>",
      "orderId": "<string>",
      "merchantId": "<string>",
      "customerId": "<string>",
      "disputeAmount": 0,
      "disputeCurrency": "<string>",
      "originalAmount": 0,
      "originalCurrency": "<string>",
      "reasonCode": "<string>",
      "reasonDescription": "<string>",
      "status": 1,
      "evidenceDeadline": "<string>",
      "channelDisputeTime": "<string>",
      "networkReasonCode": "<string>"
    }
  }
}

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

Dispute event payload in json

​
id
string

Unique identifier for the event

​
type
enum<string>

Type of event that occurred

Available options:
dispute.created,
dispute.updated,
dispute.won,
dispute.lost,
dispute.closed
Example:

"dispute.created"

​
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