Get the details of a terminal

post/getTerminalDetails

Returns the details of a payment terminal, including where the terminal is assigned to. The response returns the same details that are provided in the terminal list in your Customer Area and in the Terminal Fleet report.

Endpoint destination URL

https://postfmapi-test.adyen.com/postfmapi/terminal/v1/getTerminalDetails

Request Parameters

Required

Optional

The unique terminal ID in the format [Device model]-[Serial number].

For example, V400m-324689776.

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
bluetoothIpstring
The Bluetooth IP address of the terminal.
bluetoothMacstring
The Bluetooth MAC address of the terminal.
companyAccountstring
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.
countrystring
The country where the terminal is used.
deviceModelstring
The model name of the terminal.
dhcpEnabledboolean
Indicates whether assigning IP addresses through a DHCP server is enabled on the terminal.
displayLabelstring
The label shown on the status bar of the display. This label (if any) is specified in your Customer Area.
ethernetIpstring
The terminal's IP address in your Ethernet network.
ethernetMacstring
The terminal's MAC address in your Ethernet network.
firmwareVersionstring
The software release currently in use on the terminal.
iccidstring
The integrated circuit card identifier (ICCID) of the SIM card in the terminal.
lastActivityDateTimestring
Date and time of the last activity on the terminal. Not included when the last activity was more than 14 days ago.
lastTransactionDateTimestring
Date and time of the last transaction on the terminal. Not included when the last transaction was more than 14 days ago.
linkNegotiationstring
The Ethernet link negotiation that the terminal uses:

auto: Auto-negotiation

100full: 100 Mbps full duplex

merchantAccountstring
The merchant account that the terminal is associated with. If the response doesn't contain a store the terminal is assigned to this merchant account.
merchantInventoryboolean
Boolean that indicates if the terminal is assigned to the merchant inventory. This is returned when the terminal is assigned to a merchant account.

If true, this indicates that the terminal is in the merchant inventory. This also means that the terminal cannot be boarded.

If false, this indicates that the terminal is assigned to the merchant account as an in-store terminal. This means that the terminal is ready to be boarded, or is already boarded.

permanentTerminalIdstring
The permanent terminal ID.
serialNumberstring
The serial number of the terminal.
simStatusstring
On a terminal that supports 3G or 4G connectivity, indicates the status of the SIM card in the terminal: ACTIVE or INVENTORY.
storestring
The store code of the store that the terminal is assigned to.
storeDetailsobject
The store that the terminal is assigned to.
Show children Hide children
addressobject
The address of the store.
Show children Hide children
citystring
countryCodestring
postalCodestring
stateOrProvincestring
streetAddressstring
streetAddress2string
descriptionstring
The description of the store.
inStoreTerminalsarray[string]
The list of terminals assigned to the store.
merchantAccountCodestring
The code of the merchant account.
statusstring
The status of the store:

PreActive: the store has been created, but not yet activated.

Active: the store has been activated. This means you can process payments for this store.

Inactive: the store is currently not active.

InactiveWithModifications: the store is currently not active, but payment modifications such as refunds are possible.

Closed: the store has been closed.

storestring
The code of the store.
terminalstring
The unique terminal ID.
terminalStatusstring
The status of the terminal:

OnlineToday, OnlineLast1Day, OnlineLast2Days etcetera to OnlineLast7Days: Indicates when in the past week the terminal was last online.

SwitchedOff: Indicates it was more than a week ago that the terminal was last online.

ReAssignToInventoryPending, ReAssignToStorePending, ReAssignToMerchantInventoryPending: Indicates the terminal is scheduled to be reassigned.

wifiIpstring
The terminal's IP address in your Wi-Fi network.
wifiMacstring
The terminal's MAC address in your Wi-Fi network.
400 - Bad Request
A problem reading or understanding the request.
Show more Show less
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
401 - Unauthorized
Authentication required.
Show more Show less
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
403 - Forbidden
Insufficient permissions to process the request.
Show more Show less
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
422 - Unprocessable Entity
A request validation error.
Show more Show less
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
500 - Internal Server Error
The server could not process the request.
Show more Show less
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.

Get the details of a terminal

Request Parameters

Response parameters

HTTP Responses

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error