X Report

This endpoint triggers an X Report on the payment terminal. An X Report shows current transaction totals without closing the batch.

Flow:

Send request to terminal.
Terminal processes the X report.
lTerminal sends response via webhook to your callback URL.

Response: The terminal will send a webhook with eventType "REPORT_INFORMATION" and reportType "X_REPORT".

Parameters

Request Header Parameters

Request Body Parameters

- disablePrinting
- Indicates if to print a receipt.
- callbackUrl
- The URL that CloudLinkApi will use to return information to the caller.
- deviceToken
- The token of a PAX POS device.
- correlationId
- An ID provided by the caller. Will be returned in the callback for message matching. In a cancel request, use the value from the sale/refund that is being cancelled.
- 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

/xreport

202 Accepted completion

curl -X
post https://CloudLinkApi/xreport
-H 'X-API-KEY: your-access-key-here'
-d '{
  "disablePrinting": true,
  "callbackUrl": "http://example.com/webhook-endpoint",
  "deviceToken": "b16526c3447ba6cea4818d",
  "correlationId": "5d1d4ea-8229-44d7-b517-26a5ae6c2fda",
  "timeToLive": 5,
  "terminalId": null
}
'

```
{
  "message": "Accepted"
}
```

400 Bad Request

curl -X
post https://CloudLinkApi/xreport
-H 'X-API-KEY: your-access-key-here'
-d '{
  "disablePrinting": true,
  "callbackUrl": "http://example.com/webhook-endpoint",
  "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 completion

curl -X
post https://CloudLinkApi/xreport
-H 'X-API-KEY: your-access-key-here'
-d '
{
  "disablePrinting": true,
  "callbackUrl": "http://example.com/webhook-endpoint",
  "deviceToken": "b16526c3447ba6cea4818d",
  "correlationId": "5d1d4ea-8229-44d7-b517-26a5ae6c2fda",
  "timeToLive": 5,
  "terminalId": null
}
'

```
{
  "message": "Unauthorized"
}
```

500 Server Error

curl -X
post https://CloudLinkApi/xreport
-H 'X-API-KEY: your-access-key-here'
-d '{
  "disablePrinting": true,
  "callbackUrl": "http://example.com/webhook-endpoint",
  "deviceToken": "b16526c3447ba6cea4818d",
  "correlationId": "5d1d4ea-8229-44d7-b517-26a5ae6c2fda",
  "timeToLive": 5,
  "terminalId": null
}
'

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

En esta sección:

Documentación