Alerts

Fetch Alerts

Get all the alerts from your Chargeblast account, filtered by network, status, match state or date range. Each company has its own API key, so run the export once per key.

get/api/v3/alerts

Request

  • Base URL: https://api.chargeblast.com
  • URL: https://api.chargeblast.com/api/v3/alerts
  • Auth: none declared. Required headers: X-API-Key

Query parameters

filter[type]string nullable

Alert networks to include, comma-separated. Possible values: Ethoca, CDRN, RDR, Discover, AMEX, JCB, Cancel, TC40, SAFE, PayPal. Case-insensitive. An unrecognised value is rejected with a 400 rather than ignored.

filter[status]string nullable

Alert reason codes to include, comma-separated. Possible values: Resolved, ResolvedPartial, ResolvedCancelled, AccountCancelled, CancellationProcessed, UnmatchedGeneral, UnmatchedCannotFindTransaction, Duplicate, MIDLost, AlreadyRefunded, AlreadyChargeback, Ineligible, TDS, CannotCancel, MatchedWillShip, EscalateChargeback, ContactedShipper, WIP, Error, None, NotMyDescriptor, Unactioned, TIMEOUT. Case-insensitive. An unrecognised value is rejected with a 400 rather than ignored.

filter[isMatched]boolean nullable

true returns only alerts matched to a transaction, false only unmatched ones. Mirrors the isMatched field on each alert.

filter[startDate]string nullable

Only return alerts created on or after this point. ISO 8601 date/time (2026-06-01T00:00:00Z) or a date (2026-06-01).

filter[endDate]string nullable

Only return alerts created on or before this point. ISO 8601 date/time (2026-06-01T00:00:00Z) or a date (2026-06-01).

pageinteger nullable

The starting page of the request. Default value of 1.

perinteger nullable

How many objects to request per page. Default value of 10.

Headers

X-API-Keystring required

Your API key. Sent in the X-API-Key header.

Response

OK

pageinteger required

The page returned. The first page is 1.

perinteger required

Objects per page.

totalinteger required

Total alerts matching the filter.

Changes

No recorded changes to this operation across all 1 revision of this API.