Get a list of terminals

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:

  • Management API — Terminal actions read

Endpoint destination URL
Click to copy

Query parameters

pageSize integer

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

pageNumber integer

The number of the page to fetch.

brandModels string

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

storeIds string

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

merchantIds string

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

countries string

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

otpQuery string

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.

searchQuery string

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

Response parameters

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.

    Show more Show less
  • 400 - Bad Request

    A problem reading or understanding the request.

    Show more Show less
  • 401 - Unauthorized

    Authentication required.

    Show more Show less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show more Show less
  • 422 - Unprocessable Entity

    A request validation error.

    Show more Show less
  • 500 - Internal Server Error

    The server could not process the request.

    Show more Show less
  • Response
  • Click to copy