Query a Settlement

Retrieves the full details of a specific FX settlement by its settlement ID. Returns the complete settlement object including amounts, quote details, status, and timestamps. Use this endpoint to check the current status of a settlement or retrieve its full details after creation.
Request Parameters
SPOT
idstring
required
The unique identifier of the settlement to query.
Response Parameters
resultResult
See Result.
idstring
The unique settlement identifier.
requestIdstring
Idempotency ID supplied when the settlement was created.
sellAmountAmount
The sold amount.
buyAmountAmount
The bought amount.
quoteQuote
The quote details associated with this settlement.
Show child parametersShow child parameters
dealIdstring
The deal identifier, present for FORWARD and UNFUNDED_SPOT settlements.
settlementDatestring
The expected settlement date in YYYY-MM-DD format (UTC).
beneficiaryBeneficiary
The beneficiary information, if applicable.
Show child parametersShow child parameters
referencestring
The business reference number associated with the settlement.
memostring
The transaction remark attached to the settlement.
feeAmountAmount
The fee amount charged for the settlement.
statusstring
The current status of the settlement. Supported values: - PROCESSING — Settlement is being processed. - SUCCESS — Settlement completed successfully. - FAILED — Settlement failed.
createdAtdatetime
The timestamp when the settlement was created, in ISO 8601 format.
settledAtdatetime
The timestamp when the settlement was completed, in ISO 8601 format.
failedAtdatetime
The timestamp when the settlement failed, in ISO 8601 format. Only present when status is FAILED.
failureCodestring
The failure code indicating the reason for failure. Only present when status is FAILED.
failureMessagestring
A human-readable description of the failure. Only present when status is FAILED.
Error Codes
resultCoderesultStatusresultMessageTroubleshooting
SUCCESSSsuccessN/A
FUND_ORDER_NOT_EXISTFThe fund order does not exist.Verify the settlement ID is correct and belongs to your account.
Definition
POST /api/open/v1/fx/settlements/query
Request
{
"id": "STL20260402001"
}
Response
{
"result": {
  "resultCode": "SUCCESS",
  "resultMessage": "success",
  "resultStatus": "S"
},
"id": "STL20260402001",
"requestId": "SR20260402001",
"sellAmount": {
  "currency": "USD",
  "value": 10000
},
"buyAmount": {
  "currency": "HKD",
  "value": 77850
},
"quote": {
  "quoteId": "QT202604021208001",
  "currencyPair": "USD/HKD",
  "clientRate": 7.785,
  "effectiveAt": "2026-04-02T04:08:56Z",
  "expiresAt": "2026-04-02T04:09:56Z"
},
"status": "SUCCESS",
"createdAt": "2026-04-02T04:08:58Z",
"settledAt": "2026-04-02T04:08:58Z"
}