Get Supported Corridors

Get supported corridors by currency, country or payout method.

Definition

URL

GET https://api-test.instarem.com:4803/api/v1/beneficiary-service/supported-corridors

Headers 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 value is application/json.	String	Yes
X-CLIENT-ID	Unique id for client generated by Nium, Required only in case of partner based model (E.g. 593feb7c7c52bb2357b2df6c).	String	No

Example Request

Bash

curl --location --request GET 'https://api-test.instarem.com:4803/api/v1/beneficiary-service/supported-corridors?destination_currency=USD&destination_country=US&payout_method=LOCAL' \\
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2MjE1MDY1NDYsImRhdGEiOnsiY2xpZW50IjoiNTkzZmViN2M3YzUyYmIyMzU3YjJkZjZjIiwic3ViIjoiNTkzZmViZjc3YzUyYmIyMzU3YjJkZjcxIn0sImlhdCI6MTYyMTQyMDE0Nn0.zlHniTvAJH3AlbzvjFI7hNIJrn5pkw8FLQ5fnsY016k' \\
--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/beneficiary-service/supported-corridors?destination_currency=USD&destination_country=US&payout_method=LOCAL");
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/beneficiary-service/supported-corridors?destination_currency=USD&destination_country=US&payout_method=LOCAL");
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);

Query Parameters

Parameter	Description	Type	Required
destination_currency	Destination currency (3-letter ISO-4217 code).	String	No
destination_country	Destination country (2-letter ISO-4217 code).	String	No
payout_method	Payout method.	String	No

Example Response

[
    {
        "destination_currency": "USD",
        "payout_method": "LOCAL",
        "destination_country": [
            "US"
        ],
        "routing_code_type": "ACH CODE"
    }
]

Response Parameters

Parameter	Description	Type
destination_currency	Destination currency.	String
payout_method	Payout method.	String
destination_country	Destination country.	Array
routing_code_type	Routing code type.	String