Request an FX Quote

POST /fx-rate-api/request/quote

This endpoint requests an FX quote from the CSL Pay platform, providing the necessary information to generate a quote for a specific currency exchange. A partner would call this endpoint when they need to obtain a quote for a potential FX transaction, allowing them to plan and manage their currency exchange requirements. The endpoint accepts a POST request with the required fields and returns a quote ID and the corresponding FX quote details.

Request body

buyCurrencyrequired string
sellCurrencyrequired string
amountrequired number
directionrequired string

Response 200

quoteId string
buyCurrency string
buyAmount number
sellCurrency string
sellAmount number
rate number
direction string
quotedAt string
expiresAt string
expiresInSeconds integer

Environment

Request

curl -X POST "https://api.dev.cslpay.io/fx-rate-api/request/quote" \
  -H "Authorization: Bearer <access-token>" \
  -H "Content-Type: application/json" \
  -d '{
  "buyCurrency": "<[A-Z]{3}>",
  "sellCurrency": "<[A-Z]{3}>",
  "amount": 0.01,
  "direction": "BUY"
}'

OkHttpClient client = new OkHttpClient();

String payload = """
    {
      "buyCurrency": "<[A-Z]{3}>",
      "sellCurrency": "<[A-Z]{3}>",
      "amount": 0.01,
      "direction": "BUY"
    }
""";

RequestBody body = RequestBody.create(
        payload, MediaType.get("application/json"));

Request request = new Request.Builder()
        .url("https://api.dev.cslpay.io/fx-rate-api/request/quote")
        .post(body)
        .addHeader("Authorization", "Bearer <access-token>")
        .addHeader("Content-Type", "application/json")
        .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/request/quote", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <access-token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "buyCurrency": "<[A-Z]{3}>",
    "sellCurrency": "<[A-Z]{3}>",
    "amount": 0.01,
    "direction": "BUY"
  })
});

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

import requests

response = requests.post(
    "https://api.dev.cslpay.io/fx-rate-api/request/quote",
    headers={
        "Authorization": "Bearer <access-token>",
        "Content-Type": "application/json"
    },
    json={
      "buyCurrency": "<[A-Z]{3}>",
      "sellCurrency": "<[A-Z]{3}>",
      "amount": 0.01,
      "direction": "BUY"
    },
)

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

Response

200OK

{
  "quoteId": "string",
  "buyCurrency": "string",
  "buyAmount": 0,
  "sellCurrency": "string",
  "sellAmount": 0,
  "rate": 0,
  "direction": "BUY",
  "quotedAt": "2026-01-15T09:30:00Z",
  "expiresAt": "2026-01-15T09:30:00Z",
  "expiresInSeconds": 0
}

Authorization

Authorization: Bearer <access-token>

Sent on every request. See Getting Started.

Try it

POST /fx-rate-api/request/quote

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

Environment Request URL

POST

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.

Request Body

JSON. Edited here, not saved.

Response

Response headers