Alerts

Fetch Alerts

Get all the alerts from your chargeblast account.

get/api/alerts

Request

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

Query parameters

merchant_idstring nullable

Headers

X-API-Keystring required

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

Response

OK

providerstring nullable

Provider associated with the alert. Possible values: ethoca, verifi

idstring required

Id for the alert.

cardstring nullable

The redacted card number, e.g., 424242****1234.

issuerstring nullable

Issuer of the card (e.g., bank or financial institution).

invoicedAtstring date-time nullable

Date and time when the alert was invoiced.

authCodestring nullable

Authorization code for the transaction, if available.

sitestring nullable

Merchant's website or site string associated with the alert.

customerEmailstring nullable

Customer's email address associated with the alert, if available.

creditStatusstring nullable

Status of the credit (if any) associated with the alert.

alertTypestring required

Type of alert, e.g., FRAUD, DISPUTE.

creditAppealedboolean required

Indicates if the credit associated with the alert was appealed.

currencystring nullable

Currency code in ISO format (e.g., USD, EUR) for the transaction.

reasonCodestring nullable

Reason code associated with the alert, often indicating the nature of the dispute.

createdAtstring date-time required

Date and time when the alert was created.

merchantIdstring nullable

Identifier for the merchant within the system.

acquirerActionstring nullable

Actions taken by the acquirer in response to the alert. Only relevant for RDR and other acquirer side alerts - either Resolved or Declined.

alertIdstring nullable

Unique identifier for the alert within the provider's system. Will match the id field.

amountnumber double required

Transaction amount for the alert. $139.38 will be represented as 139.38

resolvedDatestring date-time nullable

Date and time when the alert was resolved.

resolvedByApiboolean nullable

Indicates if the alert was resolved via API.

externalOrderstring nullable

External charge id related to the alert.

externalUrlstring nullable

URL linking to an external reference for the alert.

creditNotesstring nullable

Additional notes or information regarding the credit status.

arnstring nullable

Acquirer Reference Number, unique identifier for the transaction.

attributesobject nullable

Optional string key-value metadata associated with the alert. Included on webhook payloads and when fetching alerts via the API when present.

transactionDatestring date-time required

Date and time when the transaction took place.

customerIdstring nullable

Unique identifier for the customer associated with the alert, if available.

descriptorstring nullable

Billing descriptor shown on the card statement.

subproviderstring required

Specific sub-provider within the provider service.

cardBrandstring nullable

The card network (e.g., Visa, Mastercard, Amex).

responseActionstring nullable

Response action taken in response to the alert.

Example response

[
  {
    "attributes": {
      "order_number": "#1533",
      "processor_id": "proc_b381c83a9bc8a93"
    }
  }
]

Changes

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