List Terminals

Retrieve a list of all terminals associated with the integration, with filtering and pagination options.

Search Parameters

All parameters are optional and can be combined to refine the search:

Parameter	Type	Description	Example
terminalId	string	Filter by terminal ID	123456789
name	string	Filter by terminal name	loja-centro, armazem-norte
page	integer	Page number (pagination)	1, 2, 3
limit	string	Number of results per page	10, 25, 50 (max: 500)
sort	string	Sort results	createdAt, -created_at, terminalId

Examples

List all terminals

Request

GET /terminals

Response

{
 "date": "2021-12-07T18:01:19+00:00",
 "success": true,
 "data": [
  {
    "uuid": "3df21709-b2f5-4ec6-93f9-c5855e0da879",
    "terminalId": "806030356",
    "name": "name",
    "model": "model",
    "processor": "processor",
    "supplier": "supplier",
    "features": {
      "allowRemoteTransactions": true,
      "allowGenerateQrCode": false,
      "allowRealTimeTransactionSinchronization": true
    },
    "createdAt": "2025-08-21T09:46:39+01:00",
    "updatedAt": "2025-08-22T16:16:56+01:00"
  },
  {
    "uuid": "1467a1e6-e6b5-425f-9810-21d428091068",
    "terminalId": "713149748",
    "name": "name",
    "model": "model",
    "processor": "processor",
    "supplier": "supplier",
    "features": {
      "allowRemoteTransactions": false,
      "allowGenerateQrCode": false,
      "allowRealTimeTransactionSinchronization": false
    },
    "createdAt": "2025-08-20T17:17:02+01:00",
    "updatedAt": "2025-08-29T11:06:52+01:00"
  },
 ],
 "meta": {
   "totalPages": 3,
   "totalCount": 6,
   "currentPage": 1
 },
 "links": {
   "first": "https://paypay.pt/api/terminals?sort=-createdAt%2CterminalId&limit=2&page=1",
   "last": "https://paypay.pt/api/terminals?sort=-createdAt%2CterminalId&limit=2&page=3",
   "next": "https://paypay.pt/api/terminals?sort=-createdAt%2CterminalId&limit=2&page=2"
 }
}

Multiple combined filters

Request

GET /terminals?terminalId=806030356&sort=-createdAt

Response

{
 "date": "2021-12-07T18:01:19+00:00",
 "success": true,
 "data": [
  {
    "uuid": "3df21709-b2f5-4ec6-93f9-c5855e0da879",
    "terminalId": "806030356",
    "name": "name",
    "model": "model",
    "processor": "processor",
    "supplier": "supplier",
    "features": {
      "allowRemoteTransactions": true,
      "allowGenerateQrCode": false,
      "allowRealTimeTransactionSinchronization": true
    },
    "createdAt": "2025-08-21T09:46:39+01:00",
    "updatedAt": "2025-08-22T16:16:56+01:00"
  }
 ],
 "meta": {
   "totalPages": 1,
   "totalCount": 1,
   "currentPage": 1
 },
 "links": {
   "first": "https://paypay.pt/api/terminals?sort=-createdAt%2CterminalId&limit=2&page=1",
   "last": "https://paypay.pt/api/terminals?sort=-createdAt%2CterminalId&limit=2&page=1"
 }
}

Response Structure

Field	Type	Description
uuid	string	Unique identifier of the terminal
terminalId	string	Terminal ID
name	string	Terminal name
model	string	Terminal model
processor	string	Transaction processor name
supplier	datetime	Terminal supplier name
features.allowRemoteTransactions	boolean	Indicates if the terminal accepts remote transactions (cloud terminals only)
features.allowGenerateQrCode	boolean	Indicates if the terminal can generate QR codes
features.allowRealTimeTransactionSinchronization	boolean	Indicates if the terminal synchronises transactions in real time with the PayPay backoffice
createdAt	datetime	Record creation date
updatedAt	datetime	Date of last update

important

Terminals with the allowRemoteTransactions feature enabled are Cloud-type terminals.

Next Steps

Now that you know how to list terminals, explore:

• Terminal Information - Full information about a specific terminal.
• Send Payment Request - Send a payment request to the cloud terminal.