---
title: "View terminal list"
method: GET
path: "/pay/v3/getTerminalList"
tags: ["Retail"]
---

# View terminal list

`GET /pay/v3/getTerminalList`

Retrieves a list of available terminals. You use the `terminalId` from this response in order to send a POST request to the [Process transaction from terminal](https://docs.nexiopay.com/reference/processtransactionfromterminal) endpoint.

<!-- theme: info -->
> 📘 Note 
> 
> Terminals must be configured before they are available for processing. Depending on the terminal and your merchant account configuration, you need to either [pair the terminal](https://docs.nexiopay.com/reference/pairterminal) or [register the terminal](https://docs.nexiopay.com/reference/registerterminal). For additional information about this process, see the [Getting started with retail](https://docs.nexiopay.com/docs/getting-started-with-retail) topic in Guides.
> 
> If you do not see your terminal in the list retrieved through this endpoint, contact [Integrations Support](https://docs.nexiopay.com/page/contact-us) for assistance.

<!-- theme: warning -->
> ⚠️ Try It
> 
> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](https://docs.nexiopay.com/docs/sandbox-environments).

<div style="display:none;">

## Response parameters
- gatewayLabel
- gatewayName
- gatewayType
- merchantId
- merchantName
- terminalId
- terminalName
- terminalSerialNumber
- terminalKey
- terminalStatus

</div>

## Response `200`

Success

- object[] — An array of available terminals
  - `terminalId` string — The Nexio terminal ID. You use this value to send a POST request to the [Process transaction from terminal](https://docs.nexiopay.com/reference/processtransactionfromterminal) endpoint.
  - `terminalSerialNumber` string — The terminal serial number.
  - `deviceId` DeviceId — unresolved $ref
  - `terminalKey` string — If returned from the gateway, specifies [USAePay's](https://docs.nexiopay.com/docs/usaepay-integration-guide) unique identifier for an instance of a specific terminal paired to the platform.
  - `terminalName` TerminalName — unresolved $ref
  - `terminalStatus` 'connected' | 'disconnected' — The current status of the terminal.
  - `merchantId` string — The Nexio merchant ID (MID) associated with the terminal.
  - `merchantName` string — The merchant name.
  - `gatewayName` GatewayName — unresolved $ref
  - `gatewayType` integer — The gateway type.
  - `gatewayLabel` string — The gateway label.

## Other responses

- `401` — Unauthorized. For help with this error and other error codes, see [Common errors](https://docs.nexiopay.com/docs/common-errors) in the Guides area.

---

[API](https://skmtc.dev/nexiopay/apis/payments-api-reference.md) · [All operations](https://skmtc.dev/nexiopay/apis/payments-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nexiopay/payments-api-reference/revisions/b414b73979e5/schema)