Skip to content
Developer portal

Overview

Terminal API v1

Section titled “Terminal API v1”

For terminal vendors building the POS app. A paired terminal calls these on the terminal host, https://terminal.api.example.com, over mutual TLS with its own client certificate; pairing is the one call made before it has one. The guides explain pairing, terminal sessions, renewing a certificate and recovering from errors.

This reference as an OpenAPI 3.1 document: JSON or YAML.

Information

  • OpenAPI version: 3.1.0

Operations

Section titled “Operations”
POST
/v1/terminal_pairings
GET
/v1/terminal/me
POST
/v1/terminal/cash_payments
POST
/v1/terminal/certificate_renewals
POST
/v1/terminal_sessions
POST
/v1/terminal_sessions/{id}/heartbeat
POST
/v1/terminal_sessions/{id}/resume
POST
/v1/terminal_sessions/{id}/close

Authentication

Section titled “Authentication”

TerminalCertificate

Section titled “TerminalCertificate”

The terminal’s own client certificate, from POST /v1/terminal_pairings, whose private key never leaves the terminal, presented over mutual TLS. Used by terminals only, on every call but pairing. It is checked on every call, so a revoked one is refused on the very next.

Security scheme type: mutualTLS