---
title: "Get Device Status"
method: POST
path: "/devices/getstatus"
tags: ["Devices"]
---

# Get Device Status

`POST /devices/getstatus`

This function is used to get the status of the device.

**Integration Methods:**
- Commerce Engine For On Premise
- Commerce Engine For Cloud

See the [Integration Methods](/guides/quickstart#integration-methods) and [URLs Section](/guides/quickstart#urls) sections of the Development Quick Start guide for details regarding each processing option.

## Headers

- `InterfaceVersion` string, required
- `InterfaceName` string, required
- `CompanyName` string, required
- `AccessToken` string, uuid, required

## Request body

- union
  - DevicesGetstatusComengdevice
    - `dateTime` string, ISO 8601, required — The date and time in ISO 8601 format including the timezone offset (yyyy-mm-ddThh:mm:ss.nnn+hh:mm). Must be sent as the local date/time of the merchant. For example, a request processed at a merchant in the Pacific time zone at 9:18am on April 15th 2021 would be sent as 2021-04-15T09:18:23.283-07:00
  - DevicesGetstatusComengcloud
    - `dateTime` string, ISO 8601, required — The date and time in ISO 8601 format including the timezone offset (yyyy-mm-ddThh:mm:ss.nnn+hh:mm). Must be sent as the local date/time of the merchant. For example, a request processed at a merchant in the Pacific time zone at 9:18am on April 15th 2021 would be sent as 2021-04-15T09:18:23.283-07:00
    - `device` DeviceComEngCloud, required
      - `cloud` boolean, required — Indicates the transaction will be processed via the Commerce Engine solution for cloud based POS/PMS systems. Value must be sent as `true` in order to route the request to the payment device at the merchant location.
      - `manufacturer` 'Ingenico' | 'Innowi' | 'PAX' | 'Verifone' | 'Castles' | 'Miura', required — Specifies the company which manufactured the device.
      - `serialNumber` string, required — Specifies the serial number of the device.

## Response `200`

Request was processed

- object
  - `result` object[]
    - `cloudRegistered` 'Y' | 'N' — Specifies whether or not the device is registerd with the cloud service. | Value | Description | |-------|----------------------------------------------------------| | Y | Device is successfully registered with the cloud service | | N | Device is not registered with the cloud service |
    - `cloudConnected` 'Y' | 'N' — Specifies whether or not the device is successfully connected to the cloud service. | Value | Description | |-------|----------------------------------------------------------| | Y | Device is successfully connected to the cloud service | | N | Device is unable to connect to the cloud service |
    - `offlineMode` 'Y' | 'N' | 'U' — Specifies whether or not the device is in offline mode. | Value | Description | |-------|--------------------| | Y | Device is offline | | N | Device is online | | U | Offline status is unknown. For example, when sending the Get Device Status command via Commerce Engine For Cloud and the device is not connected.|

## Other responses

- `400` — Error
- `504` — Timeout

---

[API](https://skmtc.dev/shift4/apis/shift4-payment-api.md) · [All operations](https://skmtc.dev/shift4/apis/shift4-payment-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/shift4/shift4-payment-api/revisions/2f85c87cc9e5/schema)