Retrieve A Closed Deal By Trade Reference

GET /fx-rate-api/deal/{tradeReference}

This endpoint retrieves a closed deal by its trade reference, allowing partners to access historical transaction data. A partner would call this endpoint when they need to retrieve details of a previously executed foreign exchange transaction. The endpoint returns the key details of the deal, including the trade reference, client reference, and exchange rate.

Path parameters

tradeReferencerequired string

Request body (optional)

This endpoint accepts a body with no declared schema.

Response 200

tradeReference string

Unique identifier for the trade
clientReference string

Unique identifier for the client's transaction
quoteId string

Unique identifier for the FX quote
buyCurrency string

Currency of the funds being purchased
buyAmount number

Amount of funds being purchased
sellCurrency string

Currency of the funds being sold
sellAmount number

Amount of funds being sold
rate number

FX exchange rate applied to the trade
bookingTime string

Time at which the trade was booked
bookingSource string

System or user that initiated the trade booking

Environment

Request

curl -X GET "https://api.dev.cslpay.io/fx-rate-api/deal/{tradeReference}" \
  -H "Authorization: Bearer <access-token>"

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
        .url("https://api.dev.cslpay.io/fx-rate-api/deal/{tradeReference}")
        .get()
        .addHeader("Authorization", "Bearer <access-token>")
        .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/deal/{tradeReference}", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <access-token>"
  }
});

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

import requests

response = requests.get(
    "https://api.dev.cslpay.io/fx-rate-api/deal/{tradeReference}",
    headers={
        "Authorization": "Bearer <access-token>"
    },
)

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

Response

200OK

{
  "tradeReference": "string",
  "clientReference": "string",
  "quoteId": "string",
  "buyCurrency": "string",
  "buyAmount": 0,
  "sellCurrency": "string",
  "sellAmount": 0,
  "rate": 0,
  "bookingTime": "2026-01-15T09:30:00Z",
  "bookingSource": "FX_API"
}

Authorization

Authorization: Bearer <access-token>

Sent on every request. See Getting Started.

Try it

GET /fx-rate-api/deal/{tradeReference}

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

Environment Request URL

GET

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.

Path Parameters

tradeReference required

Response

Response headers