Search devices | Payroc | Documentation

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.

Use this method to return a [paginated](https://docs.payroc.com/api/pagination) 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.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

beforestringOptional

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.

afterstringOptional

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.

limitintegerOptional<=100Defaults to 10

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

activebooleanOptional

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

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

Filter by the device status. Send one of the following values: - `true` – Return only active devices. - `false` – Return only inactive devices.

serialNumberstringOptional1-64 characters

Filter by the serial number of the device.

ksistringOptional1-16 characters

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

modelstringOptional1-30 characters

Filter by the model or type of the device.

Response

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

limitinteger

Maximum number of results that we return for each page.

countinteger

Number of results we returned on this page.

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

hasMoreboolean

Indicates whether there is another page of results available.

datalist of objects

Array of device objects. Each object contains information about a device.

linkslist of objects

Reference links to navigate to the previous page of results or to the next page of results.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

406

Not Acceptable Error

500

Internal Server Error

1	using Payroc;
2	using System.Threading.Tasks;
3	using Payroc.Boarding.Devices;
4
5	namespace Usage;
6
7	public class Example
8	{
9	public async Task Do() {
10	var client = new PayrocClient();
11
12	await client.Boarding.Devices.SearchDevicesAsync(
13	new SearchDevicesDevicesRequest {
14	Before = "2571",
15	After = "8516",
16	Limit = 25,
17	SerialNumber = "SN123456789",
18	Ksi = "KSI0987654321",
19	Model = "idtechKioskV"
20	}
21	);
22	}
23
24	}

1	{
2	"limit": 2,
3	"count": 2,
4	"hasMore": true,
5	"data": [
6	{
7	"deviceId": "29005019",
8	"tender": "creditDebit",
9	"serialNumber": "1850010868",
10	"ksi": "KSI0987654321",
11	"createdDate": "2024-01-15T10:20:30Z",
12	"deviceType": {
13	"model": "idtechKioskV",
14	"manufacturer": "idtech"
15	},
16	"lastTransaction": {
17	"orderId": "OrderRef6543",
18	"dateTime": "2024-06-15T14:25:00Z",
19	"processingTerminalId": "1234001"
20	},
21	"links": [
22	{
23	"rel": "self",
24	"method": "get",
25	"href": "https://api.payroc.com/v1/devices/29005019"
26	}
27	]
28	},
29	{
30	"deviceId": "29005020",
31	"tender": "ebt",
32	"serialNumber": "WPC202833004712",
33	"ksi": "KSI1234567890",
34	"createdDate": "2023-02-20T11:30:40Z",
35	"deactivatedDate": "2024-05-10T09:15:00Z",
36	"deviceType": {
37	"model": "paxA80",
38	"manufacturer": "pax"
39	},
40	"lastTransaction": {
41	"orderId": "OrderRef7654",
42	"dateTime": "2024-05-09T16:45:00Z",
43	"processingTerminalId": "1234001"
44	},
45	"links": [
46	{
47	"rel": "self",
48	"method": "get",
49	"href": "https://api.payroc.com/v1/devices/29005020"
50	}
51	]
52	}
53	],
54	"links": [
55	{
56	"rel": "next",
57	"method": "get",
58	"href": "https://api.payroc.com/v1/devices?limit=2&after=29005020"
59	},
60	{
61	"rel": "previous",
62	"method": "get",
63	"href": "https://api.payroc.com/v1/devices?limit=2&before=29005019"
64	}
65	]
66	}