---
title: "Get the list of terminals"
method: POST
path: "/getTerminalsUnderAccount"
tags: ["General"]
---

# Get the list of terminals

`POST /getTerminalsUnderAccount`

Returns a list of payment terminals associated with a company account, merchant account, or store. The response shows whether the terminals are in the inventory, or in-store (ready for boarding or already boarded).

## Request body

- GetTerminalsUnderAccountRequest
  - `companyAccount` string, required — Your company account. If you only specify this parameter, the response includes all terminals at all account levels.
  - `merchantAccount` string — The merchant account. This is required if you are retrieving the terminals assigned to a store.If you don't specify a `store` the response includes the terminals assigned to the specified merchant account and the terminals assigned to the stores under this merchant account.
  - `store` string — The store code of the store. With this parameter, the response only includes the terminals assigned to the specified store.

## Response `200`

OK - the request has succeeded.

- GetTerminalsUnderAccountResponse
  - `companyAccount` string, required — Your company account.
  - `inventoryTerminals` string[] — Array that returns a list of all terminals that are in the inventory of the company account.
  - `merchantAccounts` MerchantAccount[] — Array that returns a list of all merchant accounts belonging to the company account.
    - `inStoreTerminals` string[] — List of terminals assigned to this merchant account as in-store terminals. This means that the terminal is ready to be boarded, or is already boarded.
    - `inventoryTerminals` string[] — List of terminals assigned to the inventory of this merchant account.
    - `merchantAccount` string, required — The merchant account.
    - `stores` Store[] — Array of stores under this merchant account.
      - `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.

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