View Notifications

POST {api-url}/viewNotifications?ns={community}

Retrieve the currently configured notification rules (SMS, Email, Webhooks) for a specific Transaction Type (TT) in the community. If TT is 0, it retrieves the rules for all transaction types. For a detailed list of available variables to be evaluated in Conditions and Payload strings, refer to the Webhook Payload Structure.

Request

Parameters

Field	Type	Requirement	Description
TT	Integer	Required	The Transaction Type to query (e.g., 4 for Pay, 0 for All).
Metadata	String	Optional	Any other detail to store with this request.

Example Body

{
  "TT": 4,
  "Metadata": ""
}

Response

Parameters

Field	Type	Description
Notifications	Object	A map of transaction types to an array of configured rule objects.

Example Body

{
    "Notifications": {
        "TT4": [
            {
                "Type": "SMS",
                "SMSCondition": "len(Audit_FromCardPANNo)==0",
                "SMSRecipients": "[[From_MSISDN]]",
                "SMSMessage": "Payment of [[Audit_AmountStr]] successful."
            }
        ]
    },
    "TID": "15000000000",
    "State": "Success",
    "Status": "1",
    "Error": ""
}

cURL

curl -X POST '{api-url}/viewNotifications?ns={community}' \
-H 'Authorization: bearer YOUR_TOKEN' \
-H 'Content-Type: application/json' \
-d '{"TT":4,"Metadata":""}'

C#

using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        var client = new HttpClient();
        var request = new HttpRequestMessage(HttpMethod.Post, "{api-url}/viewNotifications?ns={community}");
        request.Headers.Add("Authorization", "bearer YOUR_TOKEN");

        var jsonPayload = @"{
  ""TT"": 4,
  ""Metadata"": """"
}";
        request.Content = new StringContent(jsonPayload, Encoding.UTF8, "application/json");

        var response = await client.SendAsync(request);
        response.EnsureSuccessStatusCode();

        var responseBody = await response.Content.ReadAsStringAsync();
        Console.WriteLine(responseBody);
    }
}

Go

package main

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

func main() {
  url := "{api-url}/viewNotifications?ns={community}"
  payload := strings.NewReader(`{"TT":4,"Metadata":""}`)

  req, _ := http.NewRequest("POST", url, payload)
  req.Header.Add("Authorization", "bearer YOUR_TOKEN")
  req.Header.Add("Content-Type", "application/json")

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

  body, _ := ioutil.ReadAll(res.Body)
  fmt.Println(string(body))
}

Java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class ApiRequest {
    public static void main(String[] args) throws Exception {
        var payload = """
                {
  "TT": 4,
  "Metadata": ""
}
                """;

        var request = HttpRequest.newBuilder()
                .uri(URI.create("{api-url}/viewNotifications?ns={community}"))
                .header("Authorization", "bearer YOUR_TOKEN")
                .header("Content-Type", "application/json")
                .POST(HttpRequest.BodyPublishers.ofString(payload))
                .build();

        var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

Node.js

// Requires Node.js v18+
(async () => {
    const url = '{api-url}/viewNotifications?ns={community}';
    const payload = {
    "TT": 4,
    "Metadata": ""
};

    try {
        const response = await fetch(url, {
            method: 'POST',
            headers: {
                'Authorization': 'bearer YOUR_TOKEN',
                'Content-Type': 'application/json'
            },
            body: JSON.stringify(payload)
        });
        const data = await response.json();
        console.log(data);
    } catch (error) {
        console.error('Error:', error);
    }
})();

PHP

<?php
$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{api-url}/viewNotifications?ns={community}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => '{
  "TT": 4,
  "Metadata": ""
}',
  CURLOPT_HTTPHEADER => array(
    'Authorization: bearer YOUR_TOKEN',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);
curl_close($curl);
echo $response;

Python

import requests
import json

url = "{api-url}/viewNotifications?ns={community}"
payload = {
  "TT": 4,
  "Metadata": ""
}

headers = {
    "Authorization": "bearer YOUR_TOKEN",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

Ruby

require 'uri'
require 'net/http'
require 'json'

url = URI("{api-url}/viewNotifications?ns={community}")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'bearer YOUR_TOKEN'
request["Content-Type"] = 'application/json'

request.body = JSON.dump({
  "TT": 4,
  "Metadata": ""
})

response = http.request(request)
puts response.read_body