Get all Beneficiaries by filter

The Get all Beneficiaries by filter API is used to fetch beneficiaries based on the provided filter criteria. The response provides details about the beneficiaries that match the filter criteria. Supporting filter values: Name, Type and publickey (isInternal, IsExternal or both).

Method: POST

{{URL}}/jsonrpc

Headers

Name	Value
Content-Type	application/json

Example

Payload Parameters

Parameter	Description
type Mandatory	String The type of beneficiary Ex:"BUSINESS ", "INDIVIDUAL"
customerID Mandatory	String The customer ID associated with the beneficiaries Ex:"100000000048001 "
firstName Mandatory	String The first name of the beneficiary Ex:"chenna "

cURL

curl --location 'https://wallet.netxd.com/plwallet/rpc/WalletService/GetAllBeneficiariesByFilter' \
--header 'DeviceID: 8020' \
--header 'Signature: keyId=8020,algorithm=ecdsa-sha256,signature=MEUCIQCNi1vjPf/HpI9R2DXnc0Zt1s6YmWyA4H1x813lJ+tuDgIgB+lrc+iCMyTUGiraG9kGKNDXYiz7RfBBtifr5wUQs54=' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic ci5hbmJhbGFnYW5AbmV0eGQuY29tOmQ0Mjc2ZmIx' \
--data '{"type":"INDIVIDUAL","customerID":"100000000048001","firstName":"chenna"}'

C#

var options = new RestClientOptions("https://wallet.netxd.com")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("/plwallet/rpc/WalletService/GetAllBeneficiariesByFilter", Method.Post);
request.AddHeader("DeviceID", "8020");
request.AddHeader("Signature", "keyId=8020,algorithm=ecdsa-sha256,signature=MEUCIQCNi1vjPf/HpI9R2DXnc0Zt1s6YmWyA4H1x813lJ+tuDgIgB+lrc+iCMyTUGiraG9kGKNDXYiz7RfBBtifr5wUQs54=");
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Basic ci5hbmJhbGFnYW5AbmV0eGQuY29tOmQ0Mjc2ZmIx");
var body = @"{" + "\n" +
@"    ""type"": ""INDIVIDUAL""," + "\n" +
@"    ""customerID"": ""100000000048001""," + "\n" +
@"    ""firstName"": ""chenna""" + "\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 := "https://wallet.netxd.com/plwallet/rpc/WalletService/GetAllBeneficiariesByFilter"
  method := "POST"

  payload := strings.NewReader(`{
    "type": "INDIVIDUAL",
    "customerID": "100000000048001",
    "firstName": "chenna"
}`)

  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=MEUCIQCNi1vjPf/HpI9R2DXnc0Zt1s6YmWyA4H1x813lJ+tuDgIgB+lrc+iCMyTUGiraG9kGKNDXYiz7RfBBtifr5wUQs54=")
  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))
}

NodeJs

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

var options = {
  'method': 'POST',
  'hostname': 'wallet.netxd.com',
  'path': '/plwallet/rpc/WalletService/GetAllBeneficiariesByFilter',
  'headers': {
    'DeviceID': '8020',
    'Signature': 'keyId=8020,algorithm=ecdsa-sha256,signature=MEUCIQCNi1vjPf/HpI9R2DXnc0Zt1s6YmWyA4H1x813lJ+tuDgIgB+lrc+iCMyTUGiraG9kGKNDXYiz7RfBBtifr5wUQs54=',
    '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 = JSON.stringify({
  "type": "INDIVIDUAL",
  "customerID": "100000000048001",
  "firstName": "chenna"
});

req.write(postData);

req.end();

Body

{
    "type": "INDIVIDUAL",
    "customerID": "100000000048001",
    "firstName": "chenna"
}

Response: 200

Response Parameters

Parameter	Description
ID	String The unique identifier of the beneficiary Ex:"64df5232c20b02dd327ac476 "
createdDate	String The date when the beneficiary was created Ex:"0001-01-01T00:00:00Z "
updatedDate	String The date when the beneficiary was last updated. Ex:"0001-01-01T00:00:00Z"
type	String The type of beneficiary Ex:"BUSINESS","INDIVIDUAL "
firstName	String The first name of the beneficiary Ex:"Chenna "
lastName	String The last name of the beneficiary Ex:"Reddy "
address	Object
state	String State of the beneficiary Ex:"WA "
country	String Country of the beneficiary Ex:"US "
publicKey	String The public key associated with the beneficiary Ex:"GCLOH3OZLQBYROBHAQIK4B7DCC3PLRKJJYTEU3NB6QH23SSTBHUOIDN4 "
isInternal	Boolean Indicates whether the beneficiary is internal (true) or external (false) Ex: true

[
  {
    "ID": "64df5232c20b02dd327ac476",
    "createdDate": "0001-01-01T00:00:00Z",
    "updatedDate": "0001-01-01T00:00:00Z",
    "type": "INDIVIDUAL",
    "firstName": "Chenna",
    "lastName": "Reddy",
    "address": {
      "state": "WA",
      "country": "US"
    },
    "publicKey": "GCLOH3OZLQBYROBHAQIK4B7DCC3PLRKJJYTEU3NB6QH23SSTBHUOIDN4",
    "isInternal": true
  },
  {
    "ID": "64de27c59997a439f57f7c28",
    "createdDate": "0001-01-01T00:00:00Z",
    "updatedDate": "0001-01-01T00:00:00Z",
    "type": "INDIVIDUAL",
    "firstName": "Chenna",
    "lastName": "Reddy",
    "address": {
      "state": "WA",
      "country": "US"
    },
    "publicKey": "GCTKBYEFT6R2Z637KCGHWIZXV5EHGWPDWOIQJ4RJ7EFOXU6DPD4ZRRZS",
    "isInternal": false
  },
  {
    "ID": "64de269a47ac2edaa7591ad1",
    "createdDate": "0001-01-01T00:00:00Z",
    "updatedDate": "0001-01-01T00:00:00Z",
    "type": "INDIVIDUAL",
    "firstName": "Chenna",
    "lastName": "Reddy",
    "address": {
      "state": "WA",
      "country": "US"
    },
    "publicKey": "GBMB2QDVR7QBFLHRTY4A3A7LXJJZR7EXWZMZR26BWBRDPFDR2EAEU4K6",
    "isInternal": false
  }
]