Sign in

v1

latestOpenAPI 3.0.12026-07-243686491.1 MB
Payment Terminals

Retrieve a list of payment terminals

Required scope: payment-terminals:read

get/api/v1/payment-terminals

Query parameters

pageinteger

page number to retrieve (starts with 0)

perPageinteger

number of items per page (between 1 and 100, default 10)

serialstring nullable

Allows to filter list of terminals by a serial

Example:XYZ123-DF-123
teamIdinteger nullable

Allows to filter list of terminals by a team id.

Example:19
includeDeletedboolean nullable

If true, deleted entities will be included in the response.

Example:true

Response

List of payment terminals that match the criteria

Example response

{
  "data": [
    {
      "id": "payter_123",
      "serial": "XYZ123-DF-123",
      "name": "MyPaymentTerminal 042",
      "isConnected": true,
      "connectedAt": "2022-05-12T15:56:45.99Z",
      "createdAt": "2022-05-12T15:56:45.99Z",
      "updatedAt": "2022-05-12T15:56:45.99Z",
      "deletedAt": "2022-05-12T15:56:45.99Z"
    }
  ]
}