Connecting to the Chargeback.io API

What the Chargeback.io API Does

The Chargeback.io Public API allows your system to do the following without needing our dashboard:

• Manage alerts
• Handle invoices
• Check account status

The sections below describe each available feature and explain any terms or filters that may need clarification.

1. Alert Management

Use this section of the API to work with pre-dispute alerts. You can:

• List Alerts: Retrieve a list of 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.

What Each Alert Filter Means

This table will help you interpret what each filter means:

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 for
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 or statement descriptor used for the transaction
Transaction ID	The transaction identifier from your payment processor
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 this section of the API to view and manage billing information. It allows you to retrieve invoice lists and details with filtering and sorting options:

• List Invoices: Returns a list of invoices, including:
  • Invoice amount
  • Number of alerts in each billing period
  • Billing period dates
  • Payment status for each invoice
• Retrieve Invoice by ID: Returns details for a specific invoice, including:
  • Invoice ID: The unique identifier of the invoice
  • Alert Count: Number of alerts in the billing period
  • Payment Information: Payment method and related details
  • Invoice Status: Whether the invoice has been paid or is pending

3. Business Account Management

Use this section of the API to view and manage businesses linked to your Chargeback.io account.

• List Business Accounts: Returns a paginated list of business accounts with available filtering and sorting options.
• Retrieve Business Account by External ID: Provides detailed information for a specific business account, including:
  • Account Information: Business name, website URL, and related details
  • Enrollment Details: Whether a service enrollment (for example, RDR) is active
  • Connection Status: Indicates if the business account itself is active
  • Feature Availability: Lists which features are enabled for the merchant account

 

Real-Time Alert Updates (Webhooks)

Webhooks send automatic notifications from Chargeback.io when certain events occur. They let your system react in real time without checking the API manually.

Event types include:

• alert.created: Sent when a new chargeback alert is received from payment processors
• alert.updated: Sent when an alert’s status changes
• invoice.created: Sent when a new billing invoice is generated
• invoice.paid: Sent when an invoice payment succeeds
• invoice.failed: Sent when an invoice payment fails or is declined

Each webhook includes:

• event_type: The event that occurred
• event_id: A unique identifier for the event
• Event-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 your system exceeds this limit, additional requests are temporarily blocked until the hour resets.

 

How to Get Access to API Keys

1. In the lower-left corner of the dashboard, open Account Settings.
2. In the popup, select ⚙️ Settings.
3. From the sidebar, choose Public API.
4. Copy the API key shown.

To create a new Internal or Zapier key, click Regenerate API key.

If you cannot regenerate it yourself, contact Chargeback.io support.

 

 

 

FAQs

How Can I Check API Uptime or Service Status?

You can view live system status and historical uptime on status.chargeback.io.