v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-131362831.1 MB
Terminals - terminal level

Get a list of terminals

Returns the payment terminals that the API credential has access to and that match the query parameters. To make this request, your API credential must have the following roles:

  • Management API — Terminal actions read

In the live environment, requests to this endpoint are subject to rate limits.

get/terminals

Query parameters

searchQuerystring

Returns terminals with an ID that contains the specified string. If present, other query parameters are ignored.

otpQuerystring

Returns one or more terminals associated with the one-time passwords specified in the request. If this query parameter is used, other query parameters are ignored.

countriesstring

Returns terminals located in the countries specified by their two-letter country code.

merchantIdsstring

Returns terminals that belong to the merchant accounts specified by their unique merchant account ID.

storeIdsstring

Returns terminals that are assigned to the stores specified by their unique store ID.

brandModelsstring

Returns terminals of the models specified in the format brand.model.

pageNumberinteger

The number of the page to fetch.

pageSizeinteger

The number of items to have on a page, maximum 100. The default is 20 items on a page.

Response

OK - the request has succeeded.

itemsTotalinteger required

Total number of items.

pagesTotalinteger required

Total number of pages.