For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get Basic Terminal Info

The "Get Basic Terminal Info" endpoint allows customers to retrieve a terminal's core details using its terminal ID, a lighter-weight alternative to Search Terminals when only the essential identifiers and status are needed, rather than the full configuration.

GET /api/terminal/v1/getbasicterminalinfo

To retrieve a terminal's basic info, provide the terminalId to look up.

Headers

Name
Value

Content-Type*

application/json

Authorization*

bearer {token}

Request-Reference

{unique_reference}

Query Params

Name
Description

terminalId

The ID of the terminal to retrieve basic info for.

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/getbasicterminalinfo?terminalId=TID12345' \
--header 'Authorization: bearer {token}' \
--header 'request-reference: {unique_reference}' \
--header 'Content-Type: application/json' \
--data ''
Response: 200
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "terminalID": "string",
  "serialNumber": "string",
  "settlementAccountNumber": "string",
  "settlementAccountName": "string",
  "overrideParentAccount": true,
  "isActive": true,
  "dateCreated": "2026-05-28T12:03:16.889Z",
  "dateLastModified": "2026-05-28T12:03:16.889Z"
}

Last updated