Skip to content
/
Lists merchant's terminal...

Lists merchant's terminals

Request

GET {{baseURL}}/v2/terminals

This endpoint lists all available terminals for the authenticated merchant.

Only active terminals are returned. Terminals in the following conditions are excluded:

  • Pre-activation states, such as pending shipment or in transit
  • Deactivated terminals

See Also:
To retrieve a terminal's status by ID, see GET /v2/terminals/{terminalId}/status.

Security
Bearer
Query
pageIndexinteger, (int32), >= 0

Specifies the page number of the returned search results.

A page is considered each set of the pageSize values.

The page count is zero-based. The maximum for pageIndex, or the page number, is the pageSize divided by the total count rounded down. For example, the pageSize is 50 and the total is 130. That means there are three pages, but the pageIndex value is in the inclusive range from zero to two.

Value restrictions include:

  • A value less than zero is not permitted.
  • Values equal to or greater than totalPages end successfully but will not return any items.

For page size information, see pageSize.

Example: 0

Default:0
pageSizeinteger, (int32), [ 1 .. 100 ]

Specifies the number of items for each page of the returned search results.

A page is considered each set of the pageSize values.

The page count is zero-based. The maximum for pageIndex, or the page number, is the pageSize divided by the total count rounded down. For example, the pageSize is 50 and the total is 130. That means there are three pages, but the pageIndex value is in the inclusive range from zero to two.

For page numbering information, see pageIndex.

Example: 50

Default:20
sortBystring

Specifies a field name to sort the results by.

If null or omitted, results come back newest first.

Valid values are:
terminalManufacturer
merchantCompanyName

Example:sortBy=terminalManufacturer
sortOrderstring

Specifies the sort order.

The sort order is specified by the sortOrder value.
The field that gets sorted by is specified by the sortBy value.

Valid values are:

ValueDescription
ascSort results from the lowest value to the highest value.
descSort results from the highest value to the lowest value.
Default:"asc"
Example:sortOrder=desc
terminalStatusstring

Indicates the availability status of the terminal.

Valid values are:

StatusMeaning
BusyThe terminal is processing a transaction.
ReadyThe terminal is available for a new transaction.
OfflineThe terminal is unavailable for a new transaction.
Enum:"Ready""Busy""Offline"
Example:terminalStatus=Ready
terminalModestring

Indicates the operating mode of the terminal.

Valid values are:

ModeMeaning
StandaloneThe terminal operates independently of any POS system.

The amount is entered directly on the terminal itself (no electronic connection to a cash register/POS software), and it runs the transaction on its own.
SemiIntegratedThe terminal is connected to a POS system, typically through a network or cable.

The POS sends the transaction amount to the terminal electronically, rather than requiring manual entry. However, the POS never touches card or payment data directly. The terminal handles all sensitive payment processing itself. This architecture is commonly used to reduce PCI compliance scope on the POS side.
Enum:"Standalone""SemiIntegrated"
Example:terminalMode=SemiIntegrated
connectionStatusstring

Indicates the line status of the terminal.

Valid values are:

StatusMeaning
OnlineThe terminal is currently connected and reachable.

It has active network or internet connectivity. It is able to process transactions and communicate with the backend in real time.
OfflineThe terminal is disconnected or unreachable.

It may be powered off, have lost its network connection, or otherwise be unable to communicate. As a result, it cannot process transactions, or can only do so in a stored or deferred mode depending on the platform.
Enum:"Online""Offline"
Example:connectionStatus=Online
serialNumberstring

Filters by the serial number.

This is an exact match search.

Example:serialNumber=SN100001
searchstring

Filters using a search string.

This performs a case-insensitive search that matches exactly or partially.

The field does not have to be specified. If the results are to be sorted, use the sortBy field to specify the sort field.

The search includes the following fields:
serialNumber
terminalModel
terminalManufacturer
terminalId
merchantCompanyName

Example:
Peppared Street Cafe
Street
ree

Example:search=Peppared Street Cafe
curl -i -X GET \
  'https://sandbox.api.flute.com/v2/terminals?pageIndex=0&pageSize=20&sortBy=terminalManufacturer&sortOrder=desc&terminalStatus=Ready&terminalMode=SemiIntegrated&connectionStatus=Online&serialNumber=SN100001&search=Peppared%20Street%20Cafe' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
itemsArray of objects or null
pageInfoobject

Indicates an object describing the pagination status.

If additional pages to review are needed, repeat the exact same search but include a new pageIndex value. Typically, this will increment the current pageIndex by one. However, any valid value may be used. Value restrictions include:

  • A value less than zero is not permitted.
  • Values equal to or greater than totalPages end successfully but will not return any items.
Response
{
  "items": [
    {
      "terminalId": "0b61c6b6-e633-4c3d-91ae-9810ff42ccdc",
      "merchantId": "fffcecc3-2e15-4e93-8144-5353785cec3b",
      "merchantCompanyName": "Peppared Street Cafe",
      "serialNumber": "SN100001",
      "terminalManufacturer": "Sunmi",
      "terminalModel": "SunmiP2",
      "terminalMode": "SemiIntegrated",
      "terminalStatus": "Ready",
      "connectionStatus": "Online",
      "lastSeenOn": "2026-08-11T18:44:45.638Z"
    }
  ],
  "pageInfo": {
    "pageIndex": 0,
    "pageSize": 20,
    "totalItems": 3,
    "totalPages": 1,
    "hasMore": false
  }
}