GET /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:

Servers

Query parameters

Name Type Required Description
searchQuery String No

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

otpQuery String No

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.

storeIds String No

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

countries String No

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

pageNumber Integer No

The number of the page to fetch.

brandModels String No

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

merchantIds String No

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

pageSize Integer No

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

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.