Sign in
Retail

View terminal list

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 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 or register the terminal. For additional information about this process, see the Getting started with retail topic in Guides.

If you do not see your terminal in the list retrieved through this endpoint, contact Integrations Support 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.

<div style="display:none;">

Response parameters

  • gatewayLabel
  • gatewayName
  • gatewayType
  • merchantId
  • merchantName
  • terminalId
  • terminalName
  • terminalSerialNumber
  • terminalKey
  • terminalStatus
</div>
get/pay/v3/getTerminalList

Response

Success

terminalIdstring

The Nexio terminal ID. You use this value to send a POST request to the Process transaction from terminal endpoint.

terminalSerialNumberstring

The terminal serial number.

deviceIdDeviceId — unresolved $ref
terminalKeystring

If returned from the gateway, specifies USAePay's unique identifier for an instance of a specific terminal paired to the platform.

terminalNameTerminalName — unresolved $ref
terminalStatus'connected' | 'disconnected'

The current status of the terminal.

merchantIdstring

The Nexio merchant ID (MID) associated with the terminal.

merchantNamestring

The merchant name.

gatewayNameGatewayName — unresolved $ref
gatewayTypeinteger

The gateway type.

gatewayLabelstring

The gateway label.

Changes