List Settlements

Retrieve a paginated list of FX settlements with optional filters for deal ID, currency pair, status, and creation date range. Uses cursor-based pagination.
Request Parameters
limitinteger
Number of results per page. Range: 1-100, defaults to 20 if not specified.
cursorstring
Pagination cursor from a previous response. Omit for the first page.
dealIdstring
Filter by associated deal ID.
sellCurrencystring
Filter by sell currency, following the ISO 4217 standard. See Data Types three-letter code.
buyCurrencystring
Filter by buy currency, following the ISO 4217 standard. See Data Types three-letter code.
statusstring
Filter by settlement status. See SettlementStatus.
fromCreatedAtdatetime
Start of the creation time filter, following the ISO 8601 standard. See Data Types format. Maximum range: 30 days.
toCreatedAtdatetime
End of the creation time filter, following the ISO 8601 standard. See Data Types format.
requestIdsarray
Filter by one or more requestId values supplied when the settlements were created.
Response Parameters
resultResult
See Result.
itemsarray
List of Settlement objects.
Show child parametersShow child parameters
nextCursorstring
Cursor for the next page. Returned when more results are available.
prevCursorstring
Cursor for the previous page.
Error Codes
resultCoderesultStatusresultMessageTroubleshooting
SUCCESSSsuccessN/A
Definition
POST /api/open/v1/fx/settlements/list
Request
{
"limit": 10,
"status": "PROCESSING",
"sellCurrency": "USD",
"fromCreatedAt": "2026-04-01T00:00:00Z",
"toCreatedAt": "2026-04-30T23:59:59Z",
"requestIds": [
  "SR20260402003"
]
}
Response
{
"result": {
  "resultCode": "SUCCESS",
  "resultMessage": "success",
  "resultStatus": "S"
},
"items": [
  {
    "id": "STL20260402003",
    "requestId": "SR20260402003",
    "sellAmount": {
      "currency": "USD",
      "value": 25000
    },
    "buyAmount": {
      "currency": "JPY",
      "value": 37313
    },
    "quote": {
      "quoteId": "QT202604021208003",
      "currencyPair": "USD/JPY",
      "clientRate": 149.25,
      "effectiveAt": "2026-04-02T04:10:00Z",
      "expiresAt": "2026-04-02T04:11:00Z"
    },
    "dealId": "DEAL20260402002",
    "settlementDate": "2026-04-03",
    "beneficiary": {
      "beneficiaryId": "BEN_TOKEN_001",
      "accountType": "BANK_ACCOUNT"
    },
    "reference": "FX Forward Settlement",
    "memo": "FX Forward Settlement",
    "feeAmount": {
      "currency": "USD",
      "value": 25
    },
    "status": "PROCESSING",
    "createdAt": "2026-04-02T04:10:10Z"
  }
],
"nextCursor": "eyJpZCI6IlNUTDIwMjYwNDAyMDAzIn0="
}