The dispute object

You can expect the below object when you register a webhook for the following events:

dispute.received
dispute.evidence_submitted
dispute.expired
dispute.closed
dispute.won
dispute.lost

Raw sample

{
  "id": "PAY-3C4D5E6F7A",
  "amount": 33.99,
  "amount_currency": "AED",
  "refund_amount": 0,
  "refund_status": "No refund",
  "refunds": [],
  "max_refund_amount": 33.99,
  "billing_descriptor": "Mamo*Merchant",
  "created_date": "2023-12-25-14-38-53",
  "external_id": null,
  "subscription_id": null,
  "customer_details": {
    "name": "",
    "email": "[email protected]",
    "phone_number": "-",
    "comment": "-"
  },
  "payment_method": {
    "card_id": null,
    "type": "CREDIT VISA",
    "card_holder_name": "John Doe",
    "card_last4": "1111",
    "card_expiry_month": "12",
    "card_expiry_year": "2028",
    "origin": "International card",
    "card_country": "United Kingdom"
  },
  "dispute_status": "Closed",
  "dispute_amount": 33.99,
  "dispute_currency": "AED",
  "dispute_date": "2023-12-25-14-38-53",
  "deadline_to_respond": "2023-12-25-14-38-53",
  "dispute_reason": "Fraudulent",
  "payment_link_id": "MB-LINK-5E6F7A8B9C",
  "event_type": "dispute.closed"
}

Field descriptions

Field	Type	Description
id	String	Unique payment identifier
amount	Number	Payment amount
amount_currency	String	Currency code for the payment amount
refund_amount	Number	Amount that has been refunded
refund_status	String	Refund status description
refunds	Array	Breakdown of each individual refund issued (`id`-`amount`-`amount_currency`-`billing_amount`-`billing_amount_currency`)
max_refund_amount	Number	The maximum amount that can still be refunded on this payment
billing_descriptor	String	The name that appears on the customer's bank statement
created_date	String (Format: YYYY-MM-DD-HH-MM-SS)	Payment creation date and time
external_id	String	External ID if sent
subscription_id	String	Unique subscription identifier
customer_details	Dictionary	Customer information (`name`, `email`, `phone_number`, `comment`)
payment_method	Dictionary	Payment method details (`card_id`, `type`, `card_holder_name`, `card_last4`, `card_expiry_month`, `card_expiry_year`, `origin`, `card_country`)
dispute_status	String	Current status of dispute
dispute_amount	String	Amount the customer has disputed
dispute_currency	String	Currency of dispute
dispute_date	String (Format: YYYY-MM-DD)	Date the dispute was raised
deadline_to_respond	String (Format: YYYY-MM-DD)	Deadline to submit a response to the dispute
dispute_reason	String	Reason why the customer raised the dispute (e.g. fraudulent, product not received, etc.)
payment_link_id	String	Unique payment link identifier
event_type	String	Webhook event type (dispute.received, dispute.won, etc.)