CSL Pay Developers
Home / Reference / FX Rate

Retrieve A Live Quote

GET /fx-rate-api/quote/{quoteId}

The Retrieve A Live Quote endpoint is used to retrieve a previously requested foreign exchange quote by its unique identifier. A partner would call this endpoint when they need to access the details of a specific quote that was previously requested through the CSL Pay platform. This endpoint returns the current status and details of the quote.

Path parameters

  • quoteIdrequired string

Request body (optional)

This endpoint accepts a body with no declared schema.

Response 200

  • quoteId string
    A unique identifier for the foreign exchange rate quote.
  • buyCurrency string
    The currency in which the buy amount is denominated.
  • buyAmount number
    The amount of the buy currency.
  • sellCurrency string
    The currency in which the sell amount is denominated.
  • sellAmount number
    The amount of the sell currency.
  • rate number
    The exchange rate between the buy and sell currencies.
  • direction string
    The direction of the exchange rate quote, e.g. buy or sell.
  • quotedAt string
    The timestamp when the exchange rate quote was generated.
  • expiresAt string
    The timestamp when the exchange rate quote expires.
  • expiresInSeconds integer
    The number of seconds until the exchange rate quote expires.