Retrieve Fx Rate

GET /fx-rate-api/list/fx/rate

The queryFxRate endpoint retrieves a list of available foreign exchange rates for a partner to use in their transactions. A partner would call this endpoint when they need to obtain the current FX rates for a specific country or group of countries. This endpoint returns a list of FX rates in real-time.

Query parameters

Name	Type	Description
countryCode	string	—

Request body (optional)

This endpoint accepts a body with no declared schema.

Response 200

Field	Type	Description
countryCode	string	A two-letter ISO 3166-1 alpha-2 code representing the country.
countryName	string	The full name of the country.
fxDealRate	number	The current foreign exchange deal rate.
fxWindow	string	The time window during which the foreign exchange deal rate is valid.
rateExpiryTime	string	The date and time when the foreign exchange deal rate expires.

Environment

Request

curl -X GET "https://api.dev.cslpay.io/fx-rate-api/list/fx/rate" \
  -H "Authorization: Bearer <access-token>"

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
        .url("https://api.dev.cslpay.io/fx-rate-api/list/fx/rate")
        .get()
        .addHeader("Authorization", "Bearer <access-token>")
        .build();

try (Response response = client.newCall(request).execute()) {
    if (!response.isSuccessful()) {
        throw new IOException("Unexpected status " + response.code());
    }
    System.out.println(response.body().string());
}

const response = await fetch("https://api.dev.cslpay.io/fx-rate-api/list/fx/rate", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <access-token>"
  }
});

const data = await response.json();
console.log(data);

import requests

response = requests.get(
    "https://api.dev.cslpay.io/fx-rate-api/list/fx/rate",
    headers={
        "Authorization": "Bearer <access-token>"
    },
)

response.raise_for_status()
print(response.json())

Response

200OK

{
  "countryCode": "string",
  "countryName": "string",
  "fxDealRate": 0,
  "fxWindow": "string",
  "rateExpiryTime": "2026-01-15T09:30:00Z"
}

Authorization

Authorization: Bearer <access-token>

Sent on every request. See Getting Started.

Try it

GET /fx-rate-api/list/fx/rate

Requests go to your test environment only. Nothing here reaches production, and your token is forwarded once and never stored.

Environment Request URL

GET

Authorization

Sent with this request only and never stored. Use a test credential — if a proxy in front of this site blocks POST, the request is retried as an encoded URL, which edge logs can capture. Get one from Getting Started.

Query Parameters

countryCode

Response

Response headers