Get Virtual Receiving Accounts

Get all the virtual receiving accounts and currencies details.

Definition

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

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

Query Parameters:

Parameter	Description	Type	Required
payerId	This is the unique payer ID generated by Nium is used to fetch virtual receiving accounts based on payerId	String	No
currencyCode	This is the currency code used to fetch virtual receiving accounts based on currency	String	No
virtualReceivingAccountId	This is the unique virtual receiving account ID generated by Nium.	String	No
virtualReceivingAccountRequestId	This is the unique request id for per request against currency: EUR, GBP, AUD	String	No

Example Request:

Bash
Javascript
C#

curl --request get \\
--url "https://api-test.instarem.com:4803/api/v1/client/{clientId}/virtualReceivingAccount?payerId=&currencyCode=" \\
--header 'authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0OTgxMzQ4OTQsImRhdGEiOnsic3ViIjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWE1IiwiY2xpZW50IjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWExIn0sImlhdCI6MTQ5ODA0ODQ5NH0.pevwSDpk-JDNtVIpqFu_m0Xu1UnDVumrAYStcrxf8sM' \\
--header 'content-type: application/json'

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

var client = new RestClient("https://api-test.instarem.com:4803/api/v1/client/{clientId}/virtualReceivingAccount?payerId=&currencyCode=");
var request = new RestRequest(Method.GET);
request.AddHeader("authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0OTgxMzQ4OTQsImRhdGEiOnsic3ViIjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWE1IiwiY2xpZW50IjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWExIn0sImlhdCI6MTQ5ODA0ODQ5NH0.pevwSDpk-JDNtVIpqFu_m0Xu1UnDVumrAYStcrxf8sM");
request.AddHeader("content-type", "application/json");
IRestResponse response = client.Execute(request);

Response (200):

[
  {
    "label": "LOCAL",
    "currencyCode": "AUD",
    "currency": "AUD",
    "accountNumber": "170561429342",
    "totalVirtualAccounts": 1,
    "virtualAccounts": [
      {
        "virtualReceivingAccount": "9675538220127460",
        "virtualReceivingAccountId": "1b1542f8-c5b2-484d-b0c4-c78710dd84a3",
        "requestedVirtualAccount": null,
        "bankAccountName": "NIUM PTY LTD",
        "bankName": "Cuscal Limited",
        "bankAddress": "MUMLevel 6_99 Pacific Highway, North Sydney NSW 2060BAI",
        "payId": "abc@nium.com",
        "bankRoutingDetails": {
          "routing_code_1": "BSB Code",
          "routing_value_1": "802986"
        },
        "payerId": "d3bd1428-fbbc-4267-a931-e97bd0843dca",
        "payerCompanyName": "Instarem India Pvt Ltd",
        "payerName": "John Doe",
        "payerEmail": "john.doe@nium.com",
        "payerType": "COMPANY"
      }
    ]
  },
  {
    "label": "GLOBAL",
    "currencyCode": "USD",
    "currency": "USD",
    "accountNumber": "227961469275",
    "totalVirtualAccounts": 1,
    "virtualAccounts": [
      {
        "virtualReceivingAccount": "79974100000",
        "virtualReceivingAccountId": "69fd78c0-b2a8-499f-85e9-078302115bd4",
        "requestedVirtualAccount": null,
        "bankAccountName": "NIUM PTE LTD",
        "bankName": "CITIBANK NA",
        "bankAddress": "21-00, Asia Square Tower 1, 8 Marina View Singapore,Post_Zip code - 018960",
        "bankRoutingDetails": {
          "routing_code_1": "SWIFT Code",
          "routing_value_1": "CITISGSH"
        },
        "payerId": "036cfcd6-090b-42be-b87a-9f782f1189ed",
        "payerCompanyName": "Instarem India Pvt Ltd",
        "payerName": "Chris Kilcline",
        "payerEmail": "chris.kilcline@nium.com",
        "payerType": "COMPANY"
      }
    ]
  },
  {
    "label": "LOCAL",
    "currencyCode": "GBP",
    "currency": "GBP",
    "accountNumber": null,
    "totalVirtualAccounts": 0,
    "virtualAccounts": [
      {
        "virtualReceivingAccount": null,
        "virtualReceivingAccountId": null,
        "requestedVirtualAccount": {
          "virtualReceivingAccountRequestId": "10791607420958660",
          "status": "REQUESTED",
          "createdAt": "2020-12-08T09:49:18.227Z"
        },
        "bankAccountName": null,
        "bankName": null,
        "bankAddress": null,
        "bankRoutingDetails": null,
        "payerId": null,
        "payerCompanyName": null,
        "payerName": null,
        "payerEmail": null,
        "payerType": null
      }
    ]
  }
]

