Create Beneficiary

The CreateBeneficiary API allows users to effortlessly add beneficiaries, facilitating transactions at any time. In this API, the essential beneficiary details are provided to establish a connection with the beneficiary account which is helpful for future transactions without providing the same details again.

Method: POST

{{URL}}/jsonrpc

Headers

Name	Value
Content-Type	application/json

Example

Payload Parameters

Parameter	Description
method Mandatory	String API calling method Ex:"AccountService.CreateBeneficiary "
id Mandatory	String A unique identifier for the request Ex:"1"
params Mandatory	Object
payload Mandatory	Object
accountId Mandatory	String The ID of the account to which the beneficiary is being added Ex:"6253006 "
accountNumber Mandatory	String The beneficiary's account number Ex:"45443422234211 "
accountType Mandatory	String The type of the beneficiary's account Ex:"D "
address Mandatory	Object
country Mandatory	String The country of the beneficiary's address Ex:"US "
bankAddress Mandatory	Object
line1 Mandatory	String The street address of the bank Ex:"99 NORTH STREET "
city Mandatory	String The city where the bank is located Ex:"PITTSFIELD "
zipCode Mandatory	String The postal code of the bank's location Ex:"01201 "
country Mandatory	String The country where the bank is located Ex:"MA "
bankDetail	Object
idType Mandatory	String The type of ID used to identify the bank Ex:"F "
ID Mandatory	String The ID of the bank Ex:"011002725 "
bankName Mandatory	String The name of the bank Ex:"BERKSHIRE BANK "
channel Mandatory	String The channel through which the transaction is being processed Ex:"ACH "
contact	Object
phoneNumber Mandatory	String The beneficiary's phone number Ex:"4676435865 "
email Mandatory	String The beneficiary's email address Ex:"demo@gamil.com "
firstName Mandatory	String The first name of the beneficiary Ex:"Demo "
lastName Mandatory	String The last name of the beneficiary Ex:"S "
legalrepId Mandatory	String The ID of the legal representative associated with the beneficiary Ex:"6253004 "
type Mandatory	String The type of beneficiary Ex:"INDIVIDUAL "
uSCorrespondenBankAddress Mandatory	String Address information for the corresponding US bank Ex:"99 NORTH STREET "
uSCorrespondenBankCity Mandatory	String City of the corresponding US bank Ex:"PITTSFIELD "
uSCorrespondenBankName Mandatory	String Name of the corresponding US bank Ex:"BERKSHIRE BANK "
uSCorrespondentBankID Mandatory	String ID of the corresponding US bank Ex:"011002725 "
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

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-raw '{"method":"AccountService.CreateBeneficiary","id":"1","params":{"payload":{"accountId":"6253006","accountNumber":"45443422234211","accountType":"D","address":{"country":"US"},"bankAddress":{"line1":"99 NORTH STREET","city":"PITTSFIELD","zipCode":"01201","country":"MA"},"bankDetail":{"idType":"F","ID":"011002725","bankName":"BERKSHIRE BANK"},"channel":"ACH","contact":{"phoneNumber":"4676435865","email":"demo@gamil.com"},"firstName":"Demo","lastName":"S","legalrepId":"6253004","type":"INDIVIDUAL","uSCorrespondenBankAddress":"99 NORTH STREET","uSCorrespondenBankCity":"PITTSFIELD","uSCorrespondenBankName":"BERKSHIRE BANK","uSCorrespondentBankID":"011002725"},"api":{"credential":"Basic ay5iYXN1dmFuQGJhbmtjYncub3JnOmUxYWY0Y2ExYzE1MDRiMTNiYzcxZjhlOTY0M2VjZTlj","signature":"MEQCIB50i5KBEVl4iK4SzNyKBqx4jCzB/28mMVNpsWGT69H0AiArVib+De0hEpGvEfo/RY0X7alFUI2vYr48+thrUAB7kw==","apiKey":"5a8b9c2e3d4f1g6h","keyId":"196002"}}}'

C#

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.CreateBeneficiary""," + "\n" +
@"    ""id"": ""1""," + "\n" +
@"    ""params"": {" + "\n" +
@"        ""payload"": {" + "\n" +
@"            ""accountId"": ""6253006""," + "\n" +
@"            ""accountNumber"": ""45443422234211""," + "\n" +
@"            ""accountType"": ""D""," + "\n" +
@"            ""address"": {" + "\n" +
@"                ""country"": ""US""" + "\n" +
@"            }," + "\n" +
@"            ""bankAddress"": {" + "\n" +
@"                ""line1"": ""99 NORTH STREET""," + "\n" +
@"                ""city"": ""PITTSFIELD""," + "\n" +
@"                ""zipCode"": ""01201""," + "\n" +
@"                ""country"": ""MA""" + "\n" +
@"            }," + "\n" +
@"            ""bankDetail"": {" + "\n" +
@"                ""idType"": ""F""," + "\n" +
@"                ""ID"": ""011002725""," + "\n" +
@"                ""bankName"": ""BERKSHIRE BANK""" + "\n" +
@"            }," + "\n" +
@"            ""channel"": ""ACH""," + "\n" +
@"            ""contact"": {" + "\n" +
@"                ""phoneNumber"": ""4676435865""," + "\n" +
@"                ""email"": ""demo@gamil.com""" + "\n" +
@"            }," + "\n" +
@"            ""firstName"": ""Demo""," + "\n" +
@"            ""lastName"": ""S""," + "\n" +
@"            ""legalrepId"": ""6253004""," + "\n" +
@"            ""type"": ""INDIVIDUAL""," + "\n" +
@"            ""uSCorrespondenBankAddress"": ""99 NORTH STREET""," + "\n" +
@"            ""uSCorrespondenBankCity"": ""PITTSFIELD""," + "\n" +
@"            ""uSCorrespondenBankName"": ""BERKSHIRE BANK""," + "\n" +
@"            ""uSCorrespondentBankID"": ""011002725""" + "\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);

