Skip to content

3.1 General Information

The endpoints in the following chapters (3.2-3.6) are mostly similar in structure, with a a few minor differences here and there. It is worth mentioning that one of the more important similarities is the Fees property. In order to populate the Fees property you need to call the GET /settings endpoint with the API key you were provided.

The response content contains information about merchantServiceChargeFees and other settings that might be specific to your API key.

Here are a few code examples on how you could fetch the Settings:

Settings? settings = new();
using (var httpClient = new HttpClient())
{
    httpClient.BaseAddress = new Uri("https://boarding.uat.valitor.com/isoapi/");
    httpClient.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue(contentType));

    // The Api key will be provided by Rapyd's implementation specialist
    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("https://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"))

Example partial response from GET /settings:

{
    "Fees": {
        "MerchantServiceChargeFeeNames": [
            "Domestic debit cards",
            "Domestic credit cards",
            "Foreign debit cards",
            "Foreign credit cards"
        ],
        "processingFees": [
            {
                "min": 0.0000,
                "max": 0.2500,
                "default": 0.0000,
                "editable": true,
                "decimalPrecision": 2,
                "markets": [
                    "Crossborder"
                ],
                "types": [
                    "Card not present",
                    "Card present"
                ],
                "name": "Pre authorization fee",
                "value": 0.0000,
                "valueType": 2
            },
            {
                "min": 0.0000,
                "max": 30.0000,
                "default": 20.0000,
                "editable": false,
                "decimalPrecision": 2,
                "markets": [
                    "Crossborder"
                ],
                "types": [
                    "Card not present",
                    "Card present"
                ],
                "name": "Miniminum monthly service charge",
                "value": 0.0000,
                "valueType": 1
            },
            {
                "min": 0.0000,
                "max": 10.0000,
                "default": 4.9900,
                "editable": false,
                "decimalPrecision": 2,
                "markets": [
                    "Crossborder"
                ],
                "types": [
                    "Card not present",
                    "Card present"
                ],
                "name": "PCI fee",
                "value": 0.0000,
                "valueType": 1
            },
            {
                "min": 0.0000,
                "max": 50.0000,
                "default": 0.0000,
                "editable": true,
                "decimalPrecision": 2,
                "markets": [
                    "Crossborder"
                ],
                "types": [
                    "Card not present",
                    "Card present"
                ],
                "name": "E-com gateway monthly",
                "value": 0.0000,
                "valueType": 1
            },
            {
                "min": 0.0000,
                "max": 1.0000,
                "default": 0.0000,
                "editable": true,
                "decimalPrecision": 4,
                "markets": [
                    "Crossborder"
                ],
                "types": [
                    "Card not present",
                    "Card present"
                ],
                "name": "E-com gateway transaction",
                "value": 0.0000,
                "valueType": 1
            },
            {
                "min": 0.0000,
                "max": 0.1500,
                "default": 0.0345,
                "editable": true,
                "decimalPrecision": 4,
                "markets": [
                    "Iceland",
                    "Crossborder"
                ],
                "types": [
                    "Card not present",
                    "Card present"
                ],
                "name": "Authorization fee",
                "value": 0.0345,
                "valueType": 1
            },
            {
                "min": 0.0000,
                "max": 50.0000,
                "default": 25.0000,
                "editable": false,
                "decimalPrecision": 2,
                "markets": [
                    "Iceland",
                    "Crossborder"
                ],
                "types": [
                    "Card not present",
                    "Card present"
                ],
                "name": "Chargeback fee",
                "value": 25.0000,
                "valueType": 1
            },
            {
                "min": 0.0000,
                "max": 7.0000,
                "default": 0.0000,
                "editable": true,
                "decimalPrecision": 2,
                "markets": [
                    "Crossborder"
                ],
                "types": [
                    "Card not present",
                    "Card present"
                ],
                "name": "Payment fee",
                "value": 0.0000,
                "valueType": 1
            }
        ]
    },
    "RestrictedAmexMccs": [
        {
            "CountryCode": "GB",
            "CurrencyCode": "GBP",
            "MccID": 4411
        },
        {
            "CountryCode": "IS",
            "CurrencyCode": "ISK",
            "MccID": 4829
        },
        {
            "CountryCode": "IE",
            "CurrencyCode": "EUR",
            "MccID": 4829
        },
        {
            "CountryCode": "GB",
            "CurrencyCode": "GBP",
            "MccID": 4829
        },
        {
            "CountryCode": "IS",
            "CurrencyCode": "EUR",
            "MccID": 4829
        },
        {
            "CountryCode": "IS",
            "CurrencyCode": "USD",
            "MccID": 4829
        },
        {
            "CountryCode": "GB",
            "CurrencyCode": "GBP",
            "MccID": 5542
        },
        {
            "CountryCode": "GB",
            "CurrencyCode": "GBP",
            "MccID": 5960
        },
        {
            "CountryCode": "IS",
            "CurrencyCode": "ISK",
            "MccID": 5962
        },
        {
            "CountryCode": "IE",
            "CurrencyCode": "EUR",
            "MccID": 5962
        },
        {
            "CountryCode": "GB",
            "CurrencyCode": "GBP",
            "MccID": 5962
        },
        {
            "CountryCode": "IS",
            "CurrencyCode": "EUR",
            "MccID": 5962
        },
        {
            "CountryCode": "IS",
            "CurrencyCode": "USD",
            "MccID": 5962
        },
        {
            "CountryCode": "IS",
            "CurrencyCode": "ISK",
            "MccID": 5963
        },
        {
            "CountryCode": "IE",
            "CurrencyCode": "EUR",
            "MccID": 5963
        },
        {
            "CountryCode": "GB",
            "CurrencyCode": "GBP",
            "MccID": 5963
        },
        {
            "CountryCode": "IS",
            "CurrencyCode": "EUR",
            "MccID": 5963
        },
        {
            "CountryCode": "IS",
            "CurrencyCode": "USD",
            "MccID": 5963
        },
        {
            "CountryCode": "IS",
            "CurrencyCode": "ISK",
            "MccID": 6010
        },
        {
            "CountryCode": "IE",
            "CurrencyCode": "EUR",
            "MccID": 6010
        },
        {
            "CountryCode": "GB",
            "CurrencyCode": "GBP",
            "MccID": 6010
        },
        {
            "CountryCode": "IS",
            "CurrencyCode": "EUR",
            "MccID": 6010
        },
        {
            "CountryCode": "IS",
            "CurrencyCode": "USD",
            "MccID": 6010
        },
        {
            "CountryCode": "IS",
            "CurrencyCode": "ISK",
            "MccID": 6011
        },
        {
            "CountryCode": "IE",
            "CurrencyCode": "EUR",
            "MccID": 6011
        },
        {
            "CountryCode": "GB",
            "CurrencyCode": "GBP",
            "MccID": 6011
        },
        {
            "CountryCode": "IS",
            "CurrencyCode": "EUR",
            "MccID": 6011
        },
        {
            "CountryCode": "IS",
            "CurrencyCode": "USD",
            "MccID": 6011
        },
        {
            "CountryCode": "IS",
            "CurrencyCode": "ISK",
            "MccID": 6012
        },
        {
            "CountryCode": "IE",
            "CurrencyCode": "EUR",
            "MccID": 6012
        },
        {
            "CountryCode": "GB",
            "CurrencyCode": "GBP",
            "MccID": 6012
        },
        {
            "CountryCode": "IS",
            "CurrencyCode": "EUR",
            "MccID": 6012
        },
        {
            "CountryCode": "IS",
            "CurrencyCode": "USD",
            "MccID": 6012
        },
        {
            "CountryCode": "IS",
            "CurrencyCode": "ISK",
            "MccID": 6051
        },
        {
            "CountryCode": "IE",
            "CurrencyCode": "EUR",
            "MccID": 6051
        },
        {
            "CountryCode": "GB",
            "CurrencyCode": "GBP",
            "MccID": 6051
        },
        {
            "CountryCode": "IS",
            "CurrencyCode": "EUR",
            "MccID": 6051
        },
        {
            "CountryCode": "IS",
            "CurrencyCode": "USD",
            "MccID": 6051
        },
        {
            "CountryCode": "IS",
            "CurrencyCode": "ISK",
            "MccID": 6211
        },
        {
            "CountryCode": "IE",
            "CurrencyCode": "EUR",
            "MccID": 6211
        },
        {
            "CountryCode": "GB",
            "CurrencyCode": "GBP",
            "MccID": 6211
        },
        {
            "CountryCode": "IS",
            "CurrencyCode": "EUR",
            "MccID": 6211
        },
        {
            "CountryCode": "IS",
            "CurrencyCode": "USD",
            "MccID": 6211
        },
        {
            "CountryCode": "IS",
            "CurrencyCode": "ISK",
            "MccID": 6513
        },
        {
            "CountryCode": "IE",
            "CurrencyCode": "EUR",
            "MccID": 6513
        },
        {
            "CountryCode": "GB",
            "CurrencyCode": "GBP",
            "MccID": 6513
        },
        {
            "CountryCode": "IS",
            "CurrencyCode": "EUR",
            "MccID": 6513
        },
        {
            "CountryCode": "IS",
            "CurrencyCode": "USD",
            "MccID": 6513
        },
        {
            "CountryCode": "IS",
            "CurrencyCode": "ISK",
            "MccID": 7012
        },
        {
            "CountryCode": "IE",
            "CurrencyCode": "EUR",
            "MccID": 7012
        },
        {
            "CountryCode": "GB",
            "CurrencyCode": "GBP",
            "MccID": 7012
        },
        {
            "CountryCode": "IS",
            "CurrencyCode": "EUR",
            "MccID": 7012
        },
        {
            "CountryCode": "IS",
            "CurrencyCode": "USD",
            "MccID": 7012
        },
        {
            "CountryCode": "IS",
            "CurrencyCode": "ISK",
            "MccID": 7273
        },
        {
            "CountryCode": "IE",
            "CurrencyCode": "EUR",
            "MccID": 7273
        },
        {
            "CountryCode": "GB",
            "CurrencyCode": "GBP",
            "MccID": 7273
        },
        {
            "CountryCode": "IS",
            "CurrencyCode": "EUR",
            "MccID": 7273
        },
        {
            "CountryCode": "IS",
            "CurrencyCode": "USD",
            "MccID": 7273
        },
        {
            "CountryCode": "IS",
            "CurrencyCode": "ISK",
            "MccID": 7297
        },
        {
            "CountryCode": "IE",
            "CurrencyCode": "EUR",
            "MccID": 7297
        },
        {
            "CountryCode": "GB",
            "CurrencyCode": "GBP",
            "MccID": 7297
        },
        {
            "CountryCode": "IS",
            "CurrencyCode": "EUR",
            "MccID": 7297
        },
        {
            "CountryCode": "IS",
            "CurrencyCode": "USD",
            "MccID": 7297
        },
        {
            "CountryCode": "IS",
            "CurrencyCode": "ISK",
            "MccID": 7995
        },
        {
            "CountryCode": "IE",
            "CurrencyCode": "EUR",
            "MccID": 7995
        },
        {
            "CountryCode": "GB",
            "CurrencyCode": "GBP",
            "MccID": 7995
        },
        {
            "CountryCode": "IS",
            "CurrencyCode": "EUR",
            "MccID": 7995
        },
        {
            "CountryCode": "IS",
            "CurrencyCode": "USD",
            "MccID": 7995
        },
        {
            "CountryCode": "IS",
            "CurrencyCode": "ISK",
            "MccID": 8651
        },
        {
            "CountryCode": "IE",
            "CurrencyCode": "EUR",
            "MccID": 8651
        },
        {
            "CountryCode": "GB",
            "CurrencyCode": "GBP",
            "MccID": 8651
        },
        {
            "CountryCode": "IS",
            "CurrencyCode": "EUR",
            "MccID": 8651
        },
        {
            "CountryCode": "IS",
            "CurrencyCode": "USD",
            "MccID": 8651
        },
        {
            "CountryCode": "IS",
            "CurrencyCode": "ISK",
            "MccID": 8661
        },
        {
            "CountryCode": "IE",
            "CurrencyCode": "EUR",
            "MccID": 8661
        },
        {
            "CountryCode": "GB",
            "CurrencyCode": "GBP",
            "MccID": 8661
        },
        {
            "CountryCode": "IS",
            "CurrencyCode": "EUR",
            "MccID": 8661
        },
        {
            "CountryCode": "IS",
            "CurrencyCode": "USD",
            "MccID": 8661
        },
        {
            "CountryCode": "IE",
            "CurrencyCode": "EUR",
            "MccID": 9222
        },
        {
            "CountryCode": "GB",
            "CurrencyCode": "GBP",
            "MccID": 9222
        },
        {
            "CountryCode": "IS",
            "CurrencyCode": "ISK",
            "MccID": 9223
        },
        {
            "CountryCode": "IE",
            "CurrencyCode": "EUR",
            "MccID": 9223
        },
        {
            "CountryCode": "GB",
            "CurrencyCode": "GBP",
            "MccID": 9223
        },
        {
            "CountryCode": "IS",
            "CurrencyCode": "EUR",
            "MccID": 9223
        },
        {
            "CountryCode": "IS",
            "CurrencyCode": "USD",
            "MccID": 9223
        }
    ],
    "ECommerceSOlutions": [
        "WebPOSTerminal",
        "InstallmentPayments",
        "WebPaymentPage",
        "PaymentGateway",
        "CorporatePayments",
        "RecurringPayments",
        "ExternalEcomServices",
        "Checkout",
        "ValitorPay"
    ]
}
You need to use the above JSON payload to populate the Fees property in the e.g. Sole trader, Public limited company etc. that you are about to create. Note: The JSON response that you receive from GET /Settings in the UAT environment does not necessarily reflect the actual data that you will receive from calling the same endpoint on the PROD environment.