View Terminal Link History

The "View Terminal Link History" endpoint allows customers to retrieve the full history of settlement account link and delink actions performed on a terminal, including which account was involved, what action was taken, when it happened, and who performed it. This is useful for auditing changes to a terminal's settlement account over time.

GET /api/terminal/v1/link-history

To retrieve a terminal's link history, provide the TerminalID to look up, along with PageNumber and PageSize to paginate through the results.

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 link history for.
PageNumber	The page number to retrieve.
PageSize	The number of records to return per page.

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/link-history?TerminalId=TID12345&PageNumber=1&PageSize=10' \
--header 'Authorization: bearer {token}' \
--header 'request-reference: {unique_reference}' \
--header 'Content-Type: application/json' \
--data ''

Response: 200

{
  "data": [
    {
      "accountNumber": "string",
      "terminalId": "string",
      "action": "string",
      "modifiedDate": "2026-05-28T11:55:55.069Z",
      "actionedBy": "string"
    }
  ],
  "recordCount": 0
}