Identifiers
In this page we define the main identifiers of the API documentation and specification.
Transaction
Id
The server’s identifier for the transaction. Generated by the server. Always guaranteed to be universally unique, and can be used to uniquely identify the transaction during troubleshooting.
| Example | txn-12345678-01JPHYGPRMH9QRFS3M69SJW9SH |
| Constraints |
|
External ID
The client’s identifier for the transaction. Generated by the client. Has to be unique for each terminal, since the server uses it together with terminal ID to uniquely identify the transaction.
| Example | 123 |
| Constraints |
|
Terminal ID
A unique identifier assigned to each terminal, which is used in API requests that are scoped to a specific terminal. Together with external ID it identifies the transaction.
| Example | t-1912345678 (simulator) or t-0012345678 (Nets SmartPOS) |
| Constraints |
|
Nets SmartPOS terminal
A terminal ID for a Nets SmartPOS terminal looks like t-0012345678. The terminal ID might be formatted differently in different places (terminal settings, Poynt settings or Online Tools portal). If you have an 8-digit terminal ID, then just prefixing it with t-00 will allow you to use it with this API.
Simulated terminal
A terminal ID for a simulated terminal looks like t-19NNNNNNNN. Creating a simulated terminal on the Getting started page will give you a properly formatted terminal ID.
Cohort ID
The cohort ID is a unique identifier assigned to an administrative group of payment terminals. It is used in API requests to get events from all the terminals belonging to the cohort.
| Example | cohort-npay-dev (our simulators) or cohort-weylandyutani-trantor (fictional grouping by a customer plus location combination) |
| Constraints |
|