Management v1 - Get a list of terminals

Query parameters

Required Optional

pageSize integer

The number of items to have on a page, maximum 100. The default is 20 items on a page.

pageNumber integer

The number of the page to fetch.

brandModels string

Returns terminals of the models specified in the format brand.model.

storeIds string

Returns terminals that are assigned to the stores specified by their unique store ID.

merchantIds string

Returns terminals that belong to the merchant accounts specified by their unique merchant account ID.

countries string

Returns terminals located in the countries specified by their two-letter country code.

searchQuery string

Returns terminals with an ID that contains the specified string. If present, other query parameters are ignored.

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 - OK

The request has succeeded.
Show more Show less
data array [object]

The list of terminals.

Show children Hide children

assigned boolean

The assignment status of the terminal. If true, the terminal is assigned. If false, the terminal is in inventory and can't be boarded.

bluetoothIp string

The Bluetooth IP address of the terminal.

bluetoothMac string

The Bluetooth MAC address of the terminal.

city string

The city where the terminal is located.

companyAccount string

The company account that the terminal is associated with. If this is the only account level shown in the response, the terminal is assigned to the inventory of the company account.

countryCode string

The country code of the country where the terminal is located.

deviceModel string

The model name of the terminal.

ethernetIp string

The ethernet IP address of the terminal.

ethernetMac string

The ethernet MAC address of the terminal.

firmwareVersion string

The software release currently in use on the terminal.

iccid string

The integrated circuit card identifier (ICCID) of the SIM card in the terminal.

id string

The unique identifier of the terminal.

lastActivityDateTime string

Date and time of the last activity on the terminal. Not included when the last activity was more than 14 days ago.

lastTransactionDateTime string

Date and time of the last transaction on the terminal. Not included when the last transaction was more than 14 days ago.

linkNegotiation string

The Ethernet link negotiation that the terminal uses:

auto: Auto-negotiation

100full: 100 Mbps full duplex

serialNumber string

The serial number of the terminal.

simStatus string

On a terminal that supports 3G or 4G connectivity, indicates the status of the SIM card in the terminal: ACTIVE or INVENTORY.

status string

Indicates when the terminal was last online, whether the terminal is being reassigned, or whether the terminal is turned off. If the terminal was last online more that a week ago, it is also shown as turned off.

storeStatus string

The status of the store that the terminal is assigned to.

wifiIp string

The terminal's IP address in your Wi-Fi network.

wifiMac string

The terminal's MAC address in your Wi-Fi network.

wifiSsid string

The SSID of the Wi-Fi network that your terminal is connected to.
400 - Bad Request

A problem reading or understanding the request.
Show more Show less
detail string

A human-readable explanation specific to this occurrence of the problem.

errorCode string

A code that identifies the problem type.

instance string

A unique URI that identifies the specific occurrence of the problem.

invalidFields array [object]

Detailed explanation of each validation error, when applicable.

Show children Hide children

message string

Description of the validation error.

name string

The field that has an invalid value.

value string

The invalid value.

requestId string

A unique reference for the request, essentially the same as pspReference.

response object

JSON response payload.

Show children Hide children

paths array [object]

Show children Hide children

content array [string]

rootPath object

Show children Hide children

content array [string]

status integer

The HTTP status code.

title string

A short, human-readable summary of the problem type.

type string

A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
401 - Unauthorized

Authentication required.
Show more Show less
detail string

A human-readable explanation specific to this occurrence of the problem.

errorCode string

A code that identifies the problem type.

instance string

A unique URI that identifies the specific occurrence of the problem.

invalidFields array [object]

Detailed explanation of each validation error, when applicable.

Show children Hide children

message string

Description of the validation error.

name string

The field that has an invalid value.

value string

The invalid value.

requestId string

A unique reference for the request, essentially the same as pspReference.

response object

JSON response payload.

Show children Hide children

paths array [object]

Show children Hide children

content array [string]

rootPath object

Show children Hide children

content array [string]

status integer

The HTTP status code.

title string

A short, human-readable summary of the problem type.

type string

A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
403 - Forbidden

Insufficient permissions to process the request.
Show more Show less
detail string

A human-readable explanation specific to this occurrence of the problem.

errorCode string

A code that identifies the problem type.

instance string

A unique URI that identifies the specific occurrence of the problem.

invalidFields array [object]

Detailed explanation of each validation error, when applicable.

Show children Hide children

message string

Description of the validation error.

name string

The field that has an invalid value.

value string

The invalid value.

requestId string

A unique reference for the request, essentially the same as pspReference.

response object

JSON response payload.

Show children Hide children

paths array [object]

Show children Hide children

content array [string]

rootPath object

Show children Hide children

content array [string]

status integer

The HTTP status code.

title string

A short, human-readable summary of the problem type.

type string

A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
422 - Unprocessable Entity

A request validation error.
Show more Show less
detail string

A human-readable explanation specific to this occurrence of the problem.

errorCode string

A code that identifies the problem type.

instance string

A unique URI that identifies the specific occurrence of the problem.

invalidFields array [object]

Detailed explanation of each validation error, when applicable.

Show children Hide children

message string

Description of the validation error.

name string

The field that has an invalid value.

value string

The invalid value.

requestId string

A unique reference for the request, essentially the same as pspReference.

response object

JSON response payload.

Show children Hide children

paths array [object]

Show children Hide children

content array [string]

rootPath object

Show children Hide children

content array [string]

status integer

The HTTP status code.

title string

A short, human-readable summary of the problem type.

type string

A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
500 - Internal Server Error

The server could not process the request.
Show more Show less
detail string

A human-readable explanation specific to this occurrence of the problem.

errorCode string

A code that identifies the problem type.

instance string

A unique URI that identifies the specific occurrence of the problem.

invalidFields array [object]

Detailed explanation of each validation error, when applicable.

Show children Hide children

message string

Description of the validation error.

name string

The field that has an invalid value.

value string

The invalid value.

requestId string

A unique reference for the request, essentially the same as pspReference.

response object

JSON response payload.

Show children Hide children

paths array [object]

Show children Hide children

content array [string]

rootPath object

Show children Hide children

content array [string]

status integer

The HTTP status code.

title string

A short, human-readable summary of the problem type.

type string

A URI that identifies the problem type, pointing to human-readable documentation on this problem type.

Get a list of terminals

Endpoint destination URL

Query parameters

Response parameters

HTTP Responses

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error