Response Parameters:

Parameter	Description	Type
label	The type for virtual receiving account used for VRA allocation and value for this could be `LOCAL` or `GLOBAL` or `LOCAL,GLOBAL`	String
currencyCode	Returns the virtual receiving account currency.	String
currency	Returns currency.(DEPRECATED)	String
accountNumber	Returns 12 digit account number generated by Nium.	String
totalVirtualAccounts	Returns totalVirtualAccounts.	Number
virtualAccounts[n].virtualReceivingAccount	Virtual Receiving Account Number	String
virtualAccounts[n].virtualReceivingAccountId	Unique uuid generated by ID generated by Nium.	String
virtualAccounts[n].requestedVirtualAccount.virtualReceivingAccountRequestId	Generated request id for per request against currency: EUR, GBP, AUD.	String
virtualAccounts[n].requestedVirtualAccount.status	Virtual receiving account request status.	String
virtualAccounts[n].requestedVirtualAccount.createdAt	Virtual receiving account Requested date.	String
virtualAccounts[n].bankAccountName	Beneficiary Name.	String
virtualAccounts[n].bankName	Bank Name.	String
virtualAccounts[n].bankAddress	Address of the Bank.	String
virtualAccounts[n].payId	Unique ID in AUD virtual account	String
virtualAccounts[n].bankRoutingDetails.routing_code_1	Routing code type 1 (eg IFSC for India, SORT CODE for UK, ABA CODE for USA, BIC CODE for Europe).	String
virtualAccounts[n].bankRoutingDetails.routing_value_1	IFSC Code of the bank (eg SBIN0000058 for IFSC, 259087 for SORT CODE, 111000025 for ABA CODE, LIABLT20001 for BIC CODE).	String
virtualAccounts[n].bankRoutingDetails.routing_code_2	Routing code type 2 (eg IFSC for India, SORT CODE for UK, ABA CODE for USA, BIC CODE for Europe).	String
virtualAccounts[n].bankRoutingDetails.routing_value_2	IFSC Code of the bank (eg SBIN0000058 for IFSC, 259087 for SORT CODE, 111000025 for ABA CODE, LIABLT20001 for BIC CODE).	String
virtualAccounts[n].bankRoutingDetails.routing_code_3	Routing code type 3 (eg IFSC for India, SORT CODE for UK, ABA CODE for USA, BIC CODE for Europe).	String
virtualAccounts[n].bankRoutingDetails.routing_value_3	IFSC Code of the bank (eg SBIN0000058 for IFSC, 259087 for SORT CODE, 111000025 for ABA CODE, LIABLT20001 for BIC CODE).	String
virtualAccounts[n].payerId	This is the unique payer ID generated by Nium. Note: The payer related parameters will be null in case client is per currency approach	String
virtualAccounts[n].payerCompanyName	This is name of the payer company is applicable when the Payer type is Company.	String
virtualAccounts[n].payerName	This is the Name of an individual when the Payer type is Individual and name of the contact person if the Payer type is Company.	String
virtualAccounts[n].payerEmail	Email ID of a payer.	String
virtualAccounts[n].payerType	This field defines the type of payer and the value for this could be Individual or Company.	String

Definition​

Header Parameters:​

Path Parameters:​

Query Parameters:​

Example Request:​

Response (200):​

Response Parameters:​

Definition

Header Parameters:

Path Parameters:

Query Parameters:

Example Request:

Response (200):

Response Parameters: