v1
latestOpenAPI 3.1.0CC-BY-NC-SA-4.02026-07-2413803.8 MBTerminals API
Get terminal pairing code
ℹ️ Test mode
This endpoint currently does not support test mode yet.
Get a pairing code to onboard a point-of-sale terminal.
The response includes a human-readable code for manual entry on the terminal and, optionally, a QR Code as a base64 encoded SVG data URI when you use the include query parameter with value details.qrCode.
🔑 Access with
API key
OAuth access with terminals.read
get/terminals/pairing-codes/{pairingCodeId}
Path parameters
pairingCodeIdstring required
Example:termpc_R7gX5Ea9bC4DkFj3G
Provide the ID of the terminal pairing code.
Query parameters
include'details.qrCode' nullable
Example:details.qrCode
Include additional information in the response.
Response
The requested terminal pairing code object.