MOmollie
Terminals API

Get terminal pairing code

Changed on

ℹ️ 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}

Request

  • Base URL
    https://api.mollie.com
  • URL
    https://api.mollie.com/v2/terminals/pairing-codes/{pairingCodeId}
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://my.mollie.com/oauth2/authorize
      Token URL: https://api.mollie.com/oauth2/tokens scopes: terminals.read

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.

resourcestring required

Indicates the response contains a terminal pairing code object. Will always contain the string terminal-pairing-code for this endpoint.

idstring required
mode'live' | 'test' required

Whether this entity was created in live mode or in test mode.

codestring required

The human-readable pairing code to be entered on the terminal. This code is multi-use and will expire after the time indicated in expiresAt.

profileIdstring required

The ID of the profile the terminal is being paired with.

status'active' | 'expired' | 'revoked' required

The status of the pairing code.

expiresAtstring required

The date and time the pairing code expires, in ISO 8601 format. Pairing codes expire 90 days after creation. After this time, the code can no longer be used to pair a terminal.

revokedAtstring nullable

The date and time the pairing code was revoked, in ISO 8601 format. null if the code has not been revoked.

createdAtstring required

The entity's date and time of creation, in ISO 8601 format.

Example response

{
  "resource": "terminal-pairing-code",
  "id": "termpc_R7gX5Ea9bC4DkFj3G",
  "mode": "live",
  "code": "20eb5ca1f78b48ae9e2b",
  "profileId": "pfl_jA9bC4DkFj3G",
  "status": "active",
  "details": {
    "qrCode": {
      "height": 256,
      "width": 256,
      "src": "data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4w..."
    }
  },
  "expiresAt": "2025-12-10T10:15:00+00:00",
  "revokedAt": "2025-12-10T10:03:23+00:00",
  "createdAt": "2024-03-20T09:13:37+00:00",
  "_links": {
    "self": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "profile": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "documentation": {
      "href": "https://...",
      "type": "application/hal+json"
    }
  }
}

Changes