Barcode Scan

This API is only supported for certain Pax terminals with camera scan support.

Scan a barcode using a px device

POST https://<Platform-host>/api/device/scan

The Barcode Scan API allows you to retrieve barcode scan result from a device using its deviceId. The API accepts a deviceId parameter in the request and returns the scan results, including the barcode value abd type.

Request

Name	Type	Description
merchant_id*	string	Merchant ID
data.device_id*	string	Registered and connected device ID

Response

200

{
  "merchant_id": "<merchant_id>",
  "device_id": "<deviceID>",
  "data": {
      "barcode_value": "123456789012",
      "barcode_type": "QRCode | 2DBarcode | 3Dbarcode"
  }
}

Overview