Version: 1.0.2

Get All Accounts

'ListAccounts' API enables to fetch the list of accounts

Bank or financial institution can fetch either the total list of accounts or that are filtered based on a specific attribute or condition using this API. On providing the request with filtering option(if required) and page details to display the accounts list, details of each account is fetched out.

Method: POST

{{URL}}/jsonrpc
Headers

Name	Value
Content-Type	application/json

Example

Payload Parameters

Parameter	Description
method Mandatory	String API method that is being called to accounts list through account service Constant value: "AccountService.ListAccounts"
id Mandatory	String Unique ID of API request Sample value: "1"
params Mandatory	Object
api Mandatory	Object
signature Mandatory	String Signature for request validation Sample value: "signature"
keyId Mandatory	String API key used for request authentication Sample value: "ApplicationKeyId"
credential Mandatory	String API credential provided by NetXD Sample value: "Credential"
payload Mandatory	Object
PageNumber Optional	Number Current page number where the list of accounts to be displayed Sample value: 1
PageSize Optional	Number Number of accounts to be displayed per page Sample value: 15
filter Optional	String Searching for accounts based on specific attributes or conditions Sample value: ""

Parameter

Description

method

Mandatory

String

API method that is being called to accounts list through account service

Constant value: "AccountService.ListAccounts"

Mandatory

String

Unique ID of API request

Sample value: "1"

params

Mandatory

Object

api

Mandatory

Object

signature

Mandatory

String

Signature for request validation

Sample value: "signature"

keyId

Mandatory

String

API key used for request authentication

Sample value: "ApplicationKeyId"

credential

Mandatory

String

API credential provided by NetXD

Sample value: "Credential"

payload

Mandatory

Object

PageNumber

Optional

Number

Current page number where the list of accounts to be displayed

Sample value: 1

PageSize

Optional

Number

Number of accounts to be displayed per page

Sample value: 15

filter

Optional

String

Searching for accounts based on specific attributes or conditions

Sample value: ""

cURL
C#
Go
NodeJS

curl --location --globoff '{{URL}}/jsonrpc' \
--header 'Content-Type: application/json' \
--data '{"method":"AccountService.ListAccounts","id":"1","params":{"api":{"signature":"{{signature}}","keyId":"{{ApplicationKeyId}}","credential":"{{Credential}}"},"payload":{"pageNumber":1,"pageSize":15,"filter":""}}}'

