List Subscription

The List Subscription API enables to fetch the list of subscriptions created for events notification.

Method: POST

{{URL}}/jsonrpc

Headers

Name	Value
Content-Type	application/json

Example

Payload Parameters

Parameter	Description
groupId Mandatory	String Account number of the subscriber Sample value: "200146575944771"

cURL

curl --location '' \
--header 'Content-Type: application/json' \
--data '{"groupId":"200146575944771"}'

C#

var options = new RestClientOptions("")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/json");
var body = @"{
" + "\n" +
@"    ""groupId"": ""200146575944771""
" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

Go

package main

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

func main() {

  url := ""
  method := "POST"

  payload := strings.NewReader(`{`+"
"+`
    "groupId": "200146575944771"`+"
"+`
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

NodeJs

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
  'method': 'POST',
  'hostname': '',
  'path': '/',
  'headers': {
    'Content-Type': 'application/json'
  },
  'maxRedirects': 20
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function (chunk) {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });

  res.on("error", function (error) {
    console.error(error);
  });
});

var postData = JSON.stringify({
  "groupId": "200146575944771"
});

req.write(postData);

req.end();

Body

{
  "groupId": "200146575944771"
}

Response: 200

Payload Parameters

Parameter	Description
subscriptions	Array
id	String Unique Subscription ID Sample value: "SUB28757"
name	String Name of the Subscription Sample value: "NETXD"
createdDate	String Subscription created date and time Sample value: "2024-01-05T11:11:04.537Z"
updatedDate	String Subscription last modified date and time Sample value: "2024-02-23T08:31:01.307Z"
callbackUrl	String Url where notifications are posted Sample value: "http://localhost:4444/event"
source	String Event's source Sample value: "PL"
events	Array
Transaction.NEW	String Event - transaction created
Transaction.UPDATE	String Event - transaction status updated
Account.UPDATE	String Event - account status updated
Account.NEW	String Event - new account created
sourceId	String ID of the event's source Sample value: "SRC8001"
statistics	Array
deliveries	String Total number of events (created & delivered) Sample value: "351"
delivered	String Number of events notifications delivered successfully Sample value: "351"
count	String Total number of subscriptions Sample value: "1"

{
     "subscriptions": [
         {
             "id": "SUB28757",
             "name": "NETXD ",
             "createdDate": "2024-01-05T11:11:04.537Z",
             "updatedDate": "2024-02-23T08:31:01.307Z",
             "callbackUrl": "http://localhost:4444/event",
             "source": "PL",
             "events": [
                 "Transaction.NEW",
                 "Transaction.UPDATE",
                 "Account.UPDATE",
                 "Account.NEW"
             ],
             "sourceId": "SRC8001",
             "statistics": {
                 "deliveries": "351",
                 "delivered": "351"
             }
         },
     ],
     "count": "1"
 }