Get the list of terminals
Use Management API.
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).
From January 1, 2025 POS Terminal Management API is deprecated and support stops on April 1, 2025. To automate the management of your terminal fleet, use our Management API.
Your company account. If you only specify this parameter, the response includes all terminals at all account levels.
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.
The store code of the store. With this parameter, the response only includes the terminals assigned to the specified store.
After submitting a call, you receive a response message to inform you that your request was received and processed.
Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.
HTTP Responses
200 - OK
The request has succeeded.
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.