var options = new RestClientOptions("{{URL}}/jsonrpc")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/json");
var body = @"{
" + "\n" +
@"  ""method"": ""AccountService.ListAccounts"",
" + "\n" +
@"  ""id"": ""1"",
" + "\n" +
@"  ""params"": {
" + "\n" +
@"    ""api"": {
" + "\n" +
@"      ""signature"": ""{{signature}}"",
" + "\n" +
@"      ""keyId"": ""{{ApplicationKeyId}}"",
" + "\n" +
@"      ""credential"": ""{{Credential}}""
" + "\n" +
@"    },
" + "\n" +
@"    ""payload"": {
" + "\n" +
@"      ""pageNumber"": 1,
" + "\n" +
@"      ""pageSize"": 15,
" + "\n" +
@"      ""filter"": """"
" + "\n" +
@"    }
" + "\n" +
@"  }
" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

package main

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

func main() {

  url := "{{URL}}/jsonrpc"
  method := "POST"

  payload := strings.NewReader(`{`+"
"+`
  "method": "AccountService.ListAccounts",`+"
"+`
  "id": "1",`+"
"+`
  "params": {`+"
"+`
    "api": {`+"
"+`
      "signature": "{{signature}}",`+"
"+`
      "keyId": "{{ApplicationKeyId}}",`+"
"+`
      "credential": "{{Credential}}"`+"
"+`
    },`+"
"+`
    "payload": {`+"
"+`
      "pageNumber": 1,`+"
"+`
      "pageSize": 15,`+"
"+`
      "filter": ""`+"
"+`
    }`+"
"+`
  }`+"
"+`
}`)

  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))
}

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

var options = {
  'method': 'POST',
  'hostname': '{{URL}}',
  'path': '/jsonrpc',
  '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({
  "method": "AccountService.ListAccounts",
  "id": "1",
  "params": {
    "api": {
      "signature": "{{signature}}",
      "keyId": "{{ApplicationKeyId}}",
      "credential": "{{Credential}}"
    },
    "payload": {
      "pageNumber": 1,
      "pageSize": 15,
      "filter": ""
    }
  }
});

req.write(postData);

req.end();

Body

{
  "method": "AccountService.ListAccounts",
  "id": "1",
  "params": {
    "api": {
      "signature": "{{signature}}",
      "keyId": "{{ApplicationKeyId}}",
      "credential": "{{Credential}}"
    },
    "payload": {
      "pageNumber": 1, //Any one of the listed field is required in payload
      "pageSize": 15,
      "filter": ""
    }
  }
}

Response: 200

Response Parameters

Parameter	Description
id	String Response ID echoed from the request ID Sample value – "1"
result	Object
accounts	Array
id	String Unique Account ID of the account Sample value – "40004"
name	String Name of the account Sample value – "SETTELEMENT"
Number	String Account number of the account Sample value – "200418023708107"
createdDate	String Date and time of the account was created Sample value – "2023-05-02T08:10:12.858Z"
updatedDate	String Date and time of the account was last updated Sample value – "2023-05-02T08:10:12.858Z"
balance	Number Current balance of the account Sample value – 0
holdBalance	Number Balance required to be held for pending transactions Sample value – 0
customerID	String Unique ID of the customer associated with the account Sample value – "100000000002001"
customerName	String Name of the customer associated with the account Sample value – "SMALLSYS INC"
accountCategory	String Category of the account Sample value – "LIABILITY"
accountType	Enum Type of the account Valid values: SAVINGS - To deposit for saving purpose CHECKING - For daily use WALLET - To store pre-paid money for daily usage MONEY_MARKET - Interest bearing account (based on interest rates) CREDIT_CARD - To track only the credit card transactions GL - General Ledger for accounting record CUSTODIAL - For the benefit of other financial institution Sample value – "SAVINGS"
currency	String Type of currency used for transaction Sample value – "USD"
currencyCode	String Code of the currency type Sample value – "840"
status	Enum Current status of the account Valid values: CREATED - Account has been newly created ACTIVE - Account is currently active and can be used for transactions CURTAILED - Account functionalities are limited DORMANT - Account is inactive for a specific period SUSPENDED - Account is Temporarily disabled BLOCKED - Account is restricted from performing any transactions CLOSED - Account is permanently terminated and can no longer be used DISABLED - Account is inactive and unusable, either temporarily or permanently Sample value – "ACTIVE"
institutionID	String Routing number of the bank or financial institution associated with the account Sample value – "101115315"
glAccount	String General ledger account number of the account Sample value – "900208571554444"
isVerify	Boolean Indicates whether the account has been verified Sample value – true
ledgerBalance	Number Ledger balance of the account Sample value – 0
preAuthBalance	Number Pre-authorized balance in the account for specific transactions Sample value – 0
riskScore	Number Risk score of the account represents the potential risk of fraudulent activity associated with the account Sample value – 0

{
    "id": "1",
    "result": {
        "accounts": [
            {
                "id": "40004",
                "name": "SETTELEMENT",
                "number": "200418023708107",
                "createdDate": "2023-05-02T08:10:12.858Z",
                "updatedDate": "2023-05-02T08:10:12.858Z",
                "balance": 0,
                "holdBalance": 0,
                "customerID": "100000000002001",
                "customerName": "SMALLSYS INC",
                "accountCategory": "LIABILITY",
                "accountType": "SAVINGS",
                "currency": "USD",
                "currencyCode": "840",
                "status": "ACTIVE",
                "institutionID": " 101115315",
                "glAccount": "900208571554444",
                "isVerify": true,
                "ledgerBalance": 0,
                "preAuthBalance": 0
            },
            {
                "id": "40002",
                "name": "SETTELEMENT",
                "number": "200657505074748",
                "createdDate": "2023-05-02T08:08:45.895Z",
                "updatedDate": "2023-05-02T08:08:45.895Z",
                "balance": 0,
                "holdBalance": 0,
                "customerID": "100000000002001",
                "customerName": "SMALLSYS INC",
                "accountCategory": "LIABILITY",
                "accountType": "SAVINGS",
                "currency": "USD",
                "currencyCode": "840",
                "status": "ACTIVE",
                "institutionID": " 101115315",
                "glAccount": "900208571554444",
                "isVerify": true,
                "ledgerBalance": 0,
                "preAuthBalance": 0
            },
            {
                "id": "37010",
                "name": "SMALLSYS INC",
                "number": "200827300173104",
                "createdDate": "2023-04-28T15:56:04.718Z",
                "updatedDate": "2023-04-28T16:22:41.018Z",
                "balance": 1000,
                "holdBalance": 0,
                "customerID": "100000000002001",
                "customerName": "SMALLSYS INC",
                "accountCategory": "LIABILITY",
                "accountType": "WALLET",
                "currency": "USD",
                "currencyCode": "840",
                "status": "ACTIVE",
                "institutionID": " 101115315",
                "glAccount": "900208571554444",
                "isVerify": true,
                "ledgerBalance": 1000,
                "preAuthBalance": 0
            },
            {
                "id": "22009",
                "name": "Harry",
                "number": "200736754590214",
                "createdDate": "2023-04-26T05:53:59.832Z",
                "updatedDate": "2023-04-26T06:01:01.564Z",
                "balance": 2000,
                "holdBalance": 0,
                "customerID": "100000000000005",
                "customerName": "Hariharan",
                "institutionName": "Mekka",
                "accountCategory": "LIABILITY",
                "accountType": "SAVINGS",
                "currency": "USD",
                "currencyCode": "840",
                "status": "ACTIVE",
                "institutionID": " 101115315",
                "glAccount": "900323903015509",
                "isVerify": true,
                "ledgerBalance": 2000,
                "preAuthBalance": 0
            },
            {
                "id": "22007",
                "name": "John",
                "number": "200392721520675",
                "createdDate": "2023-04-26T05:53:18.548Z",
                "updatedDate": "2023-04-26T06:06:50.561Z",
                "balance": 6700,
                "holdBalance": 0,
                "customerID": "100000000000005",
                "customerName": "Hariharan",
                "institutionName": "Mekka",
                "accountCategory": "LIABILITY",
                "accountType": "SAVINGS",
                "currency": "USD",
                "currencyCode": "840",
                "status": "ACTIVE",
                "institutionID": " 101115315",
                "glAccount": "900323903015509",
                "isVerify": true,
                "ledgerBalance": 6700,
                "preAuthBalance": 0
            },
            {
                "id": "22003",
                "name": "Jone",
                "number": "200468982385682",
                "createdDate": "2023-04-26T05:47:42.403Z",
                "updatedDate": "2023-04-26T05:47:42.403Z",
                "balance": 0,
                "holdBalance": 0,
                "customerID": "100000000000002",
                "customerName": "Hariharan",
                "institutionName": "Mekka",
                "accountCategory": "LIABILITY",
                "accountType": "SAVINGS",
                "currency": "USD",
                "currencyCode": "840",
                "status": "ACTIVE",
                "institutionID": " 101115315",
                "glAccount": "900323903015509",
                "isVerify": true,
                "ledgerBalance": 0,
                "preAuthBalance": 0
            },
            {
                "id": "22001",
                "name": "Smith",
                "number": "200025756210329",
                "createdDate": "2023-04-26T05:46:55.026Z",
                "updatedDate": "2023-04-26T05:46:55.026Z",
                "balance": 0,
                "holdBalance": 0,
                "customerID": "100000000000002",
                "customerName": "Hariharan",
                "institutionName": "Mekka",
                "accountCategory": "LIABILITY",
                "accountType": "SAVINGS",
                "currency": "USD",
                "currencyCode": "840",
                "status": "ACTIVE",
                "institutionID": " 101115315",
                "glAccount": "900323903015509",
                "isVerify": true,
                "ledgerBalance": 0,
                "preAuthBalance": 0
            },
            {
                "id": "17002",
                "name": "ABDahn",
                "number": "200606274640748",
                "createdDate": "2023-04-25T14:37:27.226Z",
                "updatedDate": "2023-04-25T15:32:57.392Z",
                "balance": 2500,
                "holdBalance": 0,
                "customerID": "100000000000005",
                "customerName": "Hariharan",
                "institutionName": "Mekka",
                "accountCategory": "LIABILITY",
                "accountType": "SAVINGS",
                "currency": "USD",
                "currencyCode": "840",
                "status": "ACTIVE",
                "institutionID": " 101115315",
                "glAccount": "900323903015509",
                "isVerify": true,
                "ledgerBalance": 2500,
                "preAuthBalance": 0
            },
            {
                "id": "9009",
                "name": "Ascand",
                "number": "200910222734552",
                "createdDate": "2023-04-25T13:04:19.217Z",
                "updatedDate": "2023-05-02T07:22:27.974Z",
                "balance": 106500,
                "holdBalance": 0,
                "customerID": "100000000000005",
                "customerName": "Hariharan",
                "institutionName": "Mekka",
                "accountCategory": "LIABILITY",
                "accountType": "SAVINGS",
                "currency": "USD",
                "currencyCode": "840",
                "status": "ACTIVE",
                "institutionID": " 101115315",
                "glAccount": "900913752734870",
                "isVerify": true,
                "ledgerBalance": 106500,
                "preAuthBalance": 0
            }
        ],
        "riskScore": 0
    }
}

Get All Accounts

Method: POST​

Headers​

Example​

Body​

Response: 200​

Method: POST

Headers

Example

Body

Response: 200