List Fx Rates

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

This endpoint retrieves a list of available foreign exchange rates. A partner would call this endpoint to retrieve the current FX rates for use in their application. This endpoint is typically used when a partner needs to display or utilize FX rates in their system.

Request body (optional)

This endpoint accepts a body with no declared schema.

Response 200

Field	Type	Description
rateId	string	—
fxDealRate	number	—
country	string	—
createdBy	string	—
dateCreated	string	—
activeStatus	boolean	—
closeTime	string	—
sendPendingEmailNotificationTime	string	—
emailSendingPickUpStatus	boolean	—
fxWindow	string	—
approvalStatus	string	—

Environment

Request

curl -X GET "https://api.dev.cslpay.io/fx-rate-api/list/fx/rates" \
  -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/rates")
        .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/rates", {
  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/rates",
    headers={
        "Authorization": "Bearer <access-token>"
    },
)

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

Response

200OK

[
  {
    "rateId": "string",
    "fxDealRate": 0,
    "country": "string",
    "createdBy": "string",
    "dateCreated": "2026-01-15T09:30:00Z",
    "activeStatus": true,
    "closeTime": "2026-01-15T09:30:00Z",
    "sendPendingEmailNotificationTime": "2026-01-15T09:30:00Z",
    "emailSendingPickUpStatus": true,
    "fxWindow": "string",
    "approvalStatus": "PENDING"
  }
]

Authorization

Authorization: Bearer <access-token>

Sent on every request. See Getting Started.

Try it

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

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.

Response

Response headers