Approve the Beneficiary
The Approve the Beneficiary API is used to approve or decline beneficiary tickets that were created for adding beneficiaries. This API is used by legal representatives who have the "CanApproveBeneficiary" permission. The API allows the approval or decline of beneficiary tickets. If approved, the beneficiary entity is created based on the information provided in the ticket.
Method: POST
{{URL}}/jsonrpc
Headers
Name | Value |
---|---|
Content-Type | application/json |
Example
Payload Parameters
Parameter | Description |
---|---|
RequestID Mandatory | String API calling method Ex:"305001 " |
reason Mandatory | String API calling method Ex:"test " |
status Mandatory | String API calling method Ex:"APPROVED " |
customerID Mandatory | String API calling method Ex:"100000000048001 " |
- cURL
- C#
- Go
- NodeJs
curl --location 'https://wallet.netxd.com/plwallet/rpc/WalletService/ApproveTheBeneficiary' \
--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 '{"RequestID":"305001","reason":"test","status":"APPROVED","customerID":"100000000048001"}'
var options = new RestClientOptions("https://wallet.netxd.com")
{
MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("/plwallet/rpc/WalletService/ApproveTheBeneficiary", 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" +
@" ""RequestID"": ""305001""," + "\n" +
@" ""reason"": ""test""," + "\n" +
@" ""status"": ""APPROVED""," + "\n" +
@" ""customerID"": ""100000000048001""" + "\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://wallet.netxd.com/plwallet/rpc/WalletService/ApproveTheBeneficiary"
method := "POST"
payload := strings.NewReader(`{
"RequestID": "305001",
"reason": "test",
"status": "APPROVED",
"customerID": "100000000048001"
}`)
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))
}
var https = require('follow-redirects').https;
var fs = require('fs');
var options = {
'method': 'POST',
'hostname': 'wallet.netxd.com',
'path': '/plwallet/rpc/WalletService/ApproveTheBeneficiary',
'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({
"RequestID": "305001",
"reason": "test",
"status": "APPROVED",
"customerID": "100000000048001"
});
req.write(postData);
req.end();
Body
{
"RequestID": "305001",
"reason": "test",
"status": "APPROVED",
"customerID": "100000000048001"
}
Response: 200
Response Parameters
Parameter | Description |
---|---|
ID | String Unique identifier of the beneficiary entity that was created upon approval Ex:"64de07852665cd17cdfd5f55 " |
createdDate | String Timestamp indicating when the beneficiary entity was created Ex:"2023-08-17T11:41:57.163Z " |
updatedDate | String Timestamp indicating the most recent update to the beneficiary entity Ex:"0001-01-01T00:00:00Z " |
type | String Type of beneficiary Ex:"BUSINESS, INDIVIDUAL " |
firstName | String First name of the beneficiary Ex:"Chenna " |
lastName | String Last name of the beneficiary Ex:"Reddy " |
accountType | String Account type Ex:"DIGITALASSET " |
contact | Object |
String Email address of the beneficiary Ex:"chennareddy.s+099@netxd.com " | |
phoneNumber | String Phone number of the beneficiary Ex:"1234567890 " |
address | Object |
line1 | String Address line 1 Ex:"alaska " |
city | String City of the beneficiary's address Ex:"Seattle " |
state | String State of the beneficiary's address Ex:"WA " |
country | String Country of the beneficiary's address Ex:"US " |
zipCode | String Zip code of the beneficiary's address Ex:"98104 " |
bankDetail | Object |
bankName | String Name of the bank Ex:"NETXD " |
createdBy | String Email address of the user who created the beneficiary Ex:"chennareddy.s+106@netxd.com " |
accountId | String Account ID of the beneficiary Ex:"1614001 " |
status | String Status of the beneficiary Ex:"ACTIVE " |
customerID | String Unique identifier of the customer associated with the beneficiary Ex:"100000000048001 " |
Message | String Message indicating the success of the beneficiary approval process Ex:"Beneficiary Approved Successfully " |
publicKey | String Public key associated with the beneficiary Ex:"GBMB2QDVR7QBFLHRTY4A3A7LXJJZR7EXWZMZR26BWBRDPFDR2EAEU4K6 " |
network | String Network associated with the beneficiary Ex:"STELLER " |
ceResponse | Object |
result | String Context Engine watchlist result Ex:"success " |
detail | String Context Engine watchlist details Ex:"success " |
risk | Object |
riskScore | String Risk score of the beneficiary Ex:"0 " |
ofac | Object |
watchList | Object |
INDIVIDUALTransactionNumber | String Individual Transaction number Ex:"1707 " |
beneficiaryAccountDetails | Object |
accountId | String Account ID of the beneficiary Ex:"1614001 " |
accountName | String Unique Ex:"Name of the beneficiary's account " |
customerID | String Unique identifier of the customer associated with the beneficiary Ex:"100000000048001 " |
customerName | String Name of the customer associated with the beneficiary Ex:"NETXDNETXD " |
{
"ID": "64de07852665cd17cdfd5f55",
"createdDate": "2023-08-17T11:41:57.163Z",
"updatedDate": "0001-01-01T00:00:00Z",
"type": "INDIVIDUAL",
"firstName": "Chenna",
"lastName": "Reddy",
"accountType": "DIGITALASSET",
"contact": {
"email": "chennareddy.s+099@netxd.com",
"phoneNumber": "1234567890"
},
"address": {
"line1": "alaska",
"city": "Seattle",
"state": "WA",
"country": "US",
"zipCode": "98104"
},
"bankDetail": {
"bankName": "NETXD"
},
"createdBy": "chennareddy.s+106@netxd.com",
"accountId": "1614001",
"status": "ACTIVE",
"customerID": "100000000048001",
"Message": "Beneficiary Approved Successfully",
"publicKey": "GBMB2QDVR7QBFLHRTY4A3A7LXJJZR7EXWZMZR26BWBRDPFDR2EAEU4K6",
"network": "STELLER",
"ceResponse": {
"result": "success",
"detail": "success",
"risk": {
"riskScore": "0"
},
"ofac": {},
"watchList": {},
"INDIVIDUALTransactionNumber": "1707"
},
"beneficiaryAccountDetails": {
"accountId": "1614001",
"accountName": "channelAccountsStatus3",
"customerID": "100000000048001",
"customerName": "NETXDNETXD"
}
}