Version: 1.0.2

List Beneficiary

The ListBeneficiary API allows user to view the list of beneficiaries added to the account, making it easier to manage fund transfers and payments.

Method: POST

{{URL}}/jsonrpc

Headers

Name	Value
Content-Type	application/json

Example

Payload Parameters

Parameter	Description
method Mandatory	String API calling method Ex:"AccountService.ListBeneficiary "
id Mandatory	String A unique identifier for the request Ex:"1"
params Mandatory	Object
payload Mandatory	Object
ID Mandatory	String The ID of the account to which the beneficiary is added Ex:"6253006 "
legalrepId Mandatory	String The ID of the legal representative associated with the beneficiary Ex:"6253004 "
api	Object
credential Mandatory	String API credentials Ex:"Basic ay5iYXN1dmFuQGJhbmtjYncub3JnOmUxYWY0Y2ExYzE1MDRiMTNiYzcxZjhlOTY0M2VjZTlj "
signature Mandatory	String API request signature Ex:"MEQCIB50i5KBEVl4iK4SzNyKBqx4jCzB/28mMVNpsWGT69H0AiArVib+De0hEpGvEfo/RY0X7alFUI2vYr48+thrUAB7kw== "
apiKey Mandatory	String API Key Ex:"5a8b9c2e3d4f1g6h "
keyId Mandatory	String Unique identifier for the key Ex:"196002 "

Parameter

Description

method

Mandatory

String

API calling method

Ex:"AccountService.ListBeneficiary "

Mandatory

String

A unique identifier for the request

Ex:"1"

params

Mandatory

Object

payload

Mandatory

Object

Mandatory

String

The ID of the account to which the beneficiary is added

Ex:"6253006 "

legalrepId

Mandatory

String

The ID of the legal representative associated with the beneficiary

Ex:"6253004 "

api

Object

credential

Mandatory

String

API credentials

Ex:"Basic ay5iYXN1dmFuQGJhbmtjYncub3JnOmUxYWY0Y2ExYzE1MDRiMTNiYzcxZjhlOTY0M2VjZTlj "

signature

Mandatory

String

API request signature

Ex:"MEQCIB50i5KBEVl4iK4SzNyKBqx4jCzB/28mMVNpsWGT69H0AiArVib+De0hEpGvEfo/RY0X7alFUI2vYr48+thrUAB7kw== "

apiKey

Mandatory

String

API Key

Ex:"5a8b9c2e3d4f1g6h "

keyId

Mandatory

String

Unique identifier for the key

Ex:"196002 "

cURL
C#
Go
NodeJs

curl --location 'https://{{url}}/jsonrpc' \
--header 'DeviceID: 8020' \
--header 'Signature: keyId=8020,algorithm=ecdsa-sha256,signature=MEUCIQDCAmGoL10Hmoaayf6s3WOaLbH71sX8phXT07xw24zYgAIgDWcai46aH6jhcVv3rjg4avyhi77mXjsrg3bQxmBVih4=' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic ci5hbmJhbGFnYW5AbmV0eGQuY29tOmQ0Mjc2ZmIx' \
--data '{"method":"AccountService.ListBeneficiary","id":"1","params":{"payload":{"ID":"6253006","LegalRepId":"6253004"},"api":{"credential":"Basic ay5iYXN1dmFuQGJhbmtjYncub3JnOmUxYWY0Y2ExYzE1MDRiMTNiYzcxZjhlOTY0M2VjZTlj","signature":" MEQCIB50i5KBEVl4iK4SzNyKBqx4jCzB/28mMVNpsWGT69H0AiArVib+De0hEpGvEfo/RY0X7alFUI2vYr48+thrUAB7kw==","apiKey":"5a8b9c2e3d4f1g6h ","keyId":"196002"}}}'

