Sign in
Terminals 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.

post/v2/terminals/pairing-codes

Query parameters

includestring nullable

This endpoint allows you to include additional information via the include query string parameter.

Headers

idempotency-keystring
Example:123e4567-e89b-12d3-a456-426

A unique key to ensure idempotent requests. This key should be a UUID v4 string.

Request body

profileIdstring required

The ID of the profile to pair the terminal with.

Example request

{
  "profileId": "pfl_jA9bC4DkFj3G"
}

Response

The requested terminal pairing code object.

Changes

Changed in 2 of the 78 revisions of this API.2

Of the 78 revisions, 9 have no diff computed.