Terminal Onboarding
Last updated: 2023-06-30
Overview
Before your application can send payment requests to a terminal, the terminal must be linked to your merchant account. The Terminal Onboarding section covers the two operations required to manage terminal associations:
- Link Terminal — Associate a physical terminal with your merchant account.
- Unlink Terminal — Remove the association between a terminal and your merchant account.
Prerequisites
- You must know the serial number of the terminal you want to link.
- The terminal must be powered on and connected to the network.
- Your account must have permission to manage terminals.
Terminal Lifecycle
[Terminal Delivered] → [Link Terminal] → [Ready for Transactions] → [Unlink Terminal] → [Decommissioned]
- When a terminal is delivered or replaced, call Link Terminal to register it.
- The terminal is now ready to receive payment requests.
- When a terminal is decommissioned or replaced, call Unlink Terminal to remove it.
Notes
- A terminal can only be linked to one merchant account at a time.
- Unlinking a terminal does not erase its transaction history — historical data remains accessible via the reporting endpoints.
- If you replace a terminal with a new device, unlink the old one first before linking the new one.