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.

📘

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.

⚠️

Try It

To use the Try It feature for this endpoint, you must use the credentials for your Sandbox API user.

Response parameters

  • gatewayLabel
  • gatewayName
  • gatewayType
  • merchantId
  • merchantName
  • terminalId
  • terminalName
  • terminalSerialNumber
  • terminalKey
  • terminalStatus
Language
Authorization
Basic
base64
:
Click Try It! to start a request and see the response here!