v1
latestOpenAPI 3.1.0CC-BY-NC-SA-4.02026-07-2413803.8 MBTerminals API
Request terminal pairing code
ℹ️ Test mode
This endpoint currently does not support test mode yet.
Request a pairing code to onboard a point-of-sale terminal.
The response includes a human-readable code for manual entry on the terminal, and a QR Code as a base64 encoded SVG data URI for scanning if you specify the query parameter include with value details.qrCode.
Pairing codes expire after 90 days (see expiresAt) and can be used multiple times.
🔑 Access with
API key
OAuth access with terminals.write
post/terminals/pairing-codes
Query parameters
include'details.qrCode' nullable
Example:details.qrCode
Include additional information in the response.
Request body
Example request
{
"profileId": "pfl_jA9bC4DkFj3G"
}Response
The requested terminal pairing code object.