CSL Pay Developers

Get Trade By External Reference

GET /fx-rate-api/fx/orders/reference

This endpoint retrieves a trade by its external reference, allowing a partner to retrieve the status and details of a previously submitted trade. A partner would call this endpoint when they need to check the status of a trade that was submitted using the external reference. The endpoint returns the trade data, including its status, message, and system reference.

Query parameters

NameTypeDescription
externalReference string

Request body (optional)

This endpoint accepts a body with no declared schema.

Response 200

FieldTypeDescription
success boolean
externalReference string
tradeData object
status string
message string
systemReference string
fixedSide string
sourceCurrency string
sourceAmount number
targetCurrency string
targetAmount number
quoteId string
rate number
valueDate string