Terminals

Retrieves the latest telemetry data for a specific terminal.

GET /v1/merchant/admin/terminal/telemetry/{merchantReference}/{terminalReference}

Sample

GET /v1/merchant/terminal/telemetry/e5d751c6-aa78-4d92-a1f1-fcdf776a57d7/69e43127-a0f2-4c10-9e2d-46a5bfb330c5

Auth: API key (VantagePayAdminClient).

Parameters

Name	In	Required	Description
merchantReference	path	Yes	A globally unique internal merchant reference (UUID).
terminalReference	path	Yes	A globally unique internal terminal reference (UUID) or an external terminal reference.

Responses

Status	Description
200	The telemetry data was returned successfully.
400	The request failed validation, the error object will contain further information.
401	The authorization information provided is not valid, authentication is required to access this resource.
403	The authorization header does not contain the correct type or you do not have access to this resource.
404	The merchant, terminal, or telemetry data was not found.
422	The request payload is invalid, the error object will contain further information.
429	Too many requests are being sent concurrently or rate limiting has taken effect.
500	An unexpected error occurred, the error object will contain further information.

Response body

Field	Type	Required	Description
success	boolean	No	Gets a value indicating whether the operation was successful.
result	object	No	A terminal telemetry record that includes server-set fields. Inherits from ZGA.Core.Models.Merchants.TerminalTelemetry.

{
  "success": true,
  "result": {
    "terminalReference": "00000000-0000-0000-0000-000000000000",
    "reportedDate": "string",
    "pushNotificationToken": "string",
    "auditEvents": [],
    "latitude": 0,
    "longitude": 0,
    "batteryLevelPercentage": 0,
    "isBatteryCharging": true,
    "isWifiConnected": true,
    "isCellularConnected": true,
    "wifiUsageInBytes": 0,
    "cellularUsageInBytes": 0,
    "operatingSystemVersion": "string",
    "softwareVersion": "string"
  }
}

Code samples

WARNING

The JavaScript SDK does not cover admin APIs - use the .NET SDK.

.NET

var telemetry = await adminClient.Merchants.GetLatestTerminalTelemetryAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"), Guid.Parse("8a7b6c5d-4e3f-4210-9c8b-7a6f5e4d3c2b"));

---

Retrieves the latest telemetry data for all terminals of a merchant.

GET /v1/merchant/admin/terminal/telemetry/{merchantReference}

Sample

GET /v1/merchant/terminal/telemetry/e5d751c6-aa78-4d92-a1f1-fcdf776a57d7?terminalReferences=69e43127-a0f2-4c10-9e2d-46a5bfb330c5&terminalReferences=8ab45123-ef01-4a2b-9c3d-56e78901f234

Auth: API key (VantagePayAdminClient).

Parameters

Name	In	Required	Description
merchantReference	path	Yes	A globally unique internal merchant reference (UUID).
terminalReferences	query	No	Optional filter - specific terminal references to include.

Responses

Status	Description
200	The telemetry data was returned successfully.
400	The request failed validation, the error object will contain further information.
401	The authorization information provided is not valid, authentication is required to access this resource.
403	The authorization header does not contain the correct type or you do not have access to this resource.
404	The merchant was not found.
422	The request payload is invalid, the error object will contain further information.
429	Too many requests are being sent concurrently or rate limiting has taken effect.
500	An unexpected error occurred, the error object will contain further information.

Response body

Field	Type	Required	Description
success	boolean	No	Gets a value indicating whether the operation was successful.
result	array<object>?	No	Gets the response payload.

{
  "success": true,
  "result": [
    {}
  ]
}

Code samples

WARNING

The JavaScript SDK does not cover admin APIs - use the .NET SDK.

.NET

var telemetry = await adminClient.Merchants.GetLatestTerminalTelemetryAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"));