Terminals 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.
get/v2/terminals/pairing-codes/{pairingCodeId}
Path parameters
pairingCodeIdstring required
Example:termpc_R7gX5Ea9bC4DkFj3G
Provide the ID of the terminal pairing code.
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.
Response
The requested terminal pairing code object.