v16

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-0151462.7 KB

General

Get the list of terminals

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.

post/getTerminalsUnderAccount

Request body

companyAccountstring required

Your company account. If you only specify this parameter, the response includes all terminals at all account levels.

merchantAccountstring

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.

storestring

The store code of the store. With this parameter, the response only includes the terminals assigned to the specified store.

Response

OK - the request has succeeded.

companyAccountstring required

Your company account.

inventoryTerminalsstring[]

Array that returns a list of all terminals that are in the inventory of the company account.