CSL Pay Developers

Trade a Quote and Close The Deal

POST /fx-rate-api/partner/fx/trade

The Execute Trade endpoint is used to initiate a foreign exchange trade on behalf of a partner, allowing them to execute a trade with a quote previously obtained from the rate api. A partner would call this endpoint when they wish to confirm and execute a trade, providing the external reference and quote ID obtained from the rate api. The endpoint returns the trade data, including the status and any relevant messages.

Request body

  • quoteIdrequired string
    Unique identifier for the FX quote
  • clientReferencerequired string
    Client-provided reference for the trade

Response 200

  • tradeReference string
    Unique identifier for the trade
  • clientReference string
    Client-provided reference for the trade
  • quoteId string
    Identifier for the FX quote
  • buyCurrency string
    Currency of the buy amount
  • buyAmount number
    Amount to be bought
  • sellCurrency string
    Currency of the sell amount
  • sellAmount number
    Amount to be sold
  • rate number
    FX rate applied to the trade
  • bookingTime string
    Time at which the trade was booked
  • bookingSource string
    Source of the trade booking
  • settlementStatus string
    The settlement status of the trade, indicating whether the trade has been settled or not. The possible values are UNSETTLED and SETTLED. UNSETTLED is not an error or a pending approval. The rate is fixed, the trade is binding, and neither party can back out. It means only that disbursement has not happened yet. SETTLED is set once and never revisited. A deal already SETTLED cannot be credited again - the API refuses, which is what prevents a double credit.