Sign in

v1

latestOpenAPI 3.1.02026-07-1451432.5 KB
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.

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

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

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

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.

terminalstring required

The unique terminal ID.

terminalStatus'OnlineLast1Day' | 'OnlineLast2Days' | 'OnlineLast3Days' | 'OnlineLast4Days' | 'OnlineLast5Days' | 'OnlineLast6Days' | 'OnlineLast7Days' | 'OnlineToday' | 'ReAssignToInventoryPending' | 'ReAssignToMerchantInventoryPending' | 'ReAssignToStorePending' | 'SwitchedOff'

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.