General

Get the details of a terminal

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.

From January 1, 2025 POS Terminal Management API is deprecated and support stops on April 1, 2025. To automate the management of your terminal fleet, use our Management API.

post/getTerminalDetails

Request body

terminalstring required

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

For example, V400m-324689776.

Response

OK - the request has succeeded.

bluetoothIpstring

The Bluetooth IP address of the terminal.

bluetoothMacstring

The Bluetooth MAC address of the terminal.

companyAccountstring required

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 nullable

The label shown on the status bar of the display. This label (if any) is specified in your Customer Area.

ethernetIpstring nullable

The terminal's IP address in your Ethernet network.

ethernetMacstring nullable

The terminal's MAC address in your Ethernet network.

firmwareVersionstring

The software release currently in use on the terminal.

iccidstring nullable

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

lastActivityDateTimestring date-time nullable

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

lastTransactionDateTimestring date-time nullable

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

linkNegotiationstring nullable

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 nullable

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.

terminalstring required

The unique terminal ID.

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.

Changes

Changed in 4 of the 16 revisions of this API.172

Dec 30, 2025v10796603204688See the full diff
- ▲
  the response property displayLabel became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property ethernetIp became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property ethernetMac became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property iccid became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property lastActivityDateTime became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property lastTransactionDateTime became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property linkNegotiation became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property simStatus became nullable for the status 200
  response-property-became-nullable
Jan 6, 2025v19c22824cacf11See the full diff
- ○
  endpoint deprecated
  endpoint-deprecated
Jun 22, 2023v16c089164bff11See the full diff
- ○
  the endpoint scheme security BasicAuth was added to the API
  api-security-added
Mar 7, 2023v1a1d5aadcf2a39See the full diff
- ▲
  the request's body type/format changed from / to object/
  request-body-type-changed
- ▲
  the response's body type/format changed from / to object/ for status 200
  response-body-type-changed
- ▲
  the response's body type/format changed from / to object/ for status 400
  response-body-type-changed
- ▲
  the response's body type/format changed from / to object/ for status 401
  response-body-type-changed
- ▲
  the response's body type/format changed from / to object/ for status 403
  response-body-type-changed
- ▲
  the response's body type/format changed from / to object/ for status 422
  response-body-type-changed
- ▲
  the response's body type/format changed from / to object/ for status 500
  response-body-type-changed
- ▲
  the storeDetails response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ▲
  the storeDetails/address response's property type/format changed from / to object/ for status 200
  response-property-type-changed

Full history