Webhooks

Dispute

Notification kindsAnchorIcon

The notification kind, returned by calling kind on the notification object, reveals what triggered the webhook. The webhookNotification.getKind() for Dispute webhooks will be one of the following:

  • WebhookNotification.Kind.DISPUTEACCEPTED
  • WebhookNotification.Kind.DISPUTEAUTOACCEPTED
  • WebhookNotification.Kind.DISPUTEDISPUTED
  • WebhookNotification.Kind.DISPUTEEXPIRED
  • WebhookNotification.Kind.DISPUTELOST
  • WebhookNotification.Kind.DISPUTEOPENED
  • WebhookNotification.Kind.DISPUTEUNDERREVIEW
  • WebhookNotification.Kind.DISPUTEWON

The following table describes the conditions that trigger each kind of webhook.

Notification TypeDescription
dispute_accepted

A dispute is accepted.

dispute_auto_accepted

A dispute is automatically accepted.

dispute_disputed

A dispute is disputed.

dispute_expired

A dispute is expired.

dispute_lost

A dispute is lost.

dispute_opened

A dispute is opened.

dispute_under_review

A dispute is under internal review with PayPal.

dispute_won

A dispute is won.

AttributesAnchorIcon

getKind()enum
The kind of webhook notification.
getTimestamp()date
The UTC time at which the webhook was triggered.
getDispute()object

A Dispute object.

getTransactionDetails()
Deprecated. Please use transaction on the Dispute object instead.