Sign in
Devices

Search devices

Use this method to return a paginated list of devices associated with a merchant's API key or an ISV's API key.

Use the query parameters to filter the list of results that we return, for example, to search for devices by their model.

Our gateway returns the following information about each device in the list:

  • Unique identifier that we assigned to the device.
  • Serial number of the device.
  • Key serial identifier (KSI) of the device.
  • Device model or type of device.
  • Date that our gateway added the device to our systems.
  • Information about the last transaction that the device processed.
get/devices

Query parameters

beforestring

Return the previous page of results before the value that you specify.

You can’t send the before parameter in the same request as the after parameter.

afterstring

Return the next page of results after the value that you specify.

You can’t send the after parameter in the same request as the before parameter.

limitinteger

Limit the maximum number of results that we return for each page.

activeboolean

Filter by the device status. Send one of the following values:

  • true – Return only active devices.
  • false – Return only inactive devices.
serialNumberstring

Filter by the serial number of the device.

ksistring

Filter by the key serial identifier (KSI) of the device.

modelstring

Filter by the model or type of the device.

Headers

Authorizationstring required

Bearer authentication

Response

Successful request. Returns a list of devices associated with the API key.

limitinteger required

Maximum number of results that we return for each page.

countinteger required

Number of results we returned on this page.

Note: This might not be the total number of results that match your query.

hasMoreboolean required

Indicates whether there is another page of results available.

Changes

No recorded changes to this endpoint across all 1 revision of this API.