var options = new RestClientOptions("{{url}}")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("/PLMASTER/jsonrpc", Method.Post);
request.AddHeader("DeviceID", "8020");
request.AddHeader("Signature", "keyId=8020,algorithm=ecdsa-sha256,signature=MEUCIQDCAmGoL10Hmoaayf6s3WOaLbH71sX8phXT07xw24zYgAIgDWcai46aH6jhcVv3rjg4avyhi77mXjsrg3bQxmBVih4=");
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Basic ci5hbmJhbGFnYW5AbmV0eGQuY29tOmQ0Mjc2ZmIx");
var body = @"{" + "\n" +
@"    ""method"": ""AccountService.ListBeneficiary""," + "\n" +
@"    ""id"": ""1""," + "\n" +
@"    ""params"": {" + "\n" +
@"        ""payload"": {" + "\n" +
@"            ""ID"": ""6253006""," + "\n" +
@"            ""LegalRepId"": ""6253004""" + "\n" +
@"        }," + "\n" +
@"        ""api"": {" + "\n" +
@"            ""credential"": "" Basic ay5iYXN1dmFuQGJhbmtjYncub3JnOmUxYWY0Y2ExYzE1MDRiMTNiYzcxZjhlOTY0M2VjZTlj ""," + "\n" +
@"            ""signature"": "" MEQCIB50i5KBEVl4iK4SzNyKBqx4jCzB/28mMVNpsWGT69H0AiArVib+De0hEpGvEfo/RY0X7alFUI2vYr48+thrUAB7kw=="",""," + "\n" +
@"            ""apiKey"": ""5a8b9c2e3d4f1g6h ""," + "\n" +
@"            ""keyId"": ""196002""" + "\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 := "https://{{url}}/jsonrpc"
  method := "POST"

  payload := strings.NewReader(`{
    "method": "AccountService.ListBeneficiary",
    "id": "1",
    "params": {
        "payload": {
            "ID": "6253006",
            "LegalRepId": "6253004"
        },
        "api": {
            "credential": " Basic ay5iYXN1dmFuQGJhbmtjYncub3JnOmUxYWY0Y2ExYzE1MDRiMTNiYzcxZjhlOTY0M2VjZTlj ",
            "signature": " MEQCIB50i5KBEVl4iK4SzNyKBqx4jCzB/28mMVNpsWGT69H0AiArVib+De0hEpGvEfo/RY0X7alFUI2vYr48+thrUAB7kw==",",
            "apiKey": "5a8b9c2e3d4f1g6h ",
            "keyId": "196002"
        }
    }
}`)

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

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("DeviceID", "8020")
  req.Header.Add("Signature", "keyId=8020,algorithm=ecdsa-sha256,signature=MEUCIQDCAmGoL10Hmoaayf6s3WOaLbH71sX8phXT07xw24zYgAIgDWcai46aH6jhcVv3rjg4avyhi77mXjsrg3bQxmBVih4=")
  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("Authorization", "Basic ci5hbmJhbGFnYW5AbmV0eGQuY29tOmQ0Mjc2ZmIx")

  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': '/PLMASTER/jsonrpc',
  'headers': {
    'DeviceID': '8020',
    'Signature': 'keyId=8020,algorithm=ecdsa-sha256,signature=MEUCIQDCAmGoL10Hmoaayf6s3WOaLbH71sX8phXT07xw24zYgAIgDWcai46aH6jhcVv3rjg4avyhi77mXjsrg3bQxmBVih4=',
    'Content-Type': 'application/json',
    'Authorization': 'Basic ci5hbmJhbGFnYW5AbmV0eGQuY29tOmQ0Mjc2ZmIx'
  },
  '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 =  "{\n    \"method\": \"AccountService.ListBeneficiary\",\n    \"id\": \"1\",\n    \"params\": {\n        \"payload\": {\n            \"ID\": \"6253006\",\n            \"LegalRepId\": \"6253004\"\n        },\n        \"api\": {\n            \"credential\": \" Basic ay5iYXN1dmFuQGJhbmtjYncub3JnOmUxYWY0Y2ExYzE1MDRiMTNiYzcxZjhlOTY0M2VjZTlj \",\n            \"signature\": \" MEQCIB50i5KBEVl4iK4SzNyKBqx4jCzB/28mMVNpsWGT69H0AiArVib+De0hEpGvEfo/RY0X7alFUI2vYr48+thrUAB7kw==\",\",\n            \"apiKey\": \"5a8b9c2e3d4f1g6h \",\n            \"keyId\": \"196002\"\n        }\n    }\n}";

req.write(postData);

req.end();

Body

{
    "method": "AccountService.ListBeneficiary",
    "id": "1",
    "params": {
        "payload": {
            "ID": "6253006",
            "LegalRepId": "6253004"
        },
        "api": {
            "credential": " Basic ay5iYXN1dmFuQGJhbmtjYncub3JnOmUxYWY0Y2ExYzE1MDRiMTNiYzcxZjhlOTY0M2VjZTlj ",
            "signature": " MEQCIB50i5KBEVl4iK4SzNyKBqx4jCzB/28mMVNpsWGT69H0AiArVib+De0hEpGvEfo/RY0X7alFUI2vYr48+thrUAB7kw==",",
            "apiKey": "5a8b9c2e3d4f1g6h ",
            "keyId": "196002"
        }
    }
}

