Poll - X Report

Send a request using the poll method to trigger and print an X Report (interim running totals without closing the batch) on a PAX POS device.

This endpoint triggers an X Report on the payment terminal.

Flow:

Send request to terminal with pollId.
Terminal generates the X Report.
Poll the /poll/reportResponse/{pollId} endpoint to retrieve the response.

Response: The response will contain eventType "REPORT_INFORMATION" and reportType "X_REPORT".

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.

Parameters

Request Header Parameters

Request Body Parameters

- disablePrinting
- Indicates if to print a receipt. Default is false (printing is enabled by default for reports).

- 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.

202 Accepted Response

400 Error Response

- type
- Example: https://tools.ietf.org/html/rfc7231#section-6.5.1

- title
- Bad Request

- status
- 400

- detail
- DeviceId not registered

401 Error Response

- message
- Unauthorized

500 Error Response

- message
- Server Error

/poll/xreport

202 Accepted Poll X Report

curl -X post https://CloudLinkApi/poll/xreport \
-H 'X-API-KEY: your-access-key-here' \
-d '
{
  "disablePrinting": false,
  "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/xreport \
-H 'X-API-KEY: your-access-key-here' \
-d '
{
  "disablePrinting": false,
  "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/xreport \
-H 'X-API-KEY: your-access-key-here' \
-d '
{
  "disablePrinting": false,
  "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/xreport \
-H 'X-API-KEY: your-access-key-here' \
-d '
{
  "disablePrinting": false,
  "pollId": "e855e0cf-a026-4614-9dcb-58814455b6a4",
  "deviceToken": "b16526c3447ba6cea4818d",
  "correlationId": "5d1d4ea-8229-44d7-b517-26a5ae6c2fda",
  "timeToLive": 5,
  "terminalId": null
}
'

```
{
  "message": "Server Error"
}
```

In this section:

Documentation