Skip to content

Terminals are the physical card readers a merchant uses to accept in-person payments.

Each terminal record includes its serial number, manufacturer, model, and delivery status. A terminal also reports a connection status and the last time it was seen online.

The Terminals endpoints support listing a merchant's terminals and checking a terminal's live status. The list endpoint can be filtered by search string, delivery status, serial number, manufacturer, or model. The status endpoint returns near real-time details, including battery level, printer status, and signal strength. Limited data may be returned if the terminal's internet connectivity is currently poor.

  • GET /pos-api/v1/terminals. Lists a merchant's terminals, filtered by search string, delivery status, serial number, manufacturer, or model.
  • GET /pos-api/v1/terminals/{terminalId}/status. Retrieves a terminal's current connection, battery, and printer status in near real-time.