Skip to main content

Webhooks

Chargeback Webhook Payloads

This page describes the Chargeback webhook payloads in AndDone.

Chargeback Webhook Events

The Chargeback webhook module includes webhook notifications for the following events:

  • Transaction.OnChargeback: This payload notification is sent when a chargeback is processed against a merchant payment transaction. This may occur for reasons including disputes over product quality, unauthorized transactions, or non-compliance with the merchant's terms. The specific reason for the chargeback is indicated in the ReasonCode, Reason, and ReasonDescription fields.

Chargeback Webhook Payload Fields

The following table provides a reference to the fields included in Chargeback webhook payloads.

Field Data Type Description MinLength MaxLength
EventCode Enumeration TransactionChargeback 19 19
EventDateTime string Date/time when the event occurred. 19 19
EventBody object Detailed information related to the transaction. N/A N/A
- MerchantId string Unique identifier of the merchant. 8 8
- MerchantReference string Unique transaction reference ID provided by the merchant. 10 40
- TransactionId string Transaction identifier. 36 36
- TransactionDate string Date and time when the transaction was processed. 19 19
- TimeZone string The time zone in which the transaction date was recorded. 6 20
- Amount float Transaction amount. N/A N/A
- PaymentMethod Enumeration Type of payment used (e.g., ACH). 3 3
- TransactionStatus Enumeration Status of the transaction (e.g., Chargeback). 10 10
- TransactionOrigin Enumeration Origin of the transaction (e.g., WEB, CCD, PPD). 3 3
- SettlementDate string Date on which the transaction funds were settled, if applicable. 19 19
- MaskAccount string A partially masked version of the account number involved in the transaction. 9 17
- RoutingNumber string Bank routing number for the payment. 9 9
- ChargebackAmount float The amount that was charged back. N/A N/A
- ChargedbackDate string Date on which the chargeback was processed. 19 19
- NOCProcessedDate string Date on which a Notification of Change (NOC) related to the transaction was processed, if applicable. 19 19
- CardType string Type of card used in the transaction, if applicable. 3 9
- CardNumber string A partially masked version of the card number used in the transaction, if applicable. 16 16
- ChannelType string The type of channel through which the transaction was conducted. 3 16
- ProcessorAuthCode string Authorization code provided by the payment processor for the transaction, if applicable. 6 20
- Defendable boolean Indicates whether the transaction is defendable in case of a dispute. N/A N/A
- DisputeStatus Enumeration Current status of any dispute related to the transaction (e.g., Lost, Pending). 4 10
- ReasonCode string Code representing the reason for the transaction's return. 2 5
- Reason string Code representing the reason for the transaction's return or chargeback. 1 50
- ReasonDescription string A detailed explanation of the reason for the transaction's chargeback. 1 100
- Success boolean Indicates whether the transaction was successfully processed. N/A N/A
- ErrorMessage string Any error message associated with the transaction, if applicable. 1 100
- CorrectedData string Any corrected data related to the transaction in the case of a Notification of Change, if applicable. 1 100
AdditionalFields string Additional metadata values related to the webhook, if applicable. N/A N/A
Signature string HMAC value used to validate the integrity of the webhook data. 44 44
Version integer Version number of the webhook payload format. 1 1

Payload Example: Transaction Chargeback

{
    "EventCode": "TransactionChargeback",
    "EventDateTime": "04-24-2024 10:22:58",
    "EventBody": {
        "MerchantId": "eZdmqkdQ",
        "MerchantReference": "Title_Tuna_403",
        "TransactionId": "de1b2089-d4ff-4ed8-a9da-a7fde2984d29",
        "TransactionDate": "04-24-2024 10:19:27",
        "TimeZone": "Eastern",
        "Amount": 510.25,
        "PaymentMethod": "ACH",
        "TransactionStatus": "Chargeback",
        "TransactionOrigin": "6",
        "SettlementDate": "04-24-2024 10:19:31",
        "MaskAccount": "****6789",
        "RoutingNumber": "011000138",
        "ChargebackAmount": 50.25,
        "ChargedbackDate": "04/24/2024 14:19:32",
        "NOCProcessedDate": null,
        "CardType": null,
        "CardNumber": null,
        "ChannelType": "ACH",
        "ProcessorAuthCode": null,
        "Defendable": false,
        "DisputeStatus": "Lost",
        "ReasonCode": "23",
        "Reason": "",
        "ReasonDescription": "Dummy Chargeback Testing",
        "Success": true,
        "ErrorMessage": null,
        "CorrectedData": null,
        "Version": 1
    },
    "AdditionalFields": null,
    "Signature": "btba/YRWl+f8vrJBhr9a/jTlMJxnuKXIehK4bm7qcNE=",
    "Version": 1
}