Webhook: dispute.opened

The dispute.opened event is sent when a dispute is opened against a payment.

Example

{
  "id": "d20f0f08-694d-4798-9faf-fccd5b61ed39",
  "type": "dispute.opened",
  "version": 1,
  "isSandbox": true,
  "data": {
    "dispute": {
      "id": "d20f0f08-694d-4798-9faf-fccd5b61ed32",
      "date": "2024-11-20T20:53:03.371Z",
      "status": "open",
      "comments": null,
      "amount": 100,
      "currency": "USD",
      "isSandbox": true,
      "purchaseId": "1bfb9321-0013-4196-ac9c-a864ecce522f",
      "reason": "fraud",
      "payments": [
        {
          "method": "credit_card",
          "amount": 100
        }
      ]
    }
  }
}

amount

The total disputed amount, expressed as 100x the currency's base unit; see Currencies.

reason

The reason for the dispute, or null. Possible values are cancel_subscription, product_not_received, product_unacceptable, friendly_fraud, ach_return, ach_reversal, duplicate, fraud, authorization, processing_errors, consumer_disputes , and other.

payments

How the disputed purchase was paid for, one entry per payment method, in the same format as payments on purchase.completed. Only the payment processor portion of a purchase can be disputed, so the dispute amount never includes the wallet portion.