Get a list of terminals

get/terminals

API Version

Returns the payment terminals that the API credential has access to and that match the query parameters. To make this request, your API credential must have the following roles:

Management API — Terminal actions read

In the live environment, requests to this endpoint are subject to rate limits.

Endpoint destination URL

https://management-test.adyen.com/v1/terminals

Query Parameters

Required

Optional

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

The number of the page to fetch.

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

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

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

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

Returns one or more terminals associated with the one-time passwords specified in the request. If this query parameter is used, other query parameters are ignored.

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.
_linksobject
Pagination references.
firstobject
The first page.
hrefstring
lastobject
The last page.
hrefstring
nextobject
The next page. Only present if there is a next page.
hrefstring
prevobject
The previous page. Only present if there is a previous page.
hrefstring
selfobject
The current page.
hrefstring
dataarray[object]
The list of terminals and their details.
assignedbooleanDeprecated
The assignment status of the terminal. If true, the terminal is assigned. If false, the terminal is in inventory and can't be boarded.
bluetoothIpstringDeprecated
The Bluetooth IP address of the terminal.
bluetoothMacstringDeprecated
The Bluetooth MAC address of the terminal.
citystringDeprecated
The city where the terminal is located.
companyAccountstringDeprecated
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.
countryCodestringDeprecated
The country code of the country where the terminal is located.
deviceModelstringDeprecated
The model name of the terminal.
ethernetIpstringDeprecated
The ethernet IP address of the terminal.
ethernetMacstringDeprecated
The ethernet MAC address of the terminal.
firmwareVersionstring
The software release currently in use on the terminal.
iccidstringDeprecated
The integrated circuit card identifier (ICCID) of the SIM card in the terminal.
idstring
The unique identifier of the terminal.
lastActivityDateTimestringDeprecated
Date and time of the last activity on the terminal. Not included when the last activity was more than 14 days ago.
lastTransactionDateTimestringDeprecated
Date and time of the last transaction on the terminal.
linkNegotiationstringDeprecated
The Ethernet link negotiation that the terminal uses:

auto: Auto-negotiation

100full: 100 Mbps full duplex

serialNumberstring
The serial number of the terminal.
simStatusstringDeprecated
On a terminal that supports 3G or 4G connectivity, indicates the status of the SIM card in the terminal: ACTIVE or INVENTORY.
statusstringDeprecated
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.
storeStatusstringDeprecated
The status of the store that the terminal is assigned to.
wifiIpstringDeprecated
The terminal's IP address in your Wi-Fi network.
wifiMacstringDeprecated
The terminal's MAC address in your Wi-Fi network.
wifiSsidstringDeprecated
The SSID of the Wi-Fi network that your terminal is connected to.
itemsTotalinteger
Total number of items.
pagesTotalinteger
Total number of pages.
400 - Bad Request
A problem reading or understanding the request.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[InvalidFieldWrapper]
Detailed explanation of each validation error, when applicable.
InvalidFieldobject
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
401 - Unauthorized
Authentication required.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[InvalidFieldWrapper]
Detailed explanation of each validation error, when applicable.
InvalidFieldobject
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
403 - Forbidden
Insufficient permissions to process the request.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[InvalidFieldWrapper]
Detailed explanation of each validation error, when applicable.
InvalidFieldobject
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
422 - Unprocessable Entity
A request validation error.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[InvalidFieldWrapper]
Detailed explanation of each validation error, when applicable.
InvalidFieldobject
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
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.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[InvalidFieldWrapper]
Detailed explanation of each validation error, when applicable.
InvalidFieldobject
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.

Get a list of terminals

HTTP Responses

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error