Go

package main

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

func main() {

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

  payload := strings.NewReader(`{
    "method": "AccountService.CreateBeneficiary",
    "id": "1",
    "params": {
        "payload": {
            "accountId": "6253006",
            "accountNumber": "45443422234211",
            "accountType": "D",
            "address": {
                "country": "US"
            },
            "bankAddress": {
                "line1": "99 NORTH STREET",
                "city": "PITTSFIELD",
                "zipCode": "01201",
                "country": "MA"
            },
            "bankDetail": {
                "idType": "F",
                "ID": "011002725",
                "bankName": "BERKSHIRE BANK"
            },
            "channel": "ACH",
            "contact": {
                "phoneNumber": "4676435865",
                "email": "demo@gamil.com"
            },
            "firstName": "Demo",
            "lastName": "S",
            "legalrepId": "6253004",
            "type": "INDIVIDUAL",
            "uSCorrespondenBankAddress": "99 NORTH STREET",
            "uSCorrespondenBankCity": "PITTSFIELD",
            "uSCorrespondenBankName": "BERKSHIRE BANK",
            "uSCorrespondentBankID": "011002725"
        },
        "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))
}

NodeJs

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 = JSON.stringify({
  "method": "AccountService.CreateBeneficiary",
  "id": "1",
  "params": {
    "payload": {
      "accountId": "6253006",
      "accountNumber": "45443422234211",
      "accountType": "D",
      "address": {
        "country": "US"
      },
      "bankAddress": {
        "line1": "99 NORTH STREET",
        "city": "PITTSFIELD",
        "zipCode": "01201",
        "country": "MA"
      },
      "bankDetail": {
        "idType": "F",
        "ID": "011002725",
        "bankName": "BERKSHIRE BANK"
      },
      "channel": "ACH",
      "contact": {
        "phoneNumber": "4676435865",
        "email": "demo@gamil.com"
      },
      "firstName": "Demo",
      "lastName": "S",
      "legalrepId": "6253004",
      "type": "INDIVIDUAL",
      "uSCorrespondenBankAddress": "99 NORTH STREET",
      "uSCorrespondenBankCity": "PITTSFIELD",
      "uSCorrespondenBankName": "BERKSHIRE BANK",
      "uSCorrespondentBankID": "011002725"
    },
    "api": {
      "credential": "Basic ay5iYXN1dmFuQGJhbmtjYncub3JnOmUxYWY0Y2ExYzE1MDRiMTNiYzcxZjhlOTY0M2VjZTlj",
      "signature": "MEQCIB50i5KBEVl4iK4SzNyKBqx4jCzB/28mMVNpsWGT69H0AiArVib+De0hEpGvEfo/RY0X7alFUI2vYr48+thrUAB7kw==",
      "apiKey": "5a8b9c2e3d4f1g6h",
      "keyId": "196002"
    }
  }
});

req.write(postData);

req.end();

Body

{
    "method": "AccountService.CreateBeneficiary",
    "id": "1",
    "params": {
        "payload": {
            "accountId": "6253006",
            "accountNumber": "45443422234211",
            "accountType": "D",
            "address": {
                "country": "US"
            },
            "bankAddress": {
                "line1": "99 NORTH STREET",
                "city": "PITTSFIELD",
                "zipCode": "01201",
                "country": "MA"
            },
            "bankDetail": {
                "idType": "F",
                "ID": "011002725",
                "bankName": "BERKSHIRE BANK"
            },
            "channel": "ACH",
            "contact": {
                "phoneNumber": "4676435865",
                "email": "demo@gamil.com"
            },
            "firstName": "Demo",
            "lastName": "S",
            "legalrepId": "6253004",
            "type": "INDIVIDUAL",
            "uSCorrespondenBankAddress": "99 NORTH STREET",
            "uSCorrespondenBankCity": "PITTSFIELD",
            "uSCorrespondenBankName": "BERKSHIRE BANK",
            "uSCorrespondentBankID": "011002725"
        },
        "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
message	String Result message Ex:"Beneficiary added successfully "

{
  "id": "1",
  "result": {
    "message": "Beneficiary added successfully"
  }
}