ℹ️ For more information, refer to our API docs.
What the Chargeback.io API Does
The Chargeback.io Public API lets your system perform key actions without using the dashboard:
Manage alerts
Handle invoices
Check account status
The sections below describe each feature and clarify important terms and filters.
1. Alert Management
Use these endpoints to work with pre-dispute alerts. You can:
List alerts: Retrieve alerts and apply filters to narrow results.
Change alert status: Update the status of a specific alert.
Retrieve alert by external ID: Get transaction details for a specific alert using its external ID.
Alert Filters (What They Mean)
Filter | Description |
Status | The alert’s current state (e.g., Manually Refunded, Not Found) |
Service | The alert network used (e.g., RDR) |
Type | The reason for the chargeback |
Payment Status | Whether the alert has been paid |
Currency | The transaction currency (e.g., USD) |
Country | The country where the transaction occurred |
Brand | The card brand (e.g., Visa, Mastercard) |
Bank | The customer’s issuing bank |
Merchant Descriptor | The billing/statement descriptor used for the transaction |
Transaction ID | The processor’s transaction identifier |
Alert ID | The unique identifier for the alert |
Card last 4 digits | The final four digits of the customer’s card number |
2. Invoice Management
Use these endpoints to view and manage billing information. You can retrieve invoice lists and details with filtering and sorting:
List invoices: Returns invoices with:
Invoice amount
Number of alerts in the billing period
Billing period dates
Payment status
Retrieve invoice by ID: Returns the specific invoice with:
Invoice ID (unique identifier)
Alert count for the billing period
Payment information (method and related details)
Invoice status (paid or pending)
3. Business Account Management
Use these endpoints to view and manage businesses linked to your Chargeback.io account:
List business accounts: Returns a paginated list with filtering and sorting options.
Retrieve business account by external ID: Provides details including:
Account information: Business name, website URL, and related details
Enrollment details: Whether a service (e.g., RDR) is active
Connection status: Whether the business account is active
Feature availability: Which features are enabled for the merchant account
Real-Time Alert Updates (Webhooks)
Webhooks send automatic notifications when certain events occur, so your system can react in real time without polling the API.
Event types include:
alert.created- A new chargeback alert is receivedalert.updated- An alert’s status changesinvoice.created- A new billing invoice is generatedinvoice.paid- An invoice payment succeedsinvoice.failed- An invoice payment fails or is declined
Each webhook includes:
event_type- The event that occurredevent_id- A unique identifier for the eventEvent-specific data: Details related to that alert or invoice
Rate Limits
The Chargeback.io API allows up to 100 requests per hour per API key.
If you exceed this limit, additional requests are temporarily blocked until the hour resets.
How to Get Access to API Keys
In the lower-left corner of the dashboard, open Account Settings.
In the popup, select ⚙️ Settings.
From the sidebar, choose Public API.
Copy the API key shown.
To create a new Internal or Zapier key, click Regenerate API key.
If you can’t regenerate it yourself, contact Chargeback.io support.
⚠️ Security: Treat API keys like passwords. Store them securely, do not share them publicly, and regenerate immediately if a key is exposed.
FAQs
How can I check API uptime or service status?
Visit status.chargeback.io for live system status and historical uptime.
💡 Questions or concerns?
Get help from our support specialists at Chargeback.io.