Get Bank Account

Get the list of bank accounts that are added for the client.

Definition

URL

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

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 --request get \\
--url "https://api-test.instarem.com:4803/api/v1/client/{clientId}/bankAccounts" \\
--header 'authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0OTgxMzQ4OTQsImRhdGEiOnsic3ViIjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWE1IiwiY2xpZW50IjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWExIn0sImlhdCI6MTQ5ODA0ODQ5NH0.pevwSDpk-JDNtVIpqFu_m0Xu1UnDVumrAYStcrxf8sM' \\
--header 'content-type: application/json'

Javascript

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}/bankAccounts");
xhr.setRequestHeader("authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0OTgxMzQ4OTQsImRhdGEiOnsic3ViIjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWE1IiwiY2xpZW50IjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWExIn0sImlhdCI6MTQ5ODA0ODQ5NH0.pevwSDpk-JDNtVIpqFu_m0Xu1UnDVumrAYStcrxf8sM");
xhr.setRequestHeader("content-type", "application/json");
xhr.send();

C#

var client = new RestClient("https://api-test.instarem.com:4803/api/v1/client/{clientId}/bankAccounts");
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:

{
    "beneficiaryName": "Nium Client",
    "beneficiaryCountryCode": "SG",
    "beneficiaryCountryName": "Singapore",
    "bankAccounts": [
        {
            "accountId": "c4b451a0-9841-11eb-96ff-bdd9c6dff7fe",
            "bankName": "HDFC Bank",
            "accountType": "Company",
            "accountNumber": "890112345679",
            "currencyCode": "INR",
            "routingCodeType1": "IFSC",
            "routingCodeValue1": "SBIN00123456",
            "routingCodeType2": null,
            "routingCodeValue2": null,
            "isDefault": false
        },
        {
            "accountId": "6ef74d20-983d-11eb-8526-17d391a725ae",
            "bankName": "Clear Bank",
            "accountType": "Company",
            "accountNumber": "890112345678",
            "currencyCode": "USD",
            "routingCodeType1": "ACH CODE",
            "routingCodeValue1": "111143009",
            "routingCodeType2": "SWIFT",
            "routingCodeValue2": "SVBKUS6S",
            "isDefault": true
        }
    ]
}

Response Parameters:

Parameter	Description	Type
beneficiaryName	Client's bank account name.	String
beneficiaryCountryCode	Client's bank country code. If the bank account is in Singapore then the value will be SG.	String
beneficiaryCountryName	Client's country name.	String
bankAccounts[n].accountId	Unique bank account id generated by Nium.	String
bankAccounts[n].bankName	Client's Bank name.	String
bankAccounts[n].accountType	Account type of client in Nium. The account type can be either Individual or Company.	String
bankAccounts[n].accountNumber	Client's bank account number.	String
bankAccounts[n].currencyCode	The currency code of client's bank account.	String
bankAccounts[n].routingCodeType1	Routing code type. Example: IFSC for India, SORT CODE for UK, ABA CODE for USA, BIC CODE for Europe.	String
bankAccounts[n].routingCodeValue1	The routing code value. Example: SBIN0000058 for IFSC Code, 259087 for SORT CODE, 111000025 for ABA CODE, LIABLT20001 for BIC CODE.	String
bankAccounts[n].routingCodeType2	Routing code type. Example: IFSC for India, SORT CODE for UK, ABA CODE for USA, BIC CODE for Europe.	String
bankAccounts[n].routingCodeValue2	The routing code value. Example: SBIN0000058 for IFSC Code, 259087 for SORT CODE, 111000025 for ABA CODE, LIABLT20001 for BIC CODE.	String
bankAccounts[n].isDefault	This indicates if the bank account is default or not. The value can be True or False.	Boolean