latestOpenAPI 3.1.0CC-BY-NC-SA-4.0raw.githubusercontent.com2026-08-141243861.8 MB

d2a3bd80c1fa

Accounts API4

Balance Transfers API3

Balances API5

Capabilities API1

Captures API3

Chargebacks API3

Client Links API1

Clients API2

Customers API7

Delayed Routing API3

Invoices API2

Mandates API4

Methods API7

OAuth API2

Onboarding API2

Organizations API3

Payment Links API6

Payments API6

Payouts API4

Permissions API2

Profiles API6

Refunds API5

Sales Invoices API5

Sessions API2

Settlements API8

Subscriptions API7

Terminals API6

Transfers API2

Unmatched Credit Transfers API4

Verify Payee API1

Wallets API1

Webhook Events API1

Webhooks API6

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.

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.

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.