Skip to main content
GET
/
api
/
v2
/
alerts
Fetch Alerts
curl --request GET \
  --url https://api.chargeblast.com/api/v2/alerts \
  --header 'X-API-Key: <x-api-key>'
import requests

url = "https://api.chargeblast.com/api/v2/alerts"

headers = {"X-API-Key": "<x-api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-API-Key': '<x-api-key>'}};

fetch('https://api.chargeblast.com/api/v2/alerts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.chargeblast.com/api/v2/alerts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <x-api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.chargeblast.com/api/v2/alerts"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("X-API-Key", "<x-api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.chargeblast.com/api/v2/alerts")
.header("X-API-Key", "<x-api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.chargeblast.com/api/v2/alerts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<x-api-key>'

response = http.request(request)
puts response.read_body
{
  "alerts": [
    {
      "id": "<string>",
      "alertType": "<string>",
      "creditAppealed": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "amount": 123,
      "transactionDate": "2023-11-07T05:31:56Z",
      "subprovider": "<string>",
      "provider": "<string>",
      "card": "<string>",
      "issuer": "<string>",
      "invoicedAt": "2023-11-07T05:31:56Z",
      "authCode": "<string>",
      "site": "<string>",
      "customerEmail": "<string>",
      "creditStatus": "<string>",
      "currency": "<string>",
      "reasonCode": "<string>",
      "merchantId": "<string>",
      "acquirerAction": "<string>",
      "alertId": "<string>",
      "resolvedDate": "2023-11-07T05:31:56Z",
      "resolvedByApi": true,
      "externalOrder": "<string>",
      "externalUrl": "<string>",
      "creditNotes": "<string>",
      "arn": "<string>",
      "attributes": {
        "order_number": "#1533",
        "processor_id": "proc_b381c83a9bc8a93"
      },
      "customerId": "<string>",
      "descriptor": "<string>",
      "cardBrand": "<string>",
      "responseAction": "<string>"
    }
  ],
  "page": 123,
  "per": 123,
  "total": 123
}
The subprovider field indicates the alert network. See Alert Types for all possible values and descriptions.
Each alert may include optional attributes: a dictionary of string keys and string values (for example order_number, processor_id). The same field appears on webhook payloads when present.

Headers

X-API-Key
string
required

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

Query Parameters

filter
string | null

The type of alerts to filter for, possible values: RDR, CDRN, Ethoca, TC40, SAFE

page
integer<int64> | null

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

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
per
integer<int64>
required
total
integer<int64>
required