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