Poll - Transaction List
Send a request using the poll method to trigger and print a Transaction List report for a specified date range on a PAX POS device.
This endpoint retrieves a list of transactions from the terminal within a specified date range.
Flow:
Send request to terminal with start and end dates (ISO 8601 format) and pollId.
Terminal queries transactions within the date range.
Poll the /poll/reportResponse/{pollId} endpoint to retrieve the response.
Response: The response will contain eventType "REPORT_INFORMATION", reportType "TRANSACTION_LIST", and a transactionList array.
Note
Report requests do not trigger a SALE_RECEIVED event. The terminal immediately processes the request. To retrieve the result, you must poll the /poll/reportResponse/{pollId} endpoint, NOT the standard terminal response endpoint.
disablePrinting
Indicates if to print a receipt. Default is
false(printing is enabled by default for reports).
startDate
The start date of the reporting period in ISO 8601 format (e.g., "2025-12-08T00:00:00Z").
endDate
The end date of the reporting period in ISO 8601 format (e.g., "2025-12-08T23:59:59Z").
pollId
The ID used to poll after a terminal response.
deviceToken
The token of a PAX POS device.
correlationId
An ID provided by the caller. Will be returned in the callback for message matching.
timeToLive
The maximum time, in seconds, for a request to reach the physical terminal. The default value is 5 seconds.
terminalId
If terminal has more than one merchant, this field is used to identify the merchant. To get a list of merchants, use the requestMerchantConfig request. Value can be null.
type
Example: https://tools.ietf.org/html/rfc7231#section-6.5.1
title
Bad Request
status
400
detail
DeviceId not registered
message
Unauthorized
message
Server Error
/poll/transactionlist
202 Accepted Poll Transaction List
curl -X post https://CloudLinkApi/poll/transactionlist \ -H 'X-API-KEY: your-access-key-here' \ -d ' { "disablePrinting": false, "startDate": "2025-12-08T00:00:00Z", "endDate": "2025-12-08T23:59:59Z", "pollId": "e855e0cf-a026-4614-9dcb-58814455b6a4", "deviceToken": "b16526c3447ba6cea4818d", "correlationId": "5d1d4ea-8229-44d7-b517-26a5ae6c2fda", "timeToLive": 5, "terminalId": null } '{ "message": "Accepted" }
400 Bad Request
curl -X post https://CloudLinkApi/poll/transactionlist \ -H 'X-API-KEY: your-access-key-here' \ -d ' { "disablePrinting": false, "startDate": "2025-12-08T00:00:00Z", "endDate": "2025-12-08T23:59:59Z", "pollId": "e855e0cf-a026-4614-9dcb-58814455b6a4", "deviceToken": "b16526c3447ba6cea4818d", "correlationId": "5d1d4ea-8229-44d7-b517-26a5ae6c2fda", "timeToLive": 5, "terminalId": null } '{ "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1", "title": "Bad Request", "status": 400, "detail": "DeviceId not registered" }
401 Unauthorized
curl -X post https://CloudLinkApi/poll/transactionlist \ -H 'X-API-KEY: your-access-key-here' \ -d ' { "disablePrinting": false, "startDate": "2025-12-08T00:00:00Z", "endDate": "2025-12-08T23:59:59Z", "pollId": "e855e0cf-a026-4614-9dcb-58814455b6a4", "deviceToken": "b16526c3447ba6cea4818d", "correlationId": "5d1d4ea-8229-44d7-b517-26a5ae6c2fda", "timeToLive": 5, "terminalId": null } '{ "message": "Unauthorized" }
500 Server Error
curl -X post https://CloudLinkApi/poll/transactionlist \ -H 'X-API-KEY: your-access-key-here' \ -d ' { "disablePrinting": false, "startDate": "2025-12-08T00:00:00Z", "endDate": "2025-12-08T23:59:59Z", "pollId": "e855e0cf-a026-4614-9dcb-58814455b6a4", "deviceToken": "b16526c3447ba6cea4818d", "correlationId": "5d1d4ea-8229-44d7-b517-26a5ae6c2fda", "timeToLive": 5, "terminalId": null } '{ "message": "Server Error" }