Get the connection status of a device

get/merchants/{merchantAccount}/devices/{deviceId}/status

API Version

Check if the specified payment terminal or SDK installation ID (in an IPP Mobile solution) has an active cloud connection.

To make this request, your API credential must have the following role:

Cloud Device API role

Endpoint destination URL

Path Parameters

Required

Optional

The unique identifier of the device.

For a payment terminal, use the terminal ID in the format [terminal model]-[serial number], for example, P400‑123456789. In a Mobile solution, use the installation ID of the SDK.

The unique identifier of the merchant account.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

200
Successful operation
deviceIdstring
The unique identification of the device. This can be a payment terminal ID in the format [terminal model]-[serial number] (for example, P400‑123456789), or an SDK installation ID as used in Mobile solutions.
statusstring
Indicates if the device has an active cloud connection. Possible values:

ONLINE

OFFLINE
401
Unauthorized
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
namestring
The field that has an invalid value.
valuestring
The invalid value.
messagestring
Description of the validation error.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.
403
Forbidden
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
namestring
The field that has an invalid value.
valuestring
The invalid value.
messagestring
Description of the validation error.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.

Get the connection status of a device

HTTP Responses

200

401

403