Sign in

v1

latestOpenAPI 3.1.02026-07-242325051.4 MB
Terminal

Terminals:List

Get a list (without pagination) of all terminals. If you do not supply a merchantCode we return the terminals that are available under your own merchant registration. If you supply a merchantCode you need to have access to that merchant.

get/v2/terminals/list

Query parameters

eqstring

Get results that equal the given value

Provides filtering based on merchant code.

{
  "eq": "M-1234-4321"
}
eqstring

Get results that equal the given value

neqstring

Get results that are not equal to the given value

Provides filtering based on status.

{
  "eq": "ACTIVE",
  " neq": "ACTIVE"
}
eqstring

Get results that equal the given value

neqstring

Get results that are not equal to the given value

Provides filtering based on connection status.

{
  "eq": "ONLINE",
  " neq": "OFFLINE"
}

Response

OK

totalinteger nullable

The total items the collection contains

Example response

{
  "terminals": [
    {
      "code": "TH-1234-4321",
      "name": "Terminal Shop.",
      "terminalTypeCode": "TY-1234-4321"
    }
  ],
  "total": 10
}