Allocate Virtual Receiving Account

Auto Allocate virtual receiving accounts for per currency Approach.

Definition

URL

POST https://api-test.instarem.com:4803/api/v1/client/{clientId}/virtualReceivingAccount/autoAllocation

Header Parameters:

Parameter	Description	Type	Required
authorization	Authentication token.	String	Yes
content-type	The Content-Type entity header is used to indicate the media type of the resource. Expected values could be application/json or multipart/form-data.	String	Yes

Path Parameters:

Parameter	Description	Type	Required
clientId	This is the unique client ID generated by Nium.	String	Yes

Example Request:

Bash

curl --location --request POST 'https://api-test.instarem.com:4803/api/v1/client/{clientId}/virtualReceivingAccount/autoAllocation' \\
--header 'Content-Type: application/json' \\
--header 'authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2NjUyMTA2OTgsImRhdGEiOnsiY2xpZW50IjoiNjJjODI4MzBmOTdmNjgzNDBhZDkyMzMyIiwiY3JlZElkIjoiNjJjODI4MzBmOTdmNjgxNTUxZDkyMzM4Iiwic3ViIjoiNjJjODI4MzBmOTdmNjgwM2NkZDkyMzM5In0sImlhdCI6MTY2NTEyNDI5OH0.Sj5uQJrr-IwHrelTYRirOy5d09NDpFEIv_cvhhHlzWw' \\
--data-raw '{    
    "currencyCode": "HKD",    
    "vraApproach": "PER_CURRENCY",    
    "label": "LOCAL",    
    "retryRequest": false,    
    "payerId": "393af51e-b2b1-4e65-85ea-9fb256bdb0d8"
}'

Javascript

var data = JSON.stringify({
    "currencyCode": "USD",
    "vraApproach": "PER_CURRENCY",
    "label": "LOCAL",
    "retryRequest": false
});

var xhr = new XMLHttpRequest();
xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});
xhr.open("post", "https://api-test.instarem.com:4803/api/v1/client/{clientId}/virtualReceivingAccount/autoAllocation");
xhr.setRequestHeader("authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0OTgxMzQ4OTQsImRhdGEiOnsic3ViIjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWE1IiwiY2xpZW50IjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWExIn0sImlhdCI6MTQ5ODA0ODQ5NH0.pevwSDpk-JDNtVIpqFu_m0Xu1UnDVumrAYStcrxf8sM");
xhr.setRequestHeader("content-type", "application/json");
xhr.send(data);

C#

var client = new RestClient("https://api-test.instarem.com:4803/api/v1/client/{clientId}/virtualReceivingAccount/autoAllocation");
var request = new RestRequest(Method.POST);
request.AddHeader("authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0OTgxMzQ4OTQsImRhdGEiOnsic3ViIjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWE1IiwiY2xpZW50IjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWExIn0sImlhdCI6MTQ5ODA0ODQ5NH0.pevwSDpk-JDNtVIpqFu_m0Xu1UnDVumrAYStcrxf8sM");
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", @"{
    ""currencyCode"": ""USD"",
    ""vraApproach"": ""PER_CURRENCY"",
    ""label"": ""LOCAL"",
    ""retryRequest"": false
}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Body Parameters:

Parameter	Description	Type	Required
currencyCode	Currency code. This is a 3-digit currency code.	String	Yes
vraApproach	VRA Approach can be PER_CURRENCY , PER_PAYER.	String	No
label	The type for virtual receiving account used for VRA allocation and value for this could be LOCAL or GLOBAL or LOCAL,GLOBAL.	String	Yes
retryRequest	Retry for failed request currencies EUR, GBP and AUD send this value as true else send it as false.(DEPRECATED)	Boolean	No
payerId	This is the unique id for the Payer generated by Nium. This is required only if you want to allocate virtual account to the payer.	String	Conditional

Response:

{
    "virtualReceivingAccountId": "1b1542f8-c5b2-484d-b0c4-c78710dd84a3",
    "virtualReceivingAccount": "9675538220127460",
    "bankAccountName": "NIUM PTE LTD",
    "bankName": "CITIBANK NA",
    "bankAddress": "21-00, Asia Square Tower 1, 5 Marina View Singapore,Post_Zip code - 018960",
    "bankRoutingDetails": {
        "routing_code_1": "SWIFT",
        "routing_value_1": "CITISGSG"
    },
    "status": "COMPLETED",
    "message": "VRA allocated successfully",
    "virtualReceivingAccountRequestId": "10791607420958660",
    "accountNumber": "227961469275"
}

Response Parameters:

Parameter	Description	Type
virtualReceivingAccountId	Unique uuid generated by ID generated by Nium.	String
virtualReceivingAccount	Virtual Receiving Account Number.	String
bankAccountName	Name of the Beneficiary.	String
bankName	Name of the Bank.	String
bankAddress	Address of the Bank.	String
bankRoutingDetails.routing_code_1	Routing code type. Example: IFSC for India, SORT CODE for UK, ABA CODE for USA, BIC CODE for Europe.	String
bankRoutingDetails.routing_value_1	The routing code value. Example: SBIN0000058 for IFSC Code, 259087 for SORT CODE, 111000025 for ABA CODE, LIABLT20001 for BIC CODE.	String
bankRoutingDetails.routing_code_2	Routing code type. Example: IFSC for India, SORT CODE for UK, ABA CODE for USA, BIC CODE for Europe.	String
bankRoutingDetails.routing_value_2	The routing code value. Example: SBIN0000058 for IFSC Code, 259087 for SORT CODE, 111000025 for ABA CODE, LIABLT20001 for BIC CODE.	String
status	Status of the virtual receiving account request. Status can be REQUESTED, COMPLETED.	String
message	This message will have additional information for virtual receiving account request.	String
virtualReceivingAccountRequestId	When the virtual account is in requested status, Nium generates unique request id for each request. Applicable for the currencies: EUR, GBP, and AUD. For remaining currencies this field will be blank.	String
accountNumber	Returns 12 digit account number generated by Nium	String