Skip to main content
GET
Fetch Alerts
The subprovider field indicates the alert network — see Alert Types for all values. Each alert may also include optional attributes: a dictionary of string key/value pairs (for example order_number, processor_id), the same field that appears on webhook payloads.
New integrations should use v3; the legacy endpoint is Fetch Alerts (v2). Filters use the bracketed filter[...] query parameters below, or an equivalent JSON filter body (query string wins; page / per are always query params).

Headers

X-API-Key
string
required

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

Query Parameters

filter[type]
string | null

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 | null

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 | null

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

filter[startDate]
string | null

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 | null

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

page
integer<int64> | null

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

per
integer<int64> | null

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

Response

200 - application/json

OK

alerts
object[]
required
page
integer<int64>
required

The page returned. The first page is 1.

per
integer<int64>
required

Objects per page.

total
integer<int64>
required

Total alerts matching the filter.