Our Terminals API currently provides the ability to retrieve terminal data and to attach and detach a terminal from another device, however there are plans for this to be expanded to enable comprehensive control over Terminals via API.
Features
The following features are available today:
- Retrieve data about an individual terminal
- List terminals
- Update the Terminal record where the terminal has been attached or detached to/from another device - This endpoint needs to be specifically enabled for each customer. Please contact us to discuss this further
The following additional features are coming soon:
- Order a new terminal
- Update terminal configuration and features - e.g. enable the ability to give cashback
- Retrieve terminal diagnostic data
- Closing an existing terminal
- Swap an old terminal for a new one
- and more!
If you are interested in any of the above register your interest here.
Where to get started?
If this is your first time here, we recommend you do things in the following order:
- Follow our common getting started guide
- Follow the terminals quick start guide
- Dive into the API reference, such as for List Terminals
