MOmollie
Terminals API

List terminal pairing codes

Changed on

ℹ️ Test mode

This endpoint currently does not support test mode yet.

Returns your pairing codes: active, expired, and revoked. Results are paginated.

We keep a pairing code for one month after it is revoked or expires, then delete it. Deleted codes drop out of this list. Active pairing codes are never deleted.

get/v2/terminals/pairing-codes

Request

  • Base URL
    https://api.mollie.com
  • URL
    https://api.mollie.com/v2/terminals/pairing-codes
  • 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

Query parameters

fromstring nullable

Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the result set.

limitinteger nullable
Example:50

The maximum number of items to return. Defaults to 50 items.

sort'asc' | 'desc'
Example:desc

Used for setting the direction of the result set. Defaults to descending order, meaning the results are ordered from newest to oldest.

profileIdstring
Example:pfl_QkEhN94Ba

The identifier referring to the profile you wish to retrieve pairing codes for.

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

A list of terminal pairing code objects. For a complete reference of the terminal pairing code object, refer to the Get terminal pairing code endpoint documentation.

countinteger

The number of items in this result set. If more items are available, a _links.next URL will be present in the result as well.

The maximum number of items per result set is controlled by the limit property provided in the request. The default limit is 50 items.

Example response

{
  "count": 5,
  "_links": {
    "self": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "previous": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "next": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "documentation": {
      "href": "https://...",
      "type": "application/hal+json"
    }
  }
}

Changes