---
title: "Fetch Alerts"
method: GET
path: "/api/v3/alerts"
tags: ["Alerts"]
---

# Fetch Alerts

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

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.

## Query parameters

- `filter[type]` string, nullable
- `filter[status]` string, nullable
- `filter[isMatched]` boolean, nullable
- `filter[startDate]` string, nullable
- `filter[endDate]` string, nullable
- `page` integer, nullable
- `per` integer, nullable

## Headers

- `X-API-Key` string, required

## Response `200`

OK

- APIAlertsResponse
  - `alerts` AlertV3[], required
    - `acquirerAction` string, nullable: Actions taken by the acquirer in response to the alert. Only relevant for RDR and other acquirer side alerts - either Resolved or Declined.
    - `alertId` string, nullable: Unique identifier for the alert within the provider's system. Will match the id field.
    - `alertType` 'FRAUD' | 'DISPUTE' | 'UNKNOWN' | 'DISPUTE_RDR' | 'CANCEL', required: • FRAUD → Fraud • DISPUTE → Dispute • UNKNOWN → Unknown • DISPUTE_RDR → RDR • CANCEL → Cancel
    - `amount` number, double, nullable: Transaction amount for the alert. $139.38 will be represented as 139.38
    - `arn` string, nullable: Acquirer Reference Number, unique identifier for the transaction.
    - `attributes` object, nullable: Optional string key-value metadata associated with the alert. Included on webhook payloads and when fetching alerts via the API when present.
    - `authCode` string, nullable: Authorization code for the transaction, if available.
    - `bin` string, nullable: Acquiring BIN the alert was raised under.
    - `binDetails` BinDetails
      - `type` string, nullable
      - `prepaid` boolean, nullable
      - `brand` string, nullable
      - `bank` Bank
        - `name` string, nullable
        - `phone` string, nullable
      - `country` BinCountry
        - `alpha2` string, nullable
        - `name` string, nullable
    - `caid` string, nullable: Card acceptor id (merchant id) the alert was raised under.
    - `card` string, nullable: The redacted card number, e.g., 424242****1234.
    - `cardBrand` string, nullable: The card network (e.g., Visa, Mastercard, Amex).
    - `country` string, nullable: Issuing country of the alerted card.
    - `createdAt` string, date-time, nullable: Date and time when the alert was created.
    - `creditAppealed` boolean, required: Indicates if the credit associated with the alert was appealed.
    - `creditNotes` string, nullable: Additional notes or information regarding the credit status.
    - `creditStatus` string, nullable: Status of the credit (if any) associated with the alert.
    - `currency` string, nullable: Currency code in ISO format (e.g., USD, EUR) for the transaction.
    - `customerEmail` string, nullable: Customer's email address associated with the alert, if available.
    - `customerId` string, nullable: Unique identifier for the customer associated with the alert, if available.
    - `descriptor` string, nullable: Billing descriptor shown on the card statement.
    - `externalOrder` string, nullable: External charge id related to the alert.
    - `externalUrl` string, nullable: URL linking to an external reference for the alert.
    - `funding` string, nullable: Card funding type (credit, debit, prepaid).
    - `id` string, nullable: Id for the alert.
    - `invoicedAt` string, date-time, nullable: Date and time when the alert was invoiced.
    - `isMatched` boolean, required: Whether the alert was matched to a transaction. When false, the charge-level fields (externalOrder, externalUrl, customerId, customerEmail, metadata, attributes, mid, processor) are null and isRefunded is false.
    - `isRefunded` boolean, required: Whether the matched transaction had already been refunded at match time. Always false for an unmatched alert.
    - `issuer` string, nullable: Issuer of the card (e.g., bank or financial institution).
    - `merchantId` string, nullable: Identifier for the merchant within the system.
    - `merchantName` string, nullable: Merchant name registered with the alert network.
    - `metadata` string, nullable: Metadata carried on the matched transaction, when the processor supplied any.
    - `mid` string, nullable: Sub-account / MID the matched transaction settled under.
    - `networkId` string, nullable: Network transaction id supplied by the card network.
    - `notes` string, nullable: Internal notes recorded against the alert.
    - `origin` string, nullable: Upstream alert origin, e.g. mastercard, visa, discover.
    - `processor` 'Stripe' | 'Shopify' | 'CheckoutChamp' | 'Braintree' | 'Mamopay' | 'Maverick' | 'Sticky' | 'Unknown' | 'API' | '29Next' | 'Square' | 'Spreedly' | 'Airwallex' | 'NMI' | 'Auth' | 'Primer' | 'Payarc' | 'PaymentKit' | 'Chargebee' | 'Phoenix' | 'Adyen' | 'Recurly' | 'Gr4vy' | 'Recharge' | 'Openpay' | 'Finix' | 'Worldpay' | 'FMJ' | 'Coinflow' | 'Xecom' | 'Vrio' | 'Checkout' | 'a55' | 'Seal' | 'GuestyPay' | 'Fyntek' | 'Paytech' | 'SwissCRM' | 'Paysight' | 'Whop' | 'Spark' | 'Kurv' | 'Everflow' | 'IMerchant' | 'RocketGate': • Stripe → Stripe • Shopify → Shopify • CheckoutChamp → CheckoutChamp • Braintree → Braintree • Mamopay → Mamopay • Maverick → Maverick • Sticky → Sticky • Unknown → Unknown • API → API • 29Next → Next • Square → Square • Spreedly → Spreedly • Airwallex → Airwallex • NMI → NMI • Auth → Auth • Primer → Primer • Payarc → Payarc • PaymentKit → PaymentKit • Chargebee → Chargebee • Phoenix → Phoenix • Adyen → Adyen • Recurly → Recurly • Gr4vy → Gr4vy • Recharge → Recharge • Openpay → Openpay • Finix → Finix • Worldpay → Worldpay • FMJ → FMJ • Coinflow → Coinflow • Xecom → Xecom • Vrio → Vrio • Checkout → Checkout • a55 → a55 • Seal → Seal • GuestyPay → GuestyPay • Fyntek → Fyntek • Paytech → Paytech • SwissCRM → SwissCRM • Paysight → Paysight • Whop → Whop • Spark → Spark • Kurv → Kurv • Everflow → Everflow • IMerchant → IMerchant • RocketGate → RocketGate
    - `provider` string, nullable: Provider associated with the alert. Possible values: ethoca, verifi
    - `reasonCode` 'Resolved' | 'ResolvedPartial' | 'ResolvedCancelled' | 'AccountCancelled' | 'CancellationProcessed' | 'UnmatchedGeneral' | 'UnmatchedCannotFindTransaction' | 'Duplicate' | 'MIDLost' | 'AlreadyRefunded' | 'AlreadyChargeback' | 'Ineligible' | 'TDS' | 'CannotCancel' | 'MatchedWillShip' | 'EscalateChargeback' | 'ContactedShipper' | 'WIP' | 'Error' | 'None' | 'NotMyDescriptor' | 'Unactioned' | ''
    - `resolvedByApi` boolean, nullable: Indicates if the alert was resolved via API.
    - `resolvedDate` string, date-time, nullable: Date and time when the alert was resolved.
    - `responseAction` string, nullable: Response action taken in response to the alert.
    - `site` string, nullable: Merchant's website or site string associated with the alert.
    - `subprovider` 'Ethoca' | 'CDRN' | 'RDR' | 'Discover' | 'AMEX' | 'JCB' | 'Unknown' | '' | 'Cancel' | 'TC40' | 'SAFE', required
    - `transactionDate` string, date-time, nullable: Date and time when the transaction took place.
  - `page` integer, required: The page returned. The first page is 1.
  - `per` integer, required: Objects per page.
  - `total` integer, required: Total alerts matching the filter.

---

[API](https://skmtc.dev/chargeblast/apis/chargeblast-api-2.md) · [All operations](https://skmtc.dev/chargeblast/apis/chargeblast-api-2/llms.txt) · [OpenAPI document](https://skmtc.dev/chargeblast/apis/chargeblast-api-2/revisions/882dd27a5692?raw)