Skip to content

Developers

Home / Reference / FX Rate

Request Quote

POST /fx-rate-api/partner/fx/quote

This endpoint is used to request a foreign exchange quote from the CSL Pay platform. A partner would call this endpoint when they need to obtain a quote for a specific foreign exchange transaction, typically before initiating the transaction. The endpoint accepts a request containing the fixed side of the transaction, the source currency, the source amount, and the target currency, and returns a response containing the quote data and a system reference.

Request body

Field	Type	Description
fixedSide required	string	—
sourceCurrency required	string	—
sourceAmount required	number	—
targetCurrency required	string	—

Response 200

Field	Type	Description
success	boolean	—
quoteDataResponse	object	—
status	string	—
message	string	—
systemReference	string	—
fixedSide	string	—
sourceCurrency	string	—
sourceAmount	number	—
targetCurrency	string	—
targetAmount	number	—
quoteId	string	—
rate	number	—
valueDate	string	—

Environment

Request

curl -X POST "https://api.dev.cslpay.io/fx-rate-api/partner/fx/quote" \
  -H "Authorization: Bearer <access-token>" \
  -H "Content-Type: application/json" \
  -d '{
  "fixedSide": "<SELL|BUY>",
  "sourceCurrency": "<[A-Z]{3}>",
  "sourceAmount": 1000,
  "targetCurrency": "<[A-Z]{3}>"
}'

OkHttpClient client = new OkHttpClient();

String payload = """
    {
      "fixedSide": "<SELL|BUY>",
      "sourceCurrency": "<[A-Z]{3}>",
      "sourceAmount": 1000,
      "targetCurrency": "<[A-Z]{3}>"
    }
""";

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

Request request = new Request.Builder()
        .url("https://api.dev.cslpay.io/fx-rate-api/partner/fx/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/partner/fx/quote", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <access-token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "fixedSide": "<SELL|BUY>",
    "sourceCurrency": "<[A-Z]{3}>",
    "sourceAmount": 1000,
    "targetCurrency": "<[A-Z]{3}>"
  })
});

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

import requests

response = requests.post(
    "https://api.dev.cslpay.io/fx-rate-api/partner/fx/quote",
    headers={
        "Authorization": "Bearer <access-token>",
        "Content-Type": "application/json"
    },
    json={
      "fixedSide": "<SELL|BUY>",
      "sourceCurrency": "<[A-Z]{3}>",
      "sourceAmount": 1000,
      "targetCurrency": "<[A-Z]{3}>"
    },
)

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

Response

200OK

{
  "success": true,
  "quoteDataResponse": {
    "status": "string",
    "message": "string",
    "systemReference": "string",
    "fixedSide": "string",
    "sourceCurrency": "string",
    "sourceAmount": 0,
    "targetCurrency": "string",
    "targetAmount": 0,
    "quoteId": "string",
    "rate": 0,
    "valueDate": "2026-01-15"
  }
}

Authorization

Authorization: Bearer <access-token>

Sent on every request. See Getting started.