CSL Pay Developers
Home / Reference / FX Rate

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
    The currency to buy, represented as a three-letter ISO code.
  • sellCurrencyrequired string
    The currency to sell, represented as a three-letter ISO code.
  • amountrequired number
    The amount to exchange, represented as a decimal number.
  • directionrequired string
    The direction of the exchange, either 'buy' or 'sell'.

Response 200

  • quoteId string
    A unique identifier assigned to the quote request.
  • buyCurrency string
    The currency being bought, e.g. GBP.
  • buyAmount number
    The amount being bought, in the buy currency.
  • sellCurrency string
    The currency being sold, e.g. EUR.
  • sellAmount number
    The amount being sold, in the sell currency.
  • rate number
    The exchange rate used to calculate the sell amount.
  • direction string
    The direction of the exchange, either 'buy' or 'sell'.
  • quotedAt string
    The timestamp when the quote was requested, in ISO 8601 format.
  • expiresAt string
    The timestamp when the quote expires, in ISO 8601 format.
  • expiresInSeconds integer
    The number of seconds until the quote expires.