2. Getting Started

To start developing against Rapyd's ISO Onboarding API, you must first obtain an API key to access the API, which is provided during implementation. The API key you will obtain is based on the currency the merchant will use and the bucket template (a bucket template is used to categorize transactions as per their relevant pricing structure).

Refer to the following URLs for User Acceptance Testing (UAT):

• The API Documentation for UAT is: https://boarding.valitor.com/swagger/index.html
• The base endpoint URL for UAT is: https://boarding.uat.valitor.com
• The API Key for testing: ISO.tFPVY1K+NsCP0qDeoOm+rQhLroyg4lEeI+IXPOIX7fo= (Make sure not to post any sensitive or confidential data since this is a public API key).

The corresponding URLs for the Production environment (PROD) will be provided by Rapyd's implementation specialist.

Example Request

The below request shows how to connect to the API using . The request demonstrated is GET /settings which fetches useful information and is also used to populate various properties when calling endpoints such as POST /soletrader. There is more info about POST /soletrader and other endpoints in the next chapters.

C# using HttpClientJavascript using AxiosPython using http.client

Settings? settings = new();
using (var httpClient = new HttpClient())
{
    var apiKey = 'ISO.tFPVY1K+NsCP0qDeoOm+rQhLroyg4lEeI+IXPOIX7fo=';
    httpClient.BaseAddress = new Uri("https://boarding.uat.valitor.com/isoapi/");
    httpClient.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue(contentType));

    httpClient.DefaultRequestHeaders.Add("Apikey", apiKey);

    // The Api version should be the latest version by default - see API documentation for more info
    httpClient.DefaultRequestHeaders.Add("api-version", apiVersion);

    var response = httpClient.GetAsync("settings");
    string jsonResponseContent = response.Result.Content.ReadAsStringAsync().Result;

    var serializeOptions = new JsonSerializerOptions { PropertyNamingPolicy = JsonNamingPolicy.CamelCase, WriteIndented = true };

    settings = JsonSerializer.Deserialize<Settings>(jsonResponseContent, serializeOptions);
}

var axios = require('axios');

var config = {
    method: 'get',
    url: 'https://boarding.uat.valitor.com/isoapi/settings',
    headers: {
        'api-version': '2.0',
        'ApiKey': apiKey,
        'Cookie': 'BIGipServers1-boarding.uat.valitor.com-pool=230086666.47873.0000'
    }
};

axios(config)
    .then(function (response) {
        console.log(JSON.stringify(response.data));
    })
    .catch(function (error) {
        console.log(error);
    });

import http.client

conn = http.client.HTTPSConnection("boarding.uat.valitor.com")
payload = ''
headers = {
    'api-version': '2.0',
    'ApiKey': apiKey,
    'Cookie': 'BIGipServers1-boarding.uat.valitor.com-pool=230086666.47873.0000'
}
conn.request("GET", "/isoapi/settings", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

Please refer to the API Documentation (Get Application Settings) to see the how the response payload is constructed.