Update Notifications

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

Overwrite the existing notification rules for specific Transaction Types (TTs) with a new configuration. This allows you to set up SMS templates, Emails, and Webhooks with dynamic variables. 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
Notifications	Object	Required	An object mapping Transaction Types (e.g., "TT1") to an array of rule definitions.
Metadata	String	Optional	Any other detail to store with this request.

Example Body

{
  "Notifications": {
    "TT4": [
      {
        "Type": "SMS",
        "SMSCondition": "len(Audit_FromCardPANNo)==0",
        "SMSRecipients": "[[From_MSISDN]]",
        "SMSMessage": "Payment of [[Audit_AmountStr]] successful."
      }
    ]
  },
  "Metadata": ""
}

Response

Parameters

Field	Type	Description
TID	String	TID of the executed operation.
State	String	Transaction state (Success or Failed).
Status	String	Transaction status code (1 or negative error code).
Error	String	Failure reason, if applicable.

Example Body

{
    "TID": "15000000000",
    "State": "Success",
    "Status": "1",
    "Error": ""
}

cURL

curl -X POST '{api-url}/updateNotifications?ns={community}' \
-H 'Authorization: bearer YOUR_TOKEN' \
-H 'Content-Type: application/json' \
-d '{"Notifications":{"TT4":[{"Type":"SMS","SMSCondition":"len(Audit_FromCardPANNo)==0","SMSRecipients":"[[From_MSISDN]]","SMSMessage":"Payment of [[Audit_AmountStr]] successful."}]},"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}/updateNotifications?ns={community}");
        request.Headers.Add("Authorization", "bearer YOUR_TOKEN");

        var jsonPayload = @"{
  ""Notifications"": {
    ""TT4"": [
      {
        ""Type"": ""SMS"",
        ""SMSCondition"": ""len(Audit_FromCardPANNo)==0"",
        ""SMSRecipients"": ""[[From_MSISDN]]"",
        ""SMSMessage"": ""Payment of [[Audit_AmountStr]] successful.""
      }
    ]
  },
  ""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}/updateNotifications?ns={community}"
  payload := strings.NewReader(`{"Notifications":{"TT4":[{"Type":"SMS","SMSCondition":"len(Audit_FromCardPANNo)==0","SMSRecipients":"[[From_MSISDN]]","SMSMessage":"Payment of [[Audit_AmountStr]] successful."}]},"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 = """
                {
  "Notifications": {
    "TT4": [
      {
        "Type": "SMS",
        "SMSCondition": "len(Audit_FromCardPANNo)==0",
        "SMSRecipients": "[[From_MSISDN]]",
        "SMSMessage": "Payment of [[Audit_AmountStr]] successful."
      }
    ]
  },
  "Metadata": ""
}
                """;

        var request = HttpRequest.newBuilder()
                .uri(URI.create("{api-url}/updateNotifications?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}/updateNotifications?ns={community}';
    const payload = {
    "Notifications": {
        "TT4": [
            {
                "Type": "SMS",
                "SMSCondition": "len(Audit_FromCardPANNo)==0",
                "SMSRecipients": "[[From_MSISDN]]",
                "SMSMessage": "Payment of [[Audit_AmountStr]] successful."
            }
        ]
    },
    "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}/updateNotifications?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 => '{
  "Notifications": {
    "TT4": [
      {
        "Type": "SMS",
        "SMSCondition": "len(Audit_FromCardPANNo)==0",
        "SMSRecipients": "[[From_MSISDN]]",
        "SMSMessage": "Payment of [[Audit_AmountStr]] successful."
      }
    ]
  },
  "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}/updateNotifications?ns={community}"
payload = {
  "Notifications": {
    "TT4": [
      {
        "Type": "SMS",
        "SMSCondition": "len(Audit_FromCardPANNo)==0",
        "SMSRecipients": "[[From_MSISDN]]",
        "SMSMessage": "Payment of [[Audit_AmountStr]] successful."
      }
    ]
  },
  "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}/updateNotifications?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({
  "Notifications": {
    "TT4": [
      {
        "Type": "SMS",
        "SMSCondition": "len(Audit_FromCardPANNo)==0",
        "SMSRecipients": "[[From_MSISDN]]",
        "SMSMessage": "Payment of [[Audit_AmountStr]] successful."
      }
    ]
  },
  "Metadata": ""
})

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