Get a list of connected devices

get/merchants/{merchantAccount}/connectedDevices

API Version

Get a list of payment devices or app installation IDs (in a Mobile solution) belonging to the specified merchant account that have an active cloud connection. The required store query parameter limits the list to the devices belonging to that store.

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

Cloud Device API role

Endpoint destination URL

Query Parameters

Required

Optional

The store ID of the store belonging to the merchant account specified in the path.

Path Parameters

Required

Optional

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
uniqueDeviceIdsarray[string]
A list of the unique IDs of the devices that have an active cloud connection. For a payment terminal, the unique ID is the POIID in the format: [device model]-[serial number]. For example, P400‑123456789.
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 a list of connected devices

HTTP Responses

200

401

403