List all payers

Get list of payers added for the client

Definition

URL

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

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
countryCode	Country Code.	String	No
start	Start counter for the page.	Number	No
limit	Limit counter for the page.	Number	No

Example Request:

Bash

curl --request get \\
--url "https://api-test.instarem.com:4803/api/v1/client/{clientId}/payers?countryCode=&start=&limit=" \\
--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}/payers?countryCode=&start=&limit=");
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}/payers?countryCode=&start=&limit=");
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:

{
    "records": [
        {
            "payerId": "eb69f945-f507-4767-97da-03ef4fc55dce",
            "companyName": "Nium India Pvt Ltd",
            "website": "https://www.nium.com",
            "name": "John Doe",
            "email": "john.doe@nium.com",
            "type": "COMPANY",
            "country": {
                "countryCode": "IN",
                "countryName": "India"
            }
        }
    ],
    "total": 1
}

Response Parameters:

Parameter	Description	Type
records[n].payerId	This is the unique payer ID generated by Nium.	String
records[n].companyName	Payers company name.	String
records[n].website	Website link.	String
records[n].name	Name of the payer.	String
records[n].email	Email Id of the payer.	String
records[n].type	Type of the payer.	String
records[n].country.countryCode	Country Code.	String
records[n].country.countryName	Country Name.	String
total	Total Number of payers.	Number