Get All PAY IN Offered Currencies

This API will fetch the currencies you can PAY IN for the given clientId.

Definition

URL

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

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}/receiveOfferedCurrencies" \\
--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}/receiveOfferedCurrencies");
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}/receiveOfferedCurrencies");
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):

[
    {
         "currencyCode": "USD",
         "label": "LOCAL"
    },
    {
         "currencyCode": "USD",
         "label": "GLOBAL"
    },
    {
         "currencyCode": "SGD",
         "label": "LOCAL"
    },
    {
         "currencyCode": "AUD",
         "label": "LOCAL"
    },
    {
         "currencyCode": "HKD",
         "label": "LOCAL"
    },
    {
         "currencyCode": "INR",
         "label": "LOCAL"
    },
    {
         "currencyCode": "EUR",
         "label": "LOCAL"
    },
    {
         "currencyCode": "GBP",
         "label": "LOCAL"
    }
]

Response Parameters:

Parameter	Description	Type
currencyCode	Currency Code of the receiving account	String
label	The type of virtual receiving account. The value could be LOCAL, GLOBAL, or LOCAL,GLOBAL	String