Get Payer by Id

This API returns all the details of the requested payer.

Definition

URL

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

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
payerId	This is the unique payer ID generated by Nium.	String	Yes

Example Request:

Bash

curl --request get \\
--url "https://api-test.instarem.com:4803/api/v1/client/{clientId}/payer/{payerId}" \\
--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}/payer/{payerId}");
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}/payer/{payerId}");
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:

{
  "companyName": "Instarem India Pvt Ltd",
  "website": "https://www.instarem.com",
  "name": "John Doe",
  "email": "john.doe@instarem.com",
  "type": "COMPANY",
  "country": {
    "countryCode": "US",
    "countryName": "USA"
  },
  "receivingAccounts": [
    {
      "label": "LOCAL",
      "currencyCode": "USD",
      "currency": "USD",
      "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",
          "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": "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
companyName	Payers company name.	String
website	Website link.	String
name	Name of the payer.	String
email	Email Id of the payer.	String
type	Type of the payer.	String
country.countryCode	Country code of the payer.	String
country.countryName	Country name of the Payer.	String
receivingAccounts[n].label	The type for virtual receiving account used for VRA allocation and value for this could be LOCAL or GLOBAL or LOCAL,GLOBAL Note: The receivingAccounts will consistently be an empty array in case client is per currency approach	String
receivingAccounts[n].currency	The currency for virtual receiving account. (DEPRECATED)	String
receivingAccounts[n].currencyCode	The currency for virtual receiving account.	String
receivingAccounts[n].accountNumber	Returns 12 digit account number generated by Nium	String
receivingAccounts[n].totalVirtualAccounts	total virtual accounts allocated	String
receivingAccounts[n].virtualAccounts[n].virtualReceivingAccount	Virtual receiving account number	String
receivingAccounts[n].virtualAccounts[n].virtualReceivingAccountId	Unique identifier number of virtual receiving account generated by Nium	String
receivingAccounts[n].virtualAccounts[n].requestedVirtualAccount.virtualReceivingAccountRequestId	Generated request id for virtual account request against currency: EUR, GBP, AUD	String
receivingAccounts[n].virtualAccounts[n].requestedVirtualAccount.status	Virtual receiving account request status.	String
receivingAccounts[n].virtualAccounts[n].requestedVirtualAccount.createdAt	Virtual receiving account Requested date.	String
receivingAccounts[n].virtualAccounts[n].bankAccountName	Beneficiary name	String
receivingAccounts[n].virtualAccounts[n].bankName	Beneficiary bank name	String
receivingAccounts[n].virtualAccounts[n].bankAddress	Beneficiary bank address	String
receivingAccounts[n].virtualAccounts[n].payId	Unique ID in AUD virtual account	String
receivingAccounts[n].virtualAccounts[n].bankRoutingDetails.routing_code_1	Routing code 1 (eg IFSC for India, SORT CODE for UK, ABA CODE for USA, BIC CODE for Europe).	String
receivingAccounts[n].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
receivingAccounts[n].virtualAccounts[n].bankRoutingDetails.routing_code_2	Routing code 1 (eg IFSC for India, SORT CODE for UK, ABA CODE for USA, BIC CODE for Europe).	String
receivingAccounts[n].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