Dispute Data Model

Overview

The "Dispute Data Model" is a Data model type used in your webhook endpoint. This model provides information about any DisputeStatusChanged event.

The "DisputeStatusChanged" webhook is triggered whenever there is a dispute triggered for a payment on your account. This webhook ensures that your system is notified of the disputes taking place and their updates, allowing for real-time updates and appropriate actions.

Your webhook endpoint will receive a POST request containing an event with EventType of value 6 and Event of value DisputeStatusChanged. This event is particularly useful for tracking the type of chargeback and its status.

Request Model

Input Parameter	Type	Description
InvoiceId	string	Unique identifier for the invoice.
InvoiceReference	string	A unique reference number assigned to the invoice.
CustomerReference	string	The CustomerIdentifier you sent in the request to create the invoice
CustomerName	string	Name of the customer.
CustomerMobile	string	Customer's mobile number.
CustomerEmail	string	Customer's email address.
TransactionStatus	string	The status of the transaction (e.g., `SUCCESS`).
UserDefinedField	string	Any custom user-defined field associated with the invoice.
InvoiceValueInBaseCurrency	string	The invoice amount in the base currency.
BaseCurrency	string	The base currency of your MyFatoorah account (e.g., `KWD`).
InvoiceValueInDisplayCurreny	string	The invoice amount in the display currency.
DisplayCurrency	string	The currency used for display.
InvoiceValueInPayCurrency	string	The invoice amount in the payment currency.
PayCurrency	string	The currency used for payment.
DisputeTransactionId	integer	Unique identifier for the dispute transaction.
DisputeType	string	The type of dispute raised (e.g., `CHARGEBACK` - `DOCUMENTREQUEST` - `FRAUDALERT` - `UNVERIFY`).
DisputeStatus	string	The current status of the dispute (e.g., `PENDING - RESOLVED - LOST`).
DisputeChargeBackType	string	The chargeback classification (e.g., `General - Trading - Airways`). Has value only if DisputeType is CHARGEBACK
DisputeReason	string	The reason provided for the dispute. Has value only if DisputeType is CHARGEBACK
InvoiceTransactionId	integer	Identifier of the invoice transaction associated with the dispute.
DisputeCreatedDate	string	The date and time when the dispute was created (`ddMMyyyyHHmmss`).
InvoiceStatus	string	The current status of the invoice (e.g., `PAID`).
InvoiceCreationDate	string	The creation date of the invoice (`ddMMyyyyHHmmss`).
InvoiceExternalIdentifier	string	External identifier associated with the invoice.
TransactionId	string	Unique identifier for the transaction.
TransactionPaymentMethod	string	The payment method used (e.g., `KNET`).
TransactionReferenceId	string	A unique identifier assigned to the transaction for tracking purposes.
TransactionECI	string	The Electronic Commerce Indicator (ECI) code, if available.
TransactionDate	string	The date and time when the transaction was processed (`ddMMyyyyHHmmss`).
TransactionAuthorizationId	string	A unique ID associated with the authorization of the payment.
TransactionTrackId	string	The tracking ID for the payment transaction.
TransactionPaymentId	string	The unique payment ID associated with the transaction.
ServiceChargeVAT	string	The VAT applied to the service charge.
ServiceCharge	string	The service charge applied in base currency.
ReceivableAmount	string	The amount the vendor receives in base currency.

Sample Message

The below sample JSON message is sent by MyFatoorah to your endpoint.

{
  "EventType": 6,
  "Event": "DisputeStatusChanged",
  "DateTime": "09072025170115",
  "CountryIsoCode": "KWT",
  "Data": {
    "InvoiceId": 5901147,
    "InvoiceReference": "2025059473",
    "CustomerReference": "3zfFL6R2rwUadhU4ke3q24nos",
    "CustomerName": "Anonymous",
    "CustomerMobile": "+965",
    "CustomerEmail": "",
    "TransactionStatus": "SUCCESS",
    "UserDefinedField": "",
    "InvoiceValueInBaseCurrency": "150",
    "BaseCurrency": "KWD",
    "InvoiceValueInDisplayCurreny": "150",
    "DisplayCurrency": "KWD",
    "InvoiceValueInPayCurrency": "150",
    "PayCurrency": "KWD",
    "DisputeTransactionId": 114,
    "DisputeType": "CHARGEBACK",
    "DisputeStatus": "PENDING",
    "DisputeChargeBackType": "Trading",
    "DisputeReason": "MerchandiseServiceNotReceived",
    "InvoiceTransactionId": 2827625,
    "DisputeCreatedDate": "09072025170115",
    "InvoiceStatus": "PAID",
    "InvoiceCreationDate": "09072025170013",
    "InvoiceExternalIdentifier": "3zfFL6R2rwUadhU4ke3q24nos",
    "TransactionId": "519010001981715",
    "TransactionPaymentMethod": "KNET",
    "TransactionReferenceId": "519010001100",
    "TransactionECI": "",
    "TransactionDate": "09072025170034",
    "TransactionAuthorizationId": "B20080",
    "TransactionTrackId": "09-07-2025_2827625",
    "TransactionPaymentId": "100519010000017643",
    "ServiceChargeVAT": "0.45",
    "ServiceCharge": "3",
    "ReceivableAmount": "146.55"
  }
}

Webhook Signature

👍
Signature
To generate the signature of this model, you should order only the above parameters alphabetic with its values then encrypt it by the secret key.

The following will be a sample string used in generating the signature.

BaseCurrency=KWD,CustomerEmail=,CustomerMobile=+965,CustomerName=Anonymous,CustomerReference=3zfFL6R2rwUadhU4ke3q24nos,DisplayCurrency=KWD,DisputeChargeBackType=Trading,DisputeCreatedDate=09072025170115,DisputeReason=MerchandiseServiceNotReceived,DisputeStatus=PENDING,DisputeTransactionId=114,DisputeType=CHARGEBACK,InvoiceCreationDate=09072025170013,InvoiceExternalIdentifier=3zfFL6R2rwUadhU4ke3q24nos,InvoiceId=5901147,InvoiceReference=2025059473,InvoiceStatus=PAID,InvoiceTransactionId=2827625,InvoiceValueInBaseCurrency=150,InvoiceValueInDisplayCurreny=150,InvoiceValueInPayCurrency=150,PayCurrency=KWD,ReceivableAmount=146.55,ServiceCharge=3,ServiceChargeVAT=0.45,TransactionAuthorizationId=B20080,TransactionDate=09072025170034,TransactionECI=,TransactionId=519010001981715,TransactionPaymentId=100519010000017643,TransactionPaymentMethod=KNET,TransactionReferenceId=519010001100,TransactionStatus=SUCCESS,TransactionTrackId=09-07-2025_2827625,UserDefinedField=

Overview

Request Model

Sample Message

Webhook Signature

👍Signature

👍
Signature