# Chargeflow Documentation > Chargeflow is a chargeback and dispute automation platform. These docs cover the merchant API (dispute automation, enrichment, pre-chargeback alerts, webhooks), the platforms API (Connect: Evidence-as-a-Service, Co-Branded, and the White-Label portal), the versioned API reference, and shared fundamentals. Every page below is also available as plain markdown by appending `.md` to its URL. The entire docs corpus in one file: https://0.0.0.0:3000/llms-full.txt ## For Merchants - [Chargeback Dispute Automation API for Merchants | Chargeflow Docs](https://0.0.0.0:3000/docs/merchants/overview.md): What the merchant docs cover - dispute Automation end to end, plus Alerts and Prevent - and how Chargeflow builds and submits a dispute response. - [Chargeflow API Quickstart: Authenticate & Automate Your First Dispute](https://0.0.0.0:3000/docs/merchants/quickstart.md): Five steps to a working integration: get an API key, validate it, list disputes, enrich one via PATCH, and register a dispute.created webhook. - [Chargeflow Prevent: Pre-Fulfillment Chargeback Risk Scoring](https://0.0.0.0:3000/docs/merchants/prevent.md): Post-purchase, pre-fulfillment fraud prevention - every order gets a risk score and a recommended action (approve, verify, or cancel) before you ship. - [Chargeflow Alerts: Pre-Chargeback Deflection via Verifi & Ethoca](https://0.0.0.0:3000/docs/merchants/alerts.md): Deflect disputes before they become chargebacks with Verifi RDR, CDRN, and Ethoca alerts - retrieve alerts, track outcomes, and automate resolution. - [Alerts API Reference: Manage Pre-Chargeback Alerts (Verifi & Ethoca)](https://0.0.0.0:3000/docs/merchants/alerts/manage-alerts.md): The Alerts API: Chargeflow-automated versus merchant-managed handling, alert endpoints and webhooks, the refund-and-report flow, and outcome vocabularies. - [How to Deflect Chargebacks Before They Post, Using Alerts](https://0.0.0.0:3000/docs/merchants/alerts/prevent-with-alerts.md): Subscribe to pre-chargeback alerts, receive an alert, refund the transaction, and report the outcome to close the alert. - [Chargeflow Automation: Agentic Dispute Representment API](https://0.0.0.0:3000/docs/merchants/automation.md): Agentic dispute representment - Chargeflow ingests every dispute, builds the evidence, and submits the response; enrich it with your data via the API. - [Automate Dispute Management End to End | Chargeflow API](https://0.0.0.0:3000/docs/merchants/automation/automate-dispute-management.md): Where your integration plugs into Chargeflow's automation pipeline: subscribe to dispute.created, then send a second enrichment and track the outcome via the API. - [Enrich a Dispute: The PATCH Endpoint Explained](https://0.0.0.0:3000/docs/merchants/automation/enrich-a-dispute.md): The PATCH dispute endpoint: upsert semantics, array merge behavior, inline data creation versus linking existing objects, and the response shape. - [Enrich Disputes with Subscription Data for SaaS Chargebacks](https://0.0.0.0:3000/docs/merchants/automation/enrich-a-dispute/subscription-data.md): Evidence for SaaS and recurring-billing disputes: subscription fields, customer activity logs (sign-up, login, purchase events), and communication records. - [Log Customer Communications on a Dispute (API Guide)](https://0.0.0.0:3000/docs/merchants/automation/enrich-a-dispute/customer-communications.md): The customer-communication endpoint: request and message fields for logging support conversations as structured records linked to one or more disputes. - [Enrich Disputes with Order & Fulfillment Data for E-Commerce](https://0.0.0.0:3000/docs/merchants/automation/enrich-a-dispute/ecommerce-data.md): Evidence fields for physical-goods disputes: order products, fulfillment tracking, shipping address, and subscription data sent via the PATCH dispute endpoint. - [Industry Enrichment](https://0.0.0.0:3000/docs/merchants/automation/enrich-a-dispute/by-industry.md): Enrich a dispute with a single PATCH using an industry-specific universal_order block, plus the universal fields, domain lookup, and errors for every vertical. - [Upload Dispute Evidence via API | Chargeflow Docs](https://0.0.0.0:3000/docs/merchants/automation/upload-evidence.md): The multipart evidence upload endpoint: evidenceUploadCategory values, the conditional content field, supported file types, and the 5 MB size limit. - [Subscribe to Chargeflow Webhook Events: Setup & Verification](https://0.0.0.0:3000/docs/merchants/automation/subscribe-to-events.md): Register, list, and delete webhook endpoints via the API, the four available event types, and an example Express handler that acknowledges before processing. - [Automate a Chargeback Dispute Response: Full API Recipe](https://0.0.0.0:3000/docs/merchants/automation/automate-a-chargeback-dispute.md): Receive a dispute.created webhook for any processor, fetch the dispute, attach evidence and notes, and let Chargeflow build and submit the representment for you. - [Backfill 90 Days of Disputes via the Chargeflow API](https://0.0.0.0:3000/docs/merchants/automation/backfill-90-days.md): Page through GET /disputes to pull every dispute from the last 90 days into your own system. - [No-Code Dispute Automation via Zapier | Chargeflow](https://0.0.0.0:3000/docs/merchants/automation/zapier-no-code.md): Step-by-step setup of a Zapier Zap using the Chargeflow New Dispute trigger, from API key generation to mapping dispute fields into action steps. - [Insights](https://0.0.0.0:3000/docs/merchants/insights.md): Performance monitoring for payments and chargebacks - one dashboard across every connected processor, with proactive alerts when a ratio moves toward a threshold. - [Chargeflow Merchant Webhook Events: dispute.created & Alerts Events](https://0.0.0.0:3000/docs/merchants/webhook-events/overview.md): The four merchant webhook events - dispute.created and the three alerts events - with when each fires, what to do, and where to find the payload. - [Interactive tutorials](https://0.0.0.0:3000/docs/merchants/interactive-tutorials.md): Runnable, step-by-step tutorials for merchant integrations, coming soon. - [Sandbox](https://0.0.0.0:3000/docs/merchants/sandbox.md): An isolated test environment for merchant integrations is coming soon. ## For Platforms - [Chargeflow Connect: EaaS, Co-Branded & White-Label Dispute API for Platforms](https://0.0.0.0:3000/docs/platforms/overview.md): Chargeflow Connect ("Chargeflow for Platforms") - the four delivery models for ISVs, platforms and PSPs - Evidence-as-a-Service, Co-Branded, White-Label (beta), and Alerts-as-a-Service (Soon). - [Platforms Quickstart: Integrate Chargeflow Evidence-as-a-Service](https://0.0.0.0:3000/docs/platforms/quickstart.md): Generate your first AI dispute evidence package as a platform, from API key to bank-ready PDF, in four steps. - [Run Connect](https://0.0.0.0:3000/docs/platforms/connect.md): The Connect dashboard - onboard merchants, route their disputes automatically, and report on recovery, in five steps. - [Merchants](https://0.0.0.0:3000/docs/platforms/connect/merchants.md): Your merchant pipeline in Connect - invite or activate merchants, link their processor accounts, and track dispute activity and recovery performance per merchant. - [Disputes](https://0.0.0.0:3000/docs/platforms/connect/disputes.md): Every dispute across every merchant in Connect - statuses, filters, the evidence PDF and its version history, and viewing a dispute as the merchant sees it. - [Integrations](https://0.0.0.0:3000/docs/platforms/connect/integrations.md): Connect payment processors to Connect so disputes route in automatically - the smart PSP flow, merchant attribution, reconnecting, and enabling Evidence-as-a-Service. - [Widgets](https://0.0.0.0:3000/docs/platforms/connect/widgets.md): Embed pre-built Chargeflow widgets showing real-time dispute data inside your own platform dashboard, from the widget catalog or the dashboard builder. - [Workflows](https://0.0.0.0:3000/docs/platforms/connect/workflows.md): Design how disputes move through your platform on a visual canvas - webhook triggers, API calls, conditions, widget actions, and Chargeflow engine actions, with presets to start from. - [Developers](https://0.0.0.0:3000/docs/platforms/connect/developers.md): Production and sandbox API keys, HMAC enforcement, and webhook endpoint registration for a Connect platform account. - [Settings](https://0.0.0.0:3000/docs/platforms/connect/settings.md): Platform branding for the co-branded header, team management, and role-based permissions in Connect. - [What Is Evidence-as-a-Service (EaaS)? | Chargeflow for Platforms](https://0.0.0.0:3000/docs/platforms/eaas/introduction.md): Evidence-as-a-Service turns dispute data into a bank-ready, versioned PDF evidence package via API - a platform-level integration for B2B platforms and PSPs. - [How Evidence-as-a-Service Works: API, Webhook & PDF Delivery](https://0.0.0.0:3000/docs/platforms/eaas/how-it-works.md): End-to-end EaaS setup - get a Connect account, generate API keys, subscribe to evidence webhooks, create merchant entities, and pick an integration pattern. - [Set up EaaS](https://0.0.0.0:3000/docs/platforms/eaas/setup.md): The eight-step Evidence-as-a-Service setup, in the same order as the in-app guide - keys, merchants, dispute data, enrichment, generation, retrieval, submission, and outcome reporting. - [Submit Platform Disputes via the EaaS API](https://0.0.0.0:3000/docs/platforms/eaas/submit-platform-disputes.md): Create dispute records in Chargeflow from your platform - request fields, dispute reason values, and how to enrich or generate evidence afterward. - [Generate & Regenerate Evidence via the EaaS API](https://0.0.0.0:3000/docs/platforms/eaas/generate-and-regenerate.md): Call the Generate Evidence API with a dispute ID or inline dispute data, handle its error codes, and regenerate versioned evidence PDFs as new data arrives. - [Generate Bank-Ready Evidence in Seconds with EaaS](https://0.0.0.0:3000/docs/platforms/eaas/generate-evidence-in-10s.md): Use Evidence-as-a-Service to turn dispute data into a bank-ready PDF, then download it when the evidence.ready webhook fires. - [EaaS Data Privacy & Security for Platforms](https://0.0.0.0:3000/docs/platforms/eaas/compliance.md): EaaS data handling - 7-day expiring PDF download links, data minimization, regional data residency, and SOC 2 Type II and GDPR compliance. - [White-Label Chargeback Disputes: Chargeflow Embedded for Platforms](https://0.0.0.0:3000/docs/platforms/chargeflow-embedded/overview.md): White-Label Connect - your product name, UI and pricing, with Chargeflow ingesting, enriching and submitting merchant disputes end to end. Includes a comparison with EaaS. - [White-Label Integration Guide: Accounts, Keys & Webhooks](https://0.0.0.0:3000/docs/platforms/chargeflow-embedded/integration-guide.md): Set up White-Label Connect - create your platform account, generate API keys, register webhooks, connect merchant integrations, and handle disputes. - [Onboard a Merchant to Chargeflow Connect (API Guide)](https://0.0.0.0:3000/docs/platforms/guides/onboard-a-merchant.md): Create a Chargeflow account entity for each merchant via the Accounts API - required and optional fields, plus enrichments for stronger evidence strategies. - [Manage Merchant Accounts via the Chargeflow Platforms API](https://0.0.0.0:3000/docs/platforms/guides/manage-accounts.md): Retrieve a merchant's Chargeflow account by ID with the GET accounts endpoint, including path parameters and example request and response. - [Monitor Integration Health for Chargeflow Connect](https://0.0.0.0:3000/docs/platforms/guides/monitor-integration-health.md): Use the health-check endpoints to verify the Chargeflow API is reachable and your API key is valid, for uptime monitoring and pre-flight checks. - [Chargeflow Platforms Webhook Events Reference](https://0.0.0.0:3000/docs/platforms/webhook-events/overview.md): The platform webhook events - evidence.ready, evidence.error, and integration.access.error - with when each fires, what to do, and where to find the payload. - [Partner Studio: Manage Your Chargeflow Connect Integration](https://0.0.0.0:3000/docs/platforms/partner-studio/overview.md): Partner Studio is a gated workspace for active and POC platform partners - demos, enablement, white-label config, advanced EaaS, and runbooks. The tooling is on the way; access is granted per platform. - [Interactive tutorials](https://0.0.0.0:3000/docs/platforms/interactive-tutorials.md): Runnable, step-by-step tutorials for platform integrations, coming soon. - [Sandbox](https://0.0.0.0:3000/docs/platforms/sandbox.md): An isolated test environment for platform and EaaS integrations is coming soon. ## API Reference - [API Reference - v2025-04-01](https://0.0.0.0:3000/docs/api/2025-04-01.md): Current version of the Chargeflow REST API - [Get started](https://0.0.0.0:3000/docs/api/2025-04-01/get-started.md): Start here for the Chargeflow REST API: base URL, versions, API keys, HMAC, pagination, errors, rate limits, and a first call that returns a response. - [Health Check](https://0.0.0.0:3000/docs/api/2025-04-01/merchants/health-check.md): API health check endpoints - [Validate Access Key](https://0.0.0.0:3000/docs/api/2025-04-01/merchants/health-check/public/2025-04-01/health-check/access-key/get.md) - [Service Health Verification](https://0.0.0.0:3000/docs/api/2025-04-01/merchants/health-check/public/2025-04-01/health-check/get.md) - [Disputes](https://0.0.0.0:3000/docs/api/2025-04-01/merchants/disputes.md): Disputes management endpoints - [Get Disputes](https://0.0.0.0:3000/docs/api/2025-04-01/merchants/disputes/public/2025-04-01/disputes/get.md): Retrieves a list of disputes based on the provided pagination parameters - [Get Dispute by ID](https://0.0.0.0:3000/docs/api/2025-04-01/merchants/disputes/public/2025-04-01/disputes/disputeid/get.md): Retrieve a single dispute details with the option to `expand` it with enriched data using the `expand` request parameter. - [Enrich Dispute](https://0.0.0.0:3000/docs/api/2025-04-01/merchants/disputes/public/2025-04-01/disputes/disputeid/patch.md): Enrich a dispute with additional data to improve your chances of winning. This endpoint allows you to freely enrich the dispute with as much relevant information as needed, including transaction data, order data, subscription data, and more. NOTE: When updating array properties, the entire array wi… - [Update Dispute Order](https://0.0.0.0:3000/docs/api/2025-04-01/merchants/disputes/public/2025-04-01/disputes/disputeid/order/post.md): Update the order associated with a dispute. ⚠️ Soon to be deprecated ⚠️ - [Upload Evidence](https://0.0.0.0:3000/docs/api/2025-04-01/merchants/disputes/public/2025-04-01/disputes/disputeid/evidence/post.md): The Submit Additional Evidence API allows you to upload supporting documents for a dispute, strengthening your chargeback response. - [Alerts](https://0.0.0.0:3000/docs/api/2025-04-01/merchants/alerts.md): Alerts related endpoints - [Get Alerts](https://0.0.0.0:3000/docs/api/2025-04-01/merchants/alerts/public/2025-04-01/alerts/get.md): The **Get Alerts** endpoint is available exclusively for Chargeflow Alerts customers. It provides real-time visibility into potential chargeback events before they escalate into full disputes. When you call this endpoint, you'll receive all pre-chargeback alerts associated with your account, includ… - [Get Alert By ID](https://0.0.0.0:3000/docs/api/2025-04-01/merchants/alerts/public/2025-04-01/alerts/alertid/get.md): The **Get Alert by ID** endpoint is available exclusively for Chargeflow Alerts customers. It allows you to retrieve detailed information about a specific pre-chargeback alert using its unique identifier. When you call this endpoint, you'll receive the full alert object, including its status, type,… - [Update Alert Outcome](https://0.0.0.0:3000/docs/api/2025-04-01/merchants/alerts/public/2025-04-01/alerts/alertid/outcome/post.md): The **Update Alert Outcome** endpoint allows merchants and platforms who manage refunds themselves to notify Chargeflow of the final outcome for a given alert. Updating the outcome ensures Chargeflow can report back to the alert provider (Verifi & Ethoca) and prevent escalation to a chargeback. Thi… - [Transaction](https://0.0.0.0:3000/docs/api/2025-04-01/merchants/transaction.md) - [Create Transaction](https://0.0.0.0:3000/docs/api/2025-04-01/merchants/transaction/public/2025-04-01/disputes/disputeid/transaction/post.md): Creates a transaction in Chargeflow that can be used to enrich a dispute. - [Subscription](https://0.0.0.0:3000/docs/api/2025-04-01/merchants/subscription.md): Subscription management endpoints - [Create Subscription](https://0.0.0.0:3000/docs/api/2025-04-01/merchants/subscription/public/2025-04-01/disputes/disputeid/subscription/post.md): Creates a subscription in Chargeflow that can be used to enrich a dispute. - [Customer Communication](https://0.0.0.0:3000/docs/api/2025-04-01/merchants/customer-communication.md): Customer communication endpoints - [Create Customer Communication](https://0.0.0.0:3000/docs/api/2025-04-01/merchants/customer-communication/public/2025-04-01/customer-communication/post.md): Creates a customer communication ticket in Chargeflow that can be used to enrich a dispute. - [User Event Log](https://0.0.0.0:3000/docs/api/2025-04-01/merchants/user-event-log.md) - [Create User Event Log](https://0.0.0.0:3000/docs/api/2025-04-01/merchants/user-event-log/public/2025-04-01/disputes/disputeid/user_events_log/post.md): Creates an user events log in Chargeflow that can be used to enrich a dispute. - [Webhooks Management](https://0.0.0.0:3000/docs/api/2025-04-01/merchants/webhooks-management.md): Webhook configuration and management - [Create Webhook](https://0.0.0.0:3000/docs/api/2025-04-01/merchants/webhooks-management/public/2025-04-01/webhooks/post.md): The Create Webhook API allows you to register a webhook for a specific event type and URL target. - [Get Webhooks](https://0.0.0.0:3000/docs/api/2025-04-01/merchants/webhooks-management/public/2025-04-01/webhooks/get.md): The Get All Webhooks API allows you to retrieve all webhook registrations for a specific chargeflowId. - [Delete Webhook](https://0.0.0.0:3000/docs/api/2025-04-01/merchants/webhooks-management/public/2025-04-01/webhooks/id/delete.md): The Delete Webhook API allows you to delete a webhook registration by providing the webhook ID. - [Webhooks Events](https://0.0.0.0:3000/docs/api/2025-04-01/merchants/webhooks-events.md): Webhook event notifications - [Dispute Created Event](https://0.0.0.0:3000/docs/api/2025-04-01/merchants/webhooks-events/dispute.created.md) - [Alerts Created Event](https://0.0.0.0:3000/docs/api/2025-04-01/merchants/webhooks-events/alerts.created.md): The **Alert Created** webhook is available exclusively for Chargeflow Alerts customers. It notifies your system in real time whenever a new pre-chargeback alert is created for your account. When a new alert is received by Chargeflow, the webhook sends an HTTP `POST` request to your configured endpo… - [Alert Transaction Linked Event](https://0.0.0.0:3000/docs/api/2025-04-01/merchants/webhooks-events/alerts.transaction.linked.md): The **Alert Transaction Linked** webhook is available exclusively for Chargeflow Alerts customers. It notifies your system in real time whenever Chargeflow successfully matches a pre-chargeback alert to a transaction in your payment processor. When this occurs, the webhook sends an HTTP POST reques… - [Alerts Outcome Updated Event](https://0.0.0.0:3000/docs/api/2025-04-01/merchants/webhooks-events/alerts.updated.md): The **Alert Outcome Updated** webhook `(alerts.outcome.updated)` is available exclusively for Chargeflow Alerts customers. It notifies your system whenever the outcome of handling a pre-chargeback alert changes. The **outcome** field describes the result of Chargeflow's attempt to process the alert… - [Data Subject](https://0.0.0.0:3000/docs/api/2025-04-01/merchants/data-subject.md) - [Create Data Subject Removal Request](https://0.0.0.0:3000/docs/api/2025-04-01/merchants/data-subject/public/2025-04-01/data-subject/removal/post.md): Creates a GDPR data subject removal request for the specified email address. - [Get Removal Request Status](https://0.0.0.0:3000/docs/api/2025-04-01/merchants/data-subject/public/2025-04-01/data-subject/removal/requestid/get.md): Retrieves the status of a data subject removal request. - [Accounts](https://0.0.0.0:3000/docs/api/2025-04-01/platforms/accounts.md): Accounts related endpoints - [Create Account](https://0.0.0.0:3000/docs/api/2025-04-01/platforms/accounts/public/2025-04-01/accounts/post.md): Creates a new Chargeflow account and allow your merchants to log in and use Chargeflow. - [Get Account By ID](https://0.0.0.0:3000/docs/api/2025-04-01/platforms/accounts/public/2025-04-01/accounts/accountid/get.md): Retrieve a single account details. - [Merchants Disputes](https://0.0.0.0:3000/docs/api/2025-04-01/platforms/merchants-disputes.md): Merchants disputes management endpoints - [Create Dispute](https://0.0.0.0:3000/docs/api/2025-04-01/platforms/merchants-disputes/public/2025-04-01/platform/disputes/post.md): Creates a dispute in Chargeflow that can either be viewed through the Chargeflow platform or managed by Chargeflow. - [Evidence](https://0.0.0.0:3000/docs/api/2025-04-01/platforms/evidence.md): Evidence management endpoints - [Generate Evidence](https://0.0.0.0:3000/docs/api/2025-04-01/platforms/evidence/public/2025-04-01/evidence/post.md): Instantly generate high-quality, AI-powered evidence in a PDF format tailored for dispute response. - [Get Evidence by ID](https://0.0.0.0:3000/docs/api/2025-04-01/platforms/evidence/public/2025-04-01/evidence/evidenceid/get.md): Retrieve a single evidence file details with the option to expand it with enriched dispute data using the expand request parameter. - [Webhooks Events](https://0.0.0.0:3000/docs/api/2025-04-01/platforms/webhooks-events.md): Webhook event notifications - [Integration Access Error Event](https://0.0.0.0:3000/docs/api/2025-04-01/platforms/webhooks-events/integration.access.error.md) - [Evidence Ready Event](https://0.0.0.0:3000/docs/api/2025-04-01/platforms/webhooks-events/evidence.ready.md) - [Evidence Error Event](https://0.0.0.0:3000/docs/api/2025-04-01/platforms/webhooks-events/evidence.error.md) - [Dispute Created Event](https://0.0.0.0:3000/docs/api/2025-04-01/platforms/webhooks-events/dispute.created.md) - [Migrate from 2024-03-18 to 2025-04-01](https://0.0.0.0:3000/docs/api/2025-04-01/migration.md): A field-by-field guide to moving your Chargeflow integration from API version 2024-03-18 to 2025-04-01, based on the published OpenAPI specs. - [API Reference - v2024-03-18](https://0.0.0.0:3000/docs/api/2024-03-18.md): Legacy version of the Chargeflow REST API - [Health Check](https://0.0.0.0:3000/docs/api/2024-03-18/merchants/health-check.md): API health check endpoints - [Service Health Verification](https://0.0.0.0:3000/docs/api/2024-03-18/merchants/health-check/public/2024-03-18/health-check/get.md) - [Validate Access Key](https://0.0.0.0:3000/docs/api/2024-03-18/merchants/health-check/public/2024-03-18/health-check/access-key/get.md) - [Disputes](https://0.0.0.0:3000/docs/api/2024-03-18/merchants/disputes.md): Disputes management endpoints - [Get Disputes](https://0.0.0.0:3000/docs/api/2024-03-18/merchants/disputes/public/2024-03-18/disputes/get.md): Note: This endpoint is not supported for platforms. Please use the new endpoint at /public/2025-04-01/disputes - [Create Dispute](https://0.0.0.0:3000/docs/api/2024-03-18/merchants/disputes/public/2024-03-18/disputes/post.md) - [Update Dispute Order](https://0.0.0.0:3000/docs/api/2024-03-18/merchants/disputes/public/2024-03-18/disputes/disputeid/order/post.md) - [Upload Evidence](https://0.0.0.0:3000/docs/api/2024-03-18/merchants/disputes/public/2024-03-18/disputes/disputeid/evidence/post.md) - [Webhooks Management](https://0.0.0.0:3000/docs/api/2024-03-18/merchants/webhooks-management.md): Webhook configuration and management - [Create Webhook](https://0.0.0.0:3000/docs/api/2024-03-18/merchants/webhooks-management/public/2024-03-18/webhooks/post.md) - [Get All Webhooks](https://0.0.0.0:3000/docs/api/2024-03-18/merchants/webhooks-management/public/2024-03-18/webhooks/get.md) - [Delete Webhook](https://0.0.0.0:3000/docs/api/2024-03-18/merchants/webhooks-management/public/2024-03-18/webhooks/id/delete.md) - [Webhooks Events](https://0.0.0.0:3000/docs/api/2024-03-18/merchants/webhooks-events.md): Webhook event notifications - [Dispute Created Event](https://0.0.0.0:3000/docs/api/2024-03-18/merchants/webhooks-events/dispute.created.md) - [Alerts Created Event](https://0.0.0.0:3000/docs/api/2024-03-18/merchants/webhooks-events/alerts.created.md): The **Alert Created** webhook is available exclusively for Chargeflow Alerts customers. It notifies your system in real time whenever a new pre-chargeback alert is created for your account. When a new alert is received by Chargeflow, the webhook sends an HTTP `POST` request to your configured endpo… - [Alert Transaction Linked Event](https://0.0.0.0:3000/docs/api/2024-03-18/merchants/webhooks-events/alerts.transaction.linked.md): The **Alert Transaction Linked** webhook is available exclusively for Chargeflow Alerts customers. It notifies your system in real time whenever Chargeflow successfully matches a pre-chargeback alert to a transaction in your payment processor. When this occurs, the webhook sends an HTTP POST reques… - [Alerts Outcome Updated Event](https://0.0.0.0:3000/docs/api/2024-03-18/merchants/webhooks-events/alerts.updated.md): The **Alert Outcome Updated** webhook `(alerts.outcome.updated)` is available exclusively for Chargeflow Alerts customers. It notifies your system whenever the outcome of handling a pre-chargeback alert changes. The **outcome** field describes the result of Chargeflow's attempt to process the alert… - [Disputes](https://0.0.0.0:3000/docs/api/2024-03-18/platforms/disputes.md): Disputes management endpoints - [Get Disputes](https://0.0.0.0:3000/docs/api/2024-03-18/platforms/disputes/public/2024-03-18/disputes/get.md): Note: This endpoint is not supported for platforms. Please use the new endpoint at /public/2025-04-01/disputes - [Create Dispute](https://0.0.0.0:3000/docs/api/2024-03-18/platforms/disputes/public/2024-03-18/disputes/post.md) - [Update Dispute Order](https://0.0.0.0:3000/docs/api/2024-03-18/platforms/disputes/public/2024-03-18/disputes/disputeid/order/post.md) - [Webhooks Events](https://0.0.0.0:3000/docs/api/2024-03-18/platforms/webhooks-events.md): Webhook event notifications - [Integration Access Error Event](https://0.0.0.0:3000/docs/api/2024-03-18/platforms/webhooks-events/integration.access.error.md) - [Evidence Ready Event](https://0.0.0.0:3000/docs/api/2024-03-18/platforms/webhooks-events/evidence.ready.md) - [Evidence Error Event](https://0.0.0.0:3000/docs/api/2024-03-18/platforms/webhooks-events/evidence.error.md) - [Dispute Created Event](https://0.0.0.0:3000/docs/api/2024-03-18/platforms/webhooks-events/dispute.created.md) ## Resources - [Chargeflow Developer Resources: Concepts, API Fundamentals & Tools](https://0.0.0.0:3000/docs/reference/overview.md): What lives in Resources and who each page is for: concepts, API fundamentals, integrations, tools, error codes, security, FAQ, and support. - [Chargeback Lifecycle Explained: From Cardholder Dispute to Issuer Decision](https://0.0.0.0:3000/docs/reference/concepts/chargeback-lifecycle.md): The parties in the payment ecosystem and how a dispute moves from a cardholder complaint to a final decision. - [How recovery works](https://0.0.0.0:3000/docs/reference/concepts/how-recovery-works.md): End to end, what happens between a dispute being filed and the money coming back: ingestion, data collection, enrichment, the automation layer, submission, outcome, and the feedback loop. - [How our AI works](https://0.0.0.0:3000/docs/reference/concepts/how-our-ai-works.md): The domain approach behind Chargeflow's evidence agents: an industry-agnostic data foundation, then dispute execution by an orchestrator delegating to specialised agents with a QA agent in front of submission. - [Evidence generation](https://0.0.0.0:3000/docs/reference/concepts/evidence-generation.md): How Chargeflow builds a dispute response: written from scratch by multiple specialised agents rather than filled into templates, QA'd by an AI agent, aligned to card scheme rules, and tuned by the outcome of every win and loss. - [Evidence examples by reason code](https://0.0.0.0:3000/docs/reference/concepts/evidence-examples.md): Worked examples of what Chargeflow collects and argues per reason code, starting with Visa Compelling Evidence 3.0 fraud and Visa 13.1 item not received. - [Dispute State Machine: Statuses & Transitions Reference](https://0.0.0.0:3000/docs/reference/concepts/dispute-state-machine.md): Dispute stages and statuses modeled as a state machine, with the valid transitions between them. - [Chargeback Reason Codes Mapped to Chargeflow Categories](https://0.0.0.0:3000/docs/reference/concepts/reason-codes.md): How card network reason codes map to Chargeflow's reason categories, and what each category means. - [Representment & Evidence: How a Chargeback Rebuttal Works](https://0.0.0.0:3000/docs/reference/concepts/representment-and-evidence.md): What representment is, how the rebuttal process works, and the evidence categories that win disputes. - [Card Network Dispute Response Timelines (Visa, Mastercard, Amex)](https://0.0.0.0:3000/docs/reference/concepts/network-timelines.md): Dispute response windows by card network, including filing windows, merchant response windows, and arbitration. - [Visa Compelling Evidence 3.0 (CE 3.0) Eligibility Explained](https://0.0.0.0:3000/docs/reference/concepts/ce-3.0-eligibility.md): What Visa Compelling Evidence 3.0 is, the eligibility criteria, and the prior-transaction data points it requires. - [Alerts Integration Models: Merchant-Managed vs Chargeflow-Managed](https://0.0.0.0:3000/docs/reference/concepts/alerts-model.md): How pre-chargeback alerts from Ethoca and Verifi prevent chargebacks, and the two integration models for handling them. - [How the Chargeflow Dispute Automation Engine Works](https://0.0.0.0:3000/docs/reference/concepts/dispute-automation.md): How Chargeflow's agentic engine ingests disputes, enriches evidence, generates and submits responses, and tracks each case through its lifecycle. - [Chargeflow Webhooks: Events, Payloads & Verification](https://0.0.0.0:3000/docs/reference/concepts/webhooks.md): Register webhook endpoints, verify HMAC signatures, build an event handler, and see the event topics Chargeflow can send to your system. - [Chargeflow API Versioning: How Date-Based Versions Work](https://0.0.0.0:3000/docs/reference/concepts/api-versioning.md): How Chargeflow's date-based path versioning works, the deprecation policy, and the table of available API versions. - [Chargeflow API Authentication: API Keys & HMAC Signatures](https://0.0.0.0:3000/docs/reference/api-fundamentals/authentication.md): Authenticate Chargeflow API requests with the x-api-key header, plus optional HMAC-SHA256 signature validation for integrity and authenticity. - [Chargeflow API Test Credentials & Sandbox Access](https://0.0.0.0:3000/docs/reference/api-fundamentals/test-credentials.md): How to generate and use Chargeflow API keys, and what the secret key is for. - [Chargeflow API Pagination: offset & limit Parameters](https://0.0.0.0:3000/docs/reference/api-fundamentals/pagination.md): Page through list endpoints with offset and limit. - [Chargeflow API Error Handling: Retry Logic & Backoff](https://0.0.0.0:3000/docs/reference/api-fundamentals/error-handling.md): HTTP error codes returned by the Chargeflow API, what causes each one, how to resolve them, and the health check endpoint for verifying your key. - [Rate Limits](https://0.0.0.0:3000/docs/reference/api-fundamentals/rate-limits.md): Handle 429 Too Many Requests responses with exponential backoff and the Retry-After header. Full rate limit documentation is in progress. - [Idempotency](https://0.0.0.0:3000/docs/reference/api-fundamentals/idempotency.md): Use the Idempotency-Key header on evidence generation requests to retry safely without creating duplicates. Full documentation is in progress. - [Chargeflow API Go-Live Checklist: Production Readiness Steps](https://0.0.0.0:3000/docs/reference/api-fundamentals/go-live-checklist.md): Production readiness steps for your Chargeflow integration, covering keys, PII, webhook verification, idempotency, errors, and rate limits. - [Chargeflow Integrations: Stripe, PayPal, Shopify, WooCommerce & Zapier](https://0.0.0.0:3000/docs/reference/integrations.md): Every tool Chargeflow connects to, by category: payment processors that route disputes in, eCommerce and subscription platforms that enrich evidence, customer communication tools that supply conversation history, and the alert networks that deflect disputes pre-chargeback. - [Chargeflow Developer Tools: OpenAPI Spec, Postman, SDKs & MCP Server](https://0.0.0.0:3000/docs/reference/tools.md): The Chargeflow developer tools - OpenAPI specs, client libraries, a Postman path, the hosted AI skill for agents, plus the interactive and testing tools that are on the way. - [Chargeflow API Error Codes Reference](https://0.0.0.0:3000/docs/reference/error-codes.md): Lookup table of HTTP status codes and EaaS-specific error codes returned by the Chargeflow API, with causes and resolutions. - [Chargeflow API Changelog: Version History & Release Notes](https://0.0.0.0:3000/docs/reference/changelog.md): Release history for each dated Chargeflow API version, listing the endpoints and payload changes introduced in 2024-03-18 and 2025-04-01. - [Chargeflow API Status & Incident History](https://0.0.0.0:3000/docs/reference/status.md): Where to check the live status of the Chargeflow API and how to get help during an incident. - [Chargeflow Security & Compliance: SOC 2 Type II, GDPR & Data Protection](https://0.0.0.0:3000/docs/reference/security.md): How Chargeflow secures your data, our certifications (SOC 2 Type II, GDPR), data residency, subprocessors, AI governance, and where to request security documents. - [Chargeflow API FAQ: Authentication, Webhooks, Disputes & Security](https://0.0.0.0:3000/docs/reference/faq.md): Common questions about getting started, authentication, environments, common API errors, webhooks, disputes, alerts, Prevent, API versioning, security, data privacy, and how Chargeflow operates, with links to the canonical docs. - [Chargeflow API Support: Get Help & Check Live Status](https://0.0.0.0:3000/docs/reference/support.md): How to contact Chargeflow API support, what to include (your requestId), steps to try first, and where to check API status. ## Start Here - [Chargeflow Product Model: Prevent, Alerts, Automation & Connect Explained](https://0.0.0.0:3000/docs/start-here/product-model.md): The Chargeflow product suite - Prevent, Alerts, Automation, Insights, and Connect - what each one does, when it acts, and which docs section covers it. - [Transaction & Dispute Lifecycle: Where Each Chargeflow Product Acts](https://0.0.0.0:3000/docs/start-here/transaction-lifecycle.md): The five stages a transaction can move through - from checkout to dispute outcome - and which Chargeflow product acts at each stage. - [Chargeback & Dispute Glossary: Representment, Reason Codes, RDR & More](https://0.0.0.0:3000/docs/start-here/language-of-disputes.md): A glossary of the dispute, chargeback, and alert vocabulary used throughout the Chargeflow docs and API. ## OpenAPI Specs - [Merchants API 2025-04-01](https://0.0.0.0:3000/specs/openapi-merchants-2025-04-01.json): OpenAPI 3 spec for the current merchant API version - [Merchants API 2024-03-18](https://0.0.0.0:3000/specs/openapi-merchants-2024-03-18.json): OpenAPI 3 spec for the previous merchant API version - [Platforms API 2025-04-01](https://0.0.0.0:3000/specs/openapi-platforms-2025-04-01.json): OpenAPI 3 spec for the current platforms (Connect) API version - [Platforms API 2024-03-18](https://0.0.0.0:3000/specs/openapi-platforms-2024-03-18.json): OpenAPI 3 spec for the previous platforms (Connect) API version ## Optional - [llms-full.txt](https://0.0.0.0:3000/llms-full.txt): every docs page concatenated into a single markdown file - [Agent skill](https://0.0.0.0:3000/SKILL.md): intent-to-endpoint routing guide for coding agents integrating Chargeflow