# Chargeflow API Reference

> Every endpoint page of the Chargeflow REST API, both versions, one line each. Base URL `https://api.chargeflow.io`, authenticated with your API key in the `x-api-key` header. Docs index: https://docs.chargeflow.io/llms.txt

Machine-readable specs:

- [Chargeflow API 2025-04-01](https://docs.chargeflow.io/specs/openapi-2025-04-01.json)
- [Chargeflow API 2024-03-18](https://docs.chargeflow.io/specs/openapi-2024-03-18.json)

## API Reference

- [API overview](https://docs.chargeflow.io/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://docs.chargeflow.io/docs/api/2025-04-01/merchants/health-check.md): API health check endpoints
- [Validate Access Key](https://docs.chargeflow.io/docs/api/2025-04-01/merchants/health-check/public/2025-04-01/health-check/access-key/get.md): Confirms your API Access Key is valid and active. A 403 means the key is missing, invalid, or revoked.
- [Service Health Verification](https://docs.chargeflow.io/docs/api/2025-04-01/merchants/health-check/public/2025-04-01/health-check/get.md): Confirms the Chargeflow API is reachable and responding. Requires no authentication and returns 200 even without an x-api-key header, so it reports service availability only. To check credentials, call the access-key health check.
- [Disputes](https://docs.chargeflow.io/docs/api/2025-04-01/merchants/disputes.md): Disputes management endpoints
- [Get Disputes](https://docs.chargeflow.io/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://docs.chargeflow.io/docs/api/2025-04-01/merchants/disputes/public/2025-04-01/disputes/disputeid/get.md): Retrieves a single dispute, optionally expanded with enriched data using the expand parameter.
- [Enrich Dispute](https://docs.chargeflow.io/docs/api/2025-04-01/merchants/disputes/public/2025-04-01/disputes/disputeid/patch.md): Enriches a dispute with additional data (transaction, order, subscription, and more) to improve your chances of winning. Array properties are overwritten in full, so send every item you want to keep.
- [Create Subscription](https://docs.chargeflow.io/docs/api/2025-04-01/merchants/disputes/public/2025-04-01/disputes/disputeid/subscription/post.md): Creates a subscription in Chargeflow that can be used to enrich a dispute.
- [Upload Evidence](https://docs.chargeflow.io/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://docs.chargeflow.io/docs/api/2025-04-01/merchants/alerts.md): Alerts related endpoints
- [Get Alerts](https://docs.chargeflow.io/docs/api/2025-04-01/merchants/alerts/public/2025-04-01/alerts/get.md): Retrieves a paginated list of pre-chargeback alerts on your account, with filters by date, type, status, and reason. Available to Chargeflow Alerts customers.
- [Get Alert By ID](https://docs.chargeflow.io/docs/api/2025-04-01/merchants/alerts/public/2025-04-01/alerts/alertid/get.md): Retrieves a single pre-chargeback alert by ID, including its status, type, linked transaction, and reason. Available to Chargeflow Alerts customers.
- [Update Alert Outcome](https://docs.chargeflow.io/docs/api/2025-04-01/merchants/alerts/public/2025-04-01/alerts/alertid/outcome/post.md): Reports the final outcome of a pre-chargeback alert back to Chargeflow, which closes the alert with the issuer. Required only in the merchant-managed handling model.
- [Customer Communication](https://docs.chargeflow.io/docs/api/2025-04-01/merchants/customer-communication.md): Customer communication endpoints
- [Create Customer Communication](https://docs.chargeflow.io/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.
- [Webhooks Management](https://docs.chargeflow.io/docs/api/2025-04-01/merchants/webhooks-management.md): Webhook configuration and management
- [Create Webhook](https://docs.chargeflow.io/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://docs.chargeflow.io/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://docs.chargeflow.io/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://docs.chargeflow.io/docs/api/2025-04-01/merchants/webhooks-events.md): Webhook event notifications
- [Dispute Created Event](https://docs.chargeflow.io/docs/api/2025-04-01/merchants/webhooks-events/dispute.created.md)
- [Alerts Created Event](https://docs.chargeflow.io/docs/api/2025-04-01/merchants/webhooks-events/alerts.created.md): Fires when a new pre-chargeback alert is created for your account. The payload carries the alert ID and key metadata.
- [Alert Transaction Linked Event](https://docs.chargeflow.io/docs/api/2025-04-01/merchants/webhooks-events/alerts.transaction.linked.md): Fires when Chargeflow matches a pre-chargeback alert to a transaction in your payment processor. The payload carries the alert ID and the matched transaction ID.
- [Alerts Outcome Updated Event](https://docs.chargeflow.io/docs/api/2025-04-01/merchants/webhooks-events/alerts.updated.md): Fires when the outcome of a pre-chargeback alert changes. The payload carries the alert ID, the new outcome, and supporting metadata.
- [Data Subject](https://docs.chargeflow.io/docs/api/2025-04-01/merchants/data-subject.md)
- [Create Data Subject Removal Request](https://docs.chargeflow.io/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://docs.chargeflow.io/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://docs.chargeflow.io/docs/api/2025-04-01/platforms/accounts.md): Accounts related endpoints
- [Create Account](https://docs.chargeflow.io/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://docs.chargeflow.io/docs/api/2025-04-01/platforms/accounts/public/2025-04-01/accounts/accountid/get.md): Retrieve a single account details.
- [Merchants Disputes](https://docs.chargeflow.io/docs/api/2025-04-01/platforms/merchants-disputes.md): Merchants disputes management endpoints
- [Create Dispute](https://docs.chargeflow.io/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://docs.chargeflow.io/docs/api/2025-04-01/platforms/evidence.md): Evidence management endpoints
- [Generate Evidence](https://docs.chargeflow.io/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://docs.chargeflow.io/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://docs.chargeflow.io/docs/api/2025-04-01/platforms/webhooks-events.md): Webhook event notifications
- [Integration Access Error Event](https://docs.chargeflow.io/docs/api/2025-04-01/platforms/webhooks-events/integration.access.error.md)
- [Evidence Ready Event](https://docs.chargeflow.io/docs/api/2025-04-01/platforms/webhooks-events/evidence.ready.md)
- [Evidence Error Event](https://docs.chargeflow.io/docs/api/2025-04-01/platforms/webhooks-events/evidence.error.md)
- [Dispute Created Event](https://docs.chargeflow.io/docs/api/2025-04-01/platforms/webhooks-events/dispute.created.md)
- [Migrate from 2024-03-18 to 2025-04-01](https://docs.chargeflow.io/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://docs.chargeflow.io/docs/api/2024-03-18.md): Legacy version of the Chargeflow REST API
- [Health Check](https://docs.chargeflow.io/docs/api/2024-03-18/merchants/health-check.md): API health check endpoints
- [Service Health Verification](https://docs.chargeflow.io/docs/api/2024-03-18/merchants/health-check/public/2024-03-18/health-check/get.md): Confirms the Chargeflow API is reachable and responding. Requires no authentication and returns 200 even without an x-api-key header, so it reports service availability only. To check credentials, call the access-key health check.
- [Validate Access Key](https://docs.chargeflow.io/docs/api/2024-03-18/merchants/health-check/public/2024-03-18/health-check/access-key/get.md): Confirms your API Access Key is valid and active. A 403 means the key is missing, invalid, or revoked.
- [Disputes](https://docs.chargeflow.io/docs/api/2024-03-18/merchants/disputes.md): Disputes management endpoints
- [Get Disputes](https://docs.chargeflow.io/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://docs.chargeflow.io/docs/api/2024-03-18/merchants/disputes/public/2024-03-18/disputes/post.md): Creates a dispute in Chargeflow that can either be viewed through the Chargeflow platform or managed by Chargeflow.
- [Upload Evidence](https://docs.chargeflow.io/docs/api/2024-03-18/merchants/disputes/public/2024-03-18/disputes/disputeid/evidence/post.md): The Submit Additional Evidence API allows you to upload supporting documents for a dispute, strengthening your chargeback response.
- [Webhooks Management](https://docs.chargeflow.io/docs/api/2024-03-18/merchants/webhooks-management.md): Webhook configuration and management
- [Create Webhook](https://docs.chargeflow.io/docs/api/2024-03-18/merchants/webhooks-management/public/2024-03-18/webhooks/post.md): The Create Webhook API allows you to register a webhook for a specific event type and URL target.
- [Get All Webhooks](https://docs.chargeflow.io/docs/api/2024-03-18/merchants/webhooks-management/public/2024-03-18/webhooks/get.md): The Get All Webhooks API allows you to retrieve all webhook registrations for a specific chargeflowId.
- [Delete Webhook](https://docs.chargeflow.io/docs/api/2024-03-18/merchants/webhooks-management/public/2024-03-18/webhooks/id/delete.md): The Delete Webhook API allows you to delete a webhook registration by providing the webhook ID.
- [Webhooks Events](https://docs.chargeflow.io/docs/api/2024-03-18/merchants/webhooks-events.md): Webhook event notifications
- [Dispute Created Event](https://docs.chargeflow.io/docs/api/2024-03-18/merchants/webhooks-events/dispute.created.md)
- [Alerts Created Event](https://docs.chargeflow.io/docs/api/2024-03-18/merchants/webhooks-events/alerts.created.md): Fires when a new pre-chargeback alert is created for your account. The payload carries the alert ID and key metadata.
- [Alert Transaction Linked Event](https://docs.chargeflow.io/docs/api/2024-03-18/merchants/webhooks-events/alerts.transaction.linked.md): Fires when Chargeflow matches a pre-chargeback alert to a transaction in your payment processor. The payload carries the alert ID and the matched transaction ID.
- [Alerts Outcome Updated Event](https://docs.chargeflow.io/docs/api/2024-03-18/merchants/webhooks-events/alerts.updated.md): Fires when the outcome of a pre-chargeback alert changes. The payload carries the alert ID, the new outcome, and supporting metadata.
- [Disputes](https://docs.chargeflow.io/docs/api/2024-03-18/platforms/disputes.md): Disputes management endpoints
- [Get Disputes](https://docs.chargeflow.io/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://docs.chargeflow.io/docs/api/2024-03-18/platforms/disputes/public/2024-03-18/disputes/post.md): Creates a dispute in Chargeflow that can either be viewed through the Chargeflow platform or managed by Chargeflow.
- [Webhooks Events](https://docs.chargeflow.io/docs/api/2024-03-18/platforms/webhooks-events.md): Webhook event notifications
- [Integration Access Error Event](https://docs.chargeflow.io/docs/api/2024-03-18/platforms/webhooks-events/integration.access.error.md)
- [Evidence Ready Event](https://docs.chargeflow.io/docs/api/2024-03-18/platforms/webhooks-events/evidence.ready.md)
- [Evidence Error Event](https://docs.chargeflow.io/docs/api/2024-03-18/platforms/webhooks-events/evidence.error.md)
- [Dispute Created Event](https://docs.chargeflow.io/docs/api/2024-03-18/platforms/webhooks-events/dispute.created.md)