Webhooks can be configured to receive updates on every status change that occurs through the lifecycle of a chargeback.

Chargeback events

Events

Payload

The webhook payload consists of:

data - represents all chargeback fields returned by the get chargeback endpoint
event_type - chargeback events denoted by the format of chargeback.{chargeback_status}

{
    "data": {
        "chargeback_id": "chb_2sOgSgPTWQ8tuxhSn0DeIdLDUjm",
        "payin_id": "pyi_2sOgTXis06bBZ1rvxyqcoBWo1nq",
        // ...
        "status": "INQUIRY_ACTION_REQUIRED",
        // ...
    },
    "event_type": "chargeback.inquiry_action_required"
}

Inquiry action required

Event: chargeback.inquiry_action_required

Triggered when a chargeback is in the inquiry phase and the merchant can respond by providing evidence that the payment was valid.

Field	Description
`chargeback_id`	The unique chargeback identifier.
`payin_id`	The unique payin identifier for the payin associated to the chargeback.
`merchant_id`	`The unique merchant identifier.`
`amount`	The amount of the chargeback, in minor units. Can be less than or equal to the amount of the associated payin.
`currency_code`	Three-letter ISO currency code, in uppercase. Currently, only USD is supported.
`status`	The status of the chargeback, will be `INQUIRY_ACTION_REQUIRED`.
`metadata`	Valid JSON key-value object specified on the associated payin and persisted to the chargeback.
`merchant_fees`	The dispute fee billed to the merchant.
`method_type`	The type of payment method. Valid values are `CARD` and `APPLE_PAY`
`card`	Card payment method details, applicable if the `method_type` is `CARD`.
`apple_pay`	Apple Pay payment method details, applicable if the `method_type` is `APPLE_PAY`.
`reason_code`	The code explaining the reason for the inquiry.
`reason_desc`	The description explaining the dispute reason for the chargeback. This will be a human-readable value that may be presented to the end user.
`acquirer_ref`	Acquirer Reference Number (ARN) is the unique identifier to trace the chargeback with the issuing bank.
`due_date`	Date chargeback times out and will be decisioned as a win or a loss depending on the current status.
`chargeback_evidence`	The types of evidence applicable to respond to the inquiry.
`created_at`	Date and time chargeback was created at in UTC RFC 3339 format.

Inquiry processing

Event: chargeback.inquiry_processing

Triggered when a merchant responds to the inquiry and the cardholder's bank is now decisioning the inquiry.

Field	Description
`chargeback_id`	The unique chargeback identifier.
`status`	The status of the chargeback, will be `INQUIRY_PROCESSING`.
`updated_at`	Date and time chargeback was last updated at in UTC RFC 3339 format.

Dispute action required

Event: chargeback.dispute_action_required

Triggered when a chargeback is in the dispute phase and the merchant can respond by providing evidence that the payment was valid.

Field	Description
`chargeback_id`	The unique chargeback identifier.
`payin_id`	The unique payin identifier for the payin associated to the chargeback.
`status`	The status of the chargeback, will be `DISPUTE_ACTION_REQUIRED`.
`reason_code`	The code explaining the reason for the dispute.
`chargeback_evidence`	The types of evidence applicable to respond to the dispute.
`updated_at`	Date and time chargeback was last updated at in UTC RFC 3339 format.

Chargeback processing

Event: chargeback.chargeback_processing

Triggered when a merchant responds to the dispute and the cardholder's bank is now decisioning the chargeback.

Note: if the chargeback moved from Created to Chargeback Processing, then Rainforest responded to the chargeback on the merchant's behalf. This can occur when the chargeback did not include the necessary information for the merchant to dispute.

Field	Description
`chargeback_id`	The unique chargeback identifier.
`status`	The status of the chargeback, will be `CHARGEBACK_PROCESSING`.
`updated_at`	Date and time chargeback was last updated at in UTC RFC 3339 format.

Provisional win

Event: chargeback.privisional_win

Triggered when a merchant provisionally wins the chargeback, meaning the chargeback can still be lost while the cardholder's bank finalizes their decision. Funds will be returned to the merchant. But if the chargeback's win is reversed and the chargeback moves from Provision Win to Lost, the funds will be pulled back from the merchant.

Field	Description
`chargeback_id`	The unique chargeback identifier.
`status`	The status of the chargeback, will be `PROVISIONAL_WIN`.
`updated_at`	Date and time chargeback was last updated at in UTC RFC 3339 format.

Lost

Event: chargeback.lost

Triggered when a chargeback is ruled in favor of the cardholder and the merchant loses the chargeback. This is final and the merchant cannot overturn this decision.

Field	Description
`chargeback_id`	The unique chargeback identifier.
`status`	The status of the chargeback, will be `LOST`.
`updated_at`	Date and time chargeback was last updated at in UTC RFC 3339 format.

Won

Event: chargeback.won

Triggered when a chargeback is ruled in favor of the merchant and the merchant wins the chargeback. This is final and the cardholder cannot overturn this decision.

Field	Description
`chargeback_id`	The unique chargeback identifier.
`status`	The status of the chargeback, will be `LOST`.
`updated_at`	Date and time chargeback was last updated at in UTC RFC 3339 format.