Sign in

v1

latestOpenAPI 3.1.02026-08-06731,0781.4 MB
Devices

Device Information

This function is used to request information regarding the status of a specific Commerce Engine or UTG-controlled PIN pad. Depending on the type of device in use, this request may return a variety of device information in the response, including the types of encryption keys injected on the device.

Note: The GET request does not support a request body. Sending an empty request body may result in an error.

Integration Methods:

  • Commerce Engine For On Premise
  • Locally Installed UTG

See the Integration Methods and URLs Section sections of the Development Quick Start guide for details regarding each processing option.

get/devices/info

Headers

TerminalIdstring
Example:1742

Conditional: Required for UTG, optional for Commerce Engine.

The API Terminal ID assigned to the device.

For UTG it is configured in TuneUp and must be included in the request

For Commerce Engine it is defined in the Terminal Management System (TMS) and is optional. If sent, it must match the value defined in the TMS.

InterfaceVersionstring required
Example:2.1

Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed: $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \ + =

InterfaceNamestring required
Example:ForwardPOS

Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed: $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \ + =

CompanyNamestring required
Example:PAWS

Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed: $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \ + =

AccessTokenstring uuid required
Example:EA79FB05-3AA7-4500-AF9A-73F986FF2C1D

A security credential used to authenticate API requests and all i4Go® authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an Access Token Exchange request, which generates an Access Token using an authToken and clientGuid.

Response

Request was processed

OR
OR

Example response

{
  "result": [
    {
      "dateTime": "2024-05-21T09:18:23.283-07:00",
      "device": {
        "terminalId": "GBAIOQAN11",
        "serialNumber": "1170301234",
        "manufacturer": "PAX",
        "model": "A800"
      },
      "hardware": {
        "cpu": "cortex-a53 (8 cores @ 1.8 GHz)",
        "ramMb": "1854",
        "storageMbTotal": "12297",
        "storageMbFree": "9869",
        "storageMbUsed": "2428",
        "batteryLevel": "83"
      },
      "firmware": {
        "firmwareVersion": "PayDroid_10.0.0_Eucalyptus_V20.1.28_20250915/4.11.00_20250120",
        "androidVersion": "10",
        "emvKernelVersion": "v659 2025.02.26",
        "ctlsKernelVersion": "v558 2025.04.10;v359_02 2025.02.20;v557_01 2024.01.15;v252_01 2023.02.09;v155 2024.12.19;v353 2025.01.22;v153_02 2024.12.05;v253 2025.01.10;v153 2025.09.09"
      },
      "security": {
        "p2peVersion": "2.0.6.211.3.0",
        "pciHardwareVersion": "A800-0AW-RE6-10AA",
        "pciFirmwareVersion": "secver_26.01.0128;firmver_26.01.0128"
      },
      "applications": [
        {
          "name": "Commerce Engine",
          "packageName": "com.priv.shift4.commerceengine",
          "versionName": "2.14.0",
          "versionCode": 2140000
        },
        {
          "name": "Shift4 SOLO",
          "packageName": "com.shift4.bonepony",
          "versionName": "2.149.0",
          "versionCode": 2149000
        }
      ],
      "connectivity": {
        "activeInterface": "wifi",
        "ip": "192.168.4.200",
        "gateway": "192.168.4.1",
        "subnetMask": "255.255.255.0",
        "dns1": "8.8.8.8",
        "dns2": "8.8.4.4",
        "interfaces": {
          "wifi": {
            "mac": "F4:02:23:7F:57:C6",
            "ssid": "MerchantWiFi",
            "isUp": "Y",
            "signalStrength": "-46 dBm"
          },
          "cellular": {
            "imei": "354970460015528",
            "iccid": "8901240204204081862",
            "carrier": "T-Mobile",
            "isUp": "Y",
            "signalStrength": "-50 dBm"
          }
        }
      },
      "ui": {
        "language": "en",
        "supportedLanguages": [
          "en",
          "fr",
          "es",
          "de",
          "it",
          "nl",
          "pt",
          "lt",
          "no",
          "sv",
          "da",
          "ro",
          "cs",
          "fi",
          "pl"
        ]
      },
      "server": {
        "name": "TM01CE"
      }
    }
  ]
}