Get a list of terminals

get/terminals

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

Endpoint destination URL

https://management-test.adyen.com/v3/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.
Show moreShow less
_linksobject
Pagination references.
Show children Hide children
firstobject
The first page.
Show children Hide children
hrefstring
lastobject
The last page.
Show children Hide children
hrefstring
nextobject
The next page. Only present if there is a next page.
Show children Hide children
hrefstring
prevobject
The previous page. Only present if there is a previous page.
Show children Hide children
hrefstring
selfobject
The current page.
Show children Hide children
hrefstring
dataarray[object]
The list of terminals and their details.
Show children Hide children
assignmentobject
Indicates the account level to which the terminal is assigned, the assignment status, and where the terminals is in the process of being reassigned to.
Show children Hide children
companyIdstring
The unique identifier of the company account to which terminal is assigned.
merchantIdstring
The unique identifier of the merchant account to which terminal is assigned.
reassignmentTargetobject
Indicates where the terminal is in the process of being reassigned to.
Show children Hide children
companyIdstring
The unique identifier of the company account to which the terminal is reassigned.
inventoryboolean
Indicates if the terminal is reassigned to the inventory of the merchant account.

If true, the terminal is in the inventory of the merchant account and cannot process transactions.

If false, the terminal is reassigned directly to the merchant account and can process transactions.

merchantIdstring
The unique identifier of the merchant account to which the terminal is reassigned.
storeIdstring
The unique identifier of the store to which the terminal is reassigned.
statusstring
The status of the reassignment. Possible values:

reassignmentInProgress: the terminal was boarded and is now scheduled to remove the configuration. Wait for the terminal to synchronize with the Adyen platform.

deployed: the terminal is deployed and reassigned.

inventory: the terminal is in inventory and cannot process transactions.

boarded: the terminal is boarded to a store, or a merchant account representing a store, and can process transactions.

storeIdstring
The unique identifier of the store to which terminal is assigned.
connectivityobject
Information about bluetooth, cellular, ethernet and wifi connectivity for the terminal.
Show children Hide children
bluetoothobject
Show children Hide children
ipAddressstring
The terminal's Bluetooth IP address.
macAddressstring
The terminal's Bluetooth MAC address.
cellularobject
Show children Hide children
iccidstring
The integrated circuit card identifier (ICCID) of the SIM card in the terminal.
statusstring
On a terminal that supports 3G or 4G connectivity, indicates the status of the SIM card in the terminal.
ethernetobject
Show children Hide children
ipAddressstring
The terminal's ethernet IP address.
linkNegotiationstring
The ethernet link negotiation that the terminal uses.
macAddressstring
The terminal's ethernet MAC address.
wifiobject
Show children Hide children
ipAddressstring
The terminal's IP address in the Wi-Fi network.
macAddressstring
The terminal's MAC address in the Wi-Fi network.
ssidstring
The SSID of the Wi-Fi network that the terminal is connected to.
firmwareVersionstring
The software release currently in use on the terminal.
idstring
The unique identifier of the terminal.
lastActivityAtstring
Date and time of the last activity on the terminal. Not included when the last activity was more than 14 days ago.
lastTransactionAtstring
Date and time of the last transaction on the terminal. Not included when the last transaction was more than 14 days ago.
modelstring
The model name of the terminal.
restartLocalTimestring
The exact time of the terminal reboot, in the timezone of the terminal in HH:mm format.
serialNumberstring
The serial number of the terminal.
itemsTotalinteger
Total number of items.
pagesTotalinteger
Total number of pages.
400 - Bad Request
A problem reading or understanding the request.
Show more Show less
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[object]
Detailed explanation of each validation error, when applicable.
Show children Hide children
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.
Show more Show less
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[object]
Detailed explanation of each validation error, when applicable.
Show children Hide children
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.
Show more Show less
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[object]
Detailed explanation of each validation error, when applicable.
Show children Hide children
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.
Show more Show less
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[object]
Detailed explanation of each validation error, when applicable.
Show children Hide children
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.
Show more Show less
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[object]
Detailed explanation of each validation error, when applicable.
Show children Hide children
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

Query Parameters

Response parameters

HTTP Responses

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error