List Deals

Retrieve a paginated list of FX deals with optional filters for currency pair, status, and creation date range. Uses cursor-based pagination for efficient traversal of large result sets.
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.
sellCurrencystring
Filter by sell currency, following the ISO 4217 standard. See Data Types three-letter code (e.g., "USD").
buyCurrencystring
Filter by buy currency, following the ISO 4217 standard. See Data Types three-letter code (e.g., "HKD").
statusstring
Filter by deal status. See DealStatus.
fromCreatedAtdatetime
Start of the creation time filter, following the ISO 8601 standard. See Data Types format. Maximum range: 31 days when used with toCreatedAt.
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 deals were created.
Response Parameters
resultResult
See Result.
prevCursorstring
Cursor for the previous page. Returned when a previous page exists.
nextCursorstring
Cursor for the next page. Returned when more results are available.
itemsarray
List of Deal objects.
Show child parametersShow child parameters
Error Codes
resultCoderesultStatusresultMessageTroubleshooting
SUCCESSSsuccessN/A
PARAM_ILLEGALFInvalid parameter.Check `limit` is within 1-100. Ensure `fromCreatedAt`/`toCreatedAt` use the ISO 8601 format and the range does not exceed 30 days.
USER_NOT_EXISTFThe user does not exist or has not completed KYC verification.Complete KYC verification before listing deals.
AUTHORIZATION_NOT_EXISTFThe authorization relationship does not exist.Ensure the `account-id` header references a sub-merchant authorized under your client.
UNKNOWN_EXCEPTIONUAn unknown exception occurred. Contact technical support.Retry later or contact technical support.
Definition
POST /api/open/v1/fx/deals/list
Request
{
"limit": 20,
"sellCurrency": "USD",
"buyCurrency": "HKD",
"status": "SUCCESS",
"requestIds": [
  "REQ20260402001"
]
}
Response
{
"result": {
  "resultCode": "SUCCESS",
  "resultMessage": "success",
  "resultStatus": "S"
},
"nextCursor": "eyJsYXN0X2lkIjoiREVBTDAyMCJ9",
"items": [
  {
    "id": "DEAL20260402001",
    "requestId": "REQ20260402001",
    "dealType": "UNFUNDED_SPOT",
    "quote": {
      "quoteId": "QT202604021208001",
      "currencyPair": "USD/HKD",
      "clientRate": 7.785,
      "effectiveAt": "2026-04-02T04:08:56Z",
      "expiresAt": "2026-04-02T04:09:56Z"
    },
    "sellAmount": {
      "currency": "USD",
      "value": 10000
    },
    "buyAmount": {
      "currency": "HKD",
      "value": 77850
    },
    "status": "SUCCESS",
    "createdAt": "2026-04-02T04:09:35Z",
    "settledAt": "2026-04-02T06:09:35Z"
  }
]
}