Response: 200

Response Parameters

Parameter	Description
id	String Unique identifier of the response Ex:"1 "
result	Object
beneficiarys	Array
ID	String Unique identifier of beneficiary. Ex:"64d0a3407ac4a0e36bd73553 "
createdDate	String Date and time of creation Ex:"2023-08-07T07:54:40.209Z "
updatedDate	String Date and time of last update Ex:"2023-08-07T07:54:40.209Z "
type	String The type of beneficiary Ex:"INDIVIDUAL "
firstName	String The first name of the beneficiary Ex:"Demo "
lastName	String The last name of the beneficiary Ex:"S "
accountNumber	String The beneficiary's account number Ex:"45443422234211 "
accountType	String The type of the beneficiary's account Ex:"D "
contact	Object
email	String The beneficiary's email address Ex:"demo@gamil.com "
phoneNumber	String The beneficiary's phone number Ex:"4676435865 "
address	Object
country	String The country of the beneficiary's address Ex:"US "
bankAddress	Object
line1	String The street address of the bank Ex:"99 NORTH STREET "
city	String The city where the bank is located Ex:"PITTSFIELD "
zipCode	String The postal code of the bank's location Ex:"01201 "
country	String The country where the bank is located Ex:"MA "
bankDetail	Object
idType	String The type of ID used to identify the bank Ex:"F "
ID	String The ID of the bank Ex:"011002725 "
bankName	String The name of the bank Ex:"BERKSHIRE BANK "
createdBy	String Email of the creator Ex:"enableallaccount_rep@netxd.com "
accountId	String The ID of the account to which the beneficiary is being added Ex:"6253006 "
legalrepId	String The ID of the legal representative associated with the beneficiary Ex:"6253004 "
status	String Beneficiary status Ex:"DISABLED "
uSCorrespondentBankID	String ID of the corresponding US bank Ex:"011002725 "
channel	String The channel through which the transaction is being processed Ex:"ACH "

{
  "id": "1",
  "result": {
    "beneficiarys": [
      {
        "ID": "64d0a3407ac4a0e36bd73553",
        "createdDate": "2023-08-07T07:54:40.209Z",
        "updatedDate": "2023-08-07T07:54:40.209Z",
        "type": "INDIVIDUAL",
        "firstName": "Demo",
        "lastName": "S",
        "accountNumber": "45443422234211",
        "accountType": "D",
        "contact": {
          "email": "demo@gamil.com",
          "phoneNumber": "4676435865"
        },
        "address": {
          "country": "US"
        },
        "bankAddress": {
          "line1": "99 NORTH STREET",
          "city": "PITTSFIELD",
          "country": "MA",
          "zipCode": "01201"
        },
        "bankDetail": {
          "idType": "F",
          "ID": "011002725",
          "bankName": "BERKSHIRE BANK"
        },
        "createdBy": "enableallaccount_rep@netxd.com",
        "accountId": "6253006",
        "legalRepId": "6253004",
        "status": "DISABLED",
        "uSCorrespondentBankID": "011002725",
        "channel": "ACH"
      },
      {
        "ID": "64d0a2d37ac4a0e36bd73550",
        "createdDate": "2023-08-07T07:52:51.646Z",
        "updatedDate": "2023-08-07T07:52:51.646Z",
        "type": "INDIVIDUAL",
        "firstName": "Demo",
        "lastName": "S",
        "accountNumber": "45443422234211",
        "accountType": "D",
        "contact": {
          "email": "demo@gamil.com",
          "phoneNumber": "4676435865"
        },
        "address": {
          "country": "US"
        },
        "bankAddress": {
          "line1": "99 NORTH STREET",
          "city": "PITTSFIELD",
          "country": "MA",
          "zipCode": "01201"
        },
        "bankDetail": {
          "idType": "F",
          "ID": "011002725",
          "bankName": "BERKSHIRE BANK"
        },
        "createdBy": "enableallaccount_rep@netxd.com",
        "accountId": "6253006",
        "legalRepId": "6253004",
        "status": "ACTIVE",
        "uSCorrespondentBankID": "011002725",
        "channel": "ACH"
      }
    ]
  }
}

List Beneficiary

Method: POST​

Headers​

Example​

Body​

Response: 200​

Method: POST

Headers

Example

Body

Response: 200