Search Terminals

The "Search Terminals" endpoint allows customers to search for terminal records using any combination of filters, serial number, parent terminal, terminal ID, date range, or active status. This is useful for locating a specific terminal or terminal group without needing to know its exact ID, and for reviewing a terminal's full configuration, including its settlement account and fee setup.

GET /api/terminal/v1/Search

Pass only the field(s) you intend to search by, every query parameter is optional.

To search for terminals, you can pass any of the supported query parameters, SerialNumber, TerminalParentID, TerminalID, PageNumber, PageSize, StartDate, EndDate, IsActive , as needed. A successful request returns a list of matching terminal records under data, each with its full configuration, settlement account details, fee setup, and override flags, alongside a recordCount showing the total number of matching records.

Headers

Name	Value
Content-Type*	application/json
Authorization*	bearer {token}
Request-Reference	{unique_reference}

Query Params

Name	Description
SerialNumber	The terminal's serial number to search by. Optional.
TerminalParentID	The ID of the parent terminal to filter by. Optional.
TerminalID	The ID of the terminal to search by. Optional.
PageNumber	The page number to retrieve. Optional.
PageSize	The number of records to return per page. Optional.
StartDate	The start of the date range to filter by. Optional.
EndDate	The end of the date range to filter by. Optional.
IsActive	Filter by whether the terminal is active. Optional.

Here is an example request and response with a sample payload sent to the endpoint in Curl format.

Sample Request

curl --location -g '{{baseurl}}/api/terminal/v1/Search?SerialNumber=1234567890&TerminalParentID=24AC5C74-F25D-464E-879F-8F2643D5481A&TerminalID=TID12345&PageNumber=1&PageSize=10&StartDate=%3CdateTime%3E&EndDate=%3CdateTime%3E&IsActive=%3Cboolean%3E' \
--header 'Authorization: bearer {token}' \
--header 'request-reference: {unique_reference}' \
--header 'Content-Type: application/json' \
--data ''

Response: 200

{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "terminalID": "string",
      "serialNumber": "string",
      "terminalParentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "apiClientId": "string",
      "bankCode": "string",
      "settlementAccountNumber": "string",
      "settlementAccountName": "string",
      "overrideParentAccount": true,
      "isActive": true,
      "overrideParentFee": true,
      "useFlatFee": true,
      "flatFee": 0,
      "percFee": 0,
      "percFeeCap": 0,
      "feeIncomeGL": "string",
      "vatGL": "string",
      "dateCreated": "2026-05-28T12:03:16.889Z",
      "dateLastModified": "2026-05-28T12:03:16.889Z"
    }
  ],
  "recordCount": 0
}