v8

OpenAPI 3.1.02026-08-033623795.0 MB

Disputes

Dispute Created

Sent when a dispute is created

Required permissions:

payment:dispute:read
plan:basic:read
access_pass:basic:read
company:basic:read
payment:basic:read
member:email:read
member:basic:read
member:phone:read
webhook_receive:disputes

postWebhookdispute.created

Headers

webhook-idstring required

A unique identifier for this webhook request

Example:msg_xxxxxxxxxxxxxxxxxxxxxxxx

webhook-signaturestring required

The signature of the webhook request with the webhook version prepended

Example:v1,BASE64ENCODEDSIGNATURE

webhook-timestampstring required

The timestamp in seconds since the Unix epoch that the webhook was sent at on the server

Example:1727606400

Payload

api_version'v1' required

The API version for this webhook

api_version_datestring nullable required

The dated API version (Api-Version-Date) the payload is serialized to

company_idstring nullable

The account ID that this webhook event is associated with

idstring required

A unique ID for every single webhook request

timestampstring date-time required

The timestamp in ISO 8601 format that the webhook was sent at on the server

type'dispute.created' required

The webhook event type

Example payload

{
  "api_version": "v1",
  "api_version_date": "2026-07-20",
  "company_id": "biz_xxxxxxxxxxxxxx",
  "data": {
    "evidence_locked_reason": "submitted",
    "reason": "fraudulent",
    "status": "needs_response"
  },
  "id": "msg_xxxxxxxxxxxxxxxxxxxxxxxx",
  "timestamp": "2025-01-01T00:00:00.000Z",
  "type": "dispute.created"
}

Response

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