---
title: "Get the details of a terminal"
method: POST
path: "/getTerminalDetails"
tags: ["General"]
---

# 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.

## Request body

- GetTerminalDetailsRequest
  - `terminal` string, required — The unique terminal ID in the format `[Device model]-[Serial number]`. For example, **V400m-324689776**.

## Response `200`

OK - the request has succeeded.

- GetTerminalDetailsResponse
  - `bluetoothIp` string — The Bluetooth IP address of the terminal.
  - `bluetoothMac` string — The Bluetooth MAC address of the terminal.
  - `companyAccount` string, 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.
  - `country` string — The country where the terminal is used.
  - `deviceModel` string — The model name of the terminal.
  - `dhcpEnabled` boolean — Indicates whether assigning IP addresses through a DHCP server is enabled on the terminal.
  - `displayLabel` string — The label shown on the status bar of the display. This label (if any) is specified in your Customer Area.
  - `ethernetIp` string — The terminal's IP address in your Ethernet network.
  - `ethernetMac` string — The terminal's MAC address in your Ethernet network.
  - `firmwareVersion` string — The software release currently in use on the terminal.
  - `iccid` string — The integrated circuit card identifier (ICCID) of the SIM card in the terminal.
  - `lastActivityDateTime` string, date-time — Date and time of the last activity on the terminal. Not included when the last activity was more than 14 days ago.
  - `lastTransactionDateTime` string, date-time — Date and time of the last transaction on the terminal. Not included when the last transaction was more than 14 days ago.
  - `linkNegotiation` string — The Ethernet link negotiation that the terminal uses: - `auto`: Auto-negotiation - `100full`: 100 Mbps full duplex
  - `merchantAccount` string — 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.
  - `merchantInventory` boolean — 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.
  - `permanentTerminalId` string — The permanent terminal ID.
  - `serialNumber` string — The serial number of the terminal.
  - `simStatus` string — On a terminal that supports 3G or 4G connectivity, indicates the status of the SIM card in the terminal: ACTIVE or INVENTORY.
  - `store` string — The store code of the store that the terminal is assigned to.
  - `storeDetails` Store
    - `address` Address
      - `city` string
      - `countryCode` string
      - `postalCode` string
      - `stateOrProvince` string
      - `streetAddress` string
      - `streetAddress2` string
    - `description` string — The description of the store.
    - `inStoreTerminals` string[] — The list of terminals assigned to the store.
    - `merchantAccountCode` string — The code of the merchant account.
    - `status` string — 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.
    - `store` string, required — The code of the store.
  - `terminal` string, 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.
  - `wifiIp` string — The terminal's IP address in your Wi-Fi network.
  - `wifiMac` string — The terminal's MAC address in your Wi-Fi network.

## Other responses

- `400` — Bad Request - a problem reading or understanding the request.
- `401` — Unauthorized - authentication required.
- `403` — Forbidden - insufficient permissions to process the request.
- `422` — Unprocessable Entity - a request validation error.
- `500` — Internal Server Error - the server could not process the request.

---

[API](https://skmtc.net/adyen/apis/tfmapiservice.md) · [All operations](https://skmtc.net/adyen/apis/tfmapiservice/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/adyen/tfmapiservice/versions/4c0e71faa937/schema)