Virtual Receiving Account Status Update

Virtual Receiving Account Status Update webhook is triggered when there is an update in the status of the virtual account. During the Allocate virtual receiving account API, if you get Requested as a status, you can integrate with this webhook to get notified when the account creation is completed.

URL

https://<customerHost:Port>/webhook

Header Parameters:

Parameter	Description	Type
content-type	The Content-Type entity header is used to indicate the media type of the resource. Expected values could be application/json.	String
x-api-key	f9be0d9e-6903-4862-8d69-5b2651426bf9	String

Example Request:

Bash

curl --location --request POST 'https://<customerHost:Port>/webhook' \
--header 'Content-Type: application/json' \
--header 'x-api-key: f9be0d9e-6903-4862-8d69-5b2651426bf9' \
--data-raw '{
    "clientId": "593feb7c5g32bb2357b2df6c",
    "virtualReceivingAccountId": "62616d73-8e19-4522-8eac-e456a68b11ab",
    "virtualReceivingAccountRequestId": "10791607420958660",
    "status": "COMPLETED",
    "event": "VRA_STATUS_UPDATE",
    "timestamp": "2021-08-05T10:01:07.236Z"
}'

Javascript

var data = JSON.stringify({
    "clientId": "593feb7c5g32bb2357b2df6c",
    "virtualReceivingAccountId": "62616d73-8e19-4522-8eac-e456a68b11ab",
    "virtualReceivingAccountRequestId": "10791607420958660",
    "status": "COMPLETED",
    "event": "VRA_STATUS_UPDATE",
    "timestamp": "2021-08-05T10:01:07.236Z"
})
var xhr = new XMLHttpRequest();
xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});
xhr.open("post", "https://<customerHost:Port>/webhook")
xhr.setRequestHeader("content-type", "application/json");
xhr.setRequestHeader("x-api-key", "f9be0d9e-6903-4862-8d69-5b2651426bf9");
xhr.send(data);

C#

var client = new RestClient("https://<customerHost:Port>/webhook");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json");
request.AddHeader("x-api-key", "f9be0d9e-6903-4862-8d69-5b2651426bf9");
request.AddParameter("application/json", @"{
    ""clientId"": ""593feb7c5g32bb2357b2df6c"",
    ""virtualReceivingAccountId"": ""62616d73-8e19-4522-8eac-e456a68b11ab"",
    ""virtualReceivingAccountRequestId"": ""10791607420958660"",
    ""status"": ""COMPLETED"",
    ""event"": ""VRA_STATUS_UPDATE"",
    ""timestamp"": ""2021-08-05T10:01:07.236Z""
}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Body Parameters:

Parameter	Description	Type
clientId	This is the unique client Id generated by Nium.	String
virtualReceivingAccountId	This is the unique virtual receiving account Id generated by Nium.	String
virtualReceivingAccountRequestId	This is the unique request id for per request against currency: EUR, GBP, AUD.	String
status	Status of virtual receiving account request raised by client. Valid values are COMPLETED and FAILED.	String
event	Event name. This event will be triggered when there is an update in the status of the virtual account request.	String
timestamp	Date and time (UTC) of Virtual Account Creation.	String