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.

We keep a pairing code for one month after it is revoked or expires, then delete it. Once deleted, this endpoint returns a 404. Active pairing codes are never deleted.

๐Ÿ”‘

Access with

API keyOAuth access with terminals.read
Path Params
string
required

Provide the ID of the terminal pairing code.

Query Params
string | null
enum

Include additional information in the response.

Show Details
details.qrCodeInclude a QR code object.
Allowed:
Responses

Language
Credentials
LoadingLoadingโ€ฆ
Response
Choose an example:
application/hal+json