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

Query Params
string | null
enum

Include additional information in the response.

Show Details
details.qrCodeInclude a QR code object.
Allowed:
Body Params
string
required

The ID of the profile to pair the terminal with.

Responses

Language
Credentials
LoadingLoading…
Response
Choose an example:
application/hal+json