MOmollie
Terminals API

Get terminal

Changed on

Retrieve a single terminal by its ID.

get/v2/terminals/{terminalId}

Request

  • Base URL
    https://api.mollie.com
  • Auth
    • HTTP bearer
    • or 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

testmodeboolean

Most API credentials are specifically created for either live mode or test mode. In those cases the testmode query parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the testmode query parameter to true.

Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.

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 terminal object.

resourcestring required

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

idstring required
mode'live' | 'test' required

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

descriptionstring required

A short description of the terminal. The description can be used as an identifier for the terminal. Currently, the description is set when the terminal is initially configured. It will be visible in the Mollie Dashboard, and it may be visible on the device itself depending on the device.

status'pending' | 'active' | 'inactive' required

The status of the terminal.

brand'PAX' | 'Tap' | 'null' nullable required

The brand of the terminal.

model'A35' | 'A77' | 'A920' | 'A920Pro' | 'IM30' | 'Tap' | 'null' nullable required

The model of the terminal. For example for a PAX A920, this field's value will be A920.

serialNumberstring nullable required

The serial number of the terminal. The serial number is provided at terminal creation time.

currencystring required

The currency configured on the terminal, in ISO 4217 format. Currently most of our terminals are bound to a specific currency, chosen during setup.

profileIdstring required

The identifier referring to the profile this entity belongs to.

Most API credentials are linked to a single profile. In these cases the profileId can be omitted in the creation request. For organization-level credentials such as OAuth access tokens however, the profileId parameter is required.

createdAtstring required

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

updatedAtstring required

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

Example response

{
  "resource": "terminal",
  "id": "term_vytxeTZskVKR7C7WgdSP3d",
  "mode": "live",
  "description": "Main Terminal",
  "status": "active",
  "brand": "PAX",
  "model": "A920",
  "serialNumber": "1234567890",
  "currency": "EUR",
  "profileId": "pfl_5B8cwPMGnU",
  "createdAt": "2024-03-20T09:13:37+00:00",
  "updatedAt": "2025-03-20T09:13:37+00:00",
  "_links": {
    "self": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "documentation": {
      "href": "https://...",
      "type": "application/hal+json"
    }
  }
}

Changes

  • 3be7b2877091Revision changes
    • warning

      added the new undefined enum value to the response property for the response status

    • warning

      added the new undefined enum value to the response property for the response status

  • 7cab62b21830Revision changes
    • info

      added the non-success response with the status