Alerts API Overview
The Chargeflow Alerts API provides merchants with access to pre-chargeback alerts, allowing early visibility into potential disputes before they escalate into full chargebacks. Pre-chargeback alerts are generated by card networks and are made available to you via endpoints and webhook notifications in real time. The API gives you tools to retrieve alerts, check their status and metadata, and monitor their lifecycle through to outcome (whether prevented, escalated, or otherwise resolved).
Pre-Chargeback Alerts Process Flow
- Consumer makes a purchase.
- Consumer makes an inquiry or disputes the purchase with their card issuer.
- Chargeflow receives a pre-chargeback alert: an early notification about the case.
- Chargeflow associates the alert to a merchant, and matches it to a transaction/order.
- Chargeflow resolves the case by automatically refunding the transaction/order.
- Chargeflow determines the outcome and updates the card issuer. The case is resolved without escalation to a chargeback.
Integration Models
The Alerts API can be integrated in two different ways, depending on how much control you want to have over the refund process:
1. Chargeflow Alerts (most common)
In this model, Chargeflow automates the handling of alerts (including transaction matching and refunds where applicable).
- Merchants and platforms act as passive consumers of the API. You can build additional automations based on the webhooks, such as automated consumer tagging, automated subscription cancallation and more.
- The Alerts API and webhooks serve as an informational layer, allowing you to:
- Retrieve alerts and outcomes via the API.
- Embed alert data into your own dashboards, reports, or customer portals.
- Receive event notifications for alert creation or outcome updates, without needing to perform any manual actions.
- This option requires minimal development effort, since Chargeflow executes the mitigation flow end-to-end.
2. Merchant-Managed Handling
In this model, Chargeflow provides the alerts, but refund actions are executed by the merchant or platform.
- Chargeflow delivers alerts via the
alerts.createdwebhook. - If transaction linking is required, you may also subscribe to the
alerts.transaction.linkedwebhook. - Upon receiving an alert, your system is responsible for:
- Locating and validating the corresponding transaction.
- Performing the refund (or other mitigation) within your payment processor or order management system.
- Updating Chargeflow with the final outcome using the Alert Outcome Update endpoint (
POST /alerts/{id}/outcome). This ensures Chargeflow can report back to the issuer correctly so the chargeback will be prevented.
This option gives the merchant or platform full control over refunds and operational logic, but requires additional implementation and monitoring to ensure outcomes are updated reliably.
Available Endpoints
| Endpoint | Method | Description |
|---|---|---|
GET /alerts | GET | Retrieve a paginated list of all alerts associated with your account. Supports filtering by date, type, status, and reason. |
GET /alerts/{id} | GET | Retrieve full details of a specific alert by its ID, including status, outcome and transaction details. |
POST /alerts/{id}/outcome | POST | Update the outcome for a specific alert. Required for Merchant-Managed Handling alerts. |
Available Webhooks
| Webhook | Trigger | Description |
|---|---|---|
alerts.created | A new pre-chargeback alert is received | Sends an HTTP POST to your configured endpoint with the alert ID and metadata. Use this to initiate refunds or other mitigation actions. |
alerts.transaction.linked | Chargeflow matches an alert to a transaction | Sends an HTTP POST with the alert ID and matched transaction ID. Useful if you require transaction-level data for your automated processes. |
alerts.outcome.updated | The outcome of an alert is updated | Sends an HTTP POST with the updated outcome and timestamp. |
Updated about 7 hours ago