List terminals

Terminals API v2BETA
GEThttps://api.mollie.com/v2/terminals
Authentication:API keysOrganization access tokensApp access tokens

With this endpoint you can retrieve a list of terminals symbolizing the physical devices that you have received from us. In the list you can find all the terminals linked to your organization or profile, ordered from newest to oldest.

For more information on accepting point-of-sale payments, please refer to the point-of-sale guide.

The results are paginated. See pagination for more information.

Parameters

fromstringoptional
Used for pagination. Offset the result set to the payment with this ID. The terminal with this ID is included in the result set as well.
limitintegeroptional
The number of terminals to return (with a maximum of 250).

Access token parameters

If you are using organization access tokens or are creating an OAuth app, the following query string parameters are also available. With the profileId parameter, you can specify which profile you want to look at when listing terminals. If you omit the profileId parameter, you will get all terminals on the organization. Organizations can have multiple profiles for each of their websites. See Profiles API for more information.

profileIdstringoptional
testmodebooleanoptional

Response

200 application/hal+json

countinteger
The number of terminals found in _embedded, which is either the requested number (with a maximum of 250) or the default number.
_embeddedobject

The object containing the queried data.

Hide child parameters

terminalsarray
An array of terminal objects as described in Get terminal.
_linksobject

Links to help navigate through the lists of terminals. Every URL object will contain an href and a type field.

Show child parameters

selfURL object
The URL to the current set of terminals.
previousURL object
The previous set of terminals, if available.
nextURL object
The next set of terminals, if available.
documentationURL object
The URL to the terminals list endpoint documentation.

Example

cURLPHPPythonRubyNode.js
1
2
curl -X GET https://api.mollie.com/v2/terminals?limit=5 \
   -H "Authorization: Bearer test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM"

1
2
3
4
5
6
7
8
9
<?php
$mollie = new \Mollie\Api\MollieApiClient();
$mollie->setApiKey("test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM");

// get the first page
$terminals = $mollie->terminals->page();

// get the next page
$next_terminals = $terminals->next();

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from mollie.api.client import Client

mollie_client = Client()
mollie_client.set_api_key('test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM')

# get the first page
terminals = mollie_client.terminals.list()

# get the next page
next_terminals = terminals.get_next()

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
require 'mollie-api-ruby'

Mollie::Client.configure do |config|
  config.api_key = 'test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM'
end

terminals = Mollie::Terminal.all

# get the next page
next_terminals = terminals.next

1
2
3
4
5
6
const { createMollieClient } = require('@mollie/api-client');
const mollieClient = createMollieClient({ apiKey: 'test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM' });

(async () => {
  const payments = await mollieClient.terminals.list();
})();

Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
HTTP/1.1 200 OK
Content-Type: application/hal+json

{
    "count": 5,
    "_embedded": {
        "terminals": [
            {
                "id": "term_7MgL4wea46qkRcoTZjWEH",
                "profileId": "pfl_QkEhN94Ba",
                "status": "active",
                "brand": "PAX",
                "model": "A920",
                "serialNumber": "1234567890",
                "currency": "EUR",
                "description": "Terminal #12345",
                "createdAt": "2022-02-12T11:58:35.0Z",
                "updatedAt": "2022-11-15T13:32:11.0Z",
                "_links": {
                    "self": {
                        "href": "https://api.mollie.com/v2/terminals/term_7MgL4wea46qkRcoTZjWEH",
                        "type": "application/hal+json"
                    }
                }
            },
            { },
            { },
            { },
            { }
        ]
    },
    "_links": {
        "self": {
            "href": "https://api.mollie.com/v2/terminals?limit=5",
            "type": "application/hal+json"
        },
        "previous": null,
        "next": {
            "href": "https://api.mollie.com/v2/terminals?from=term_7MgL4wea46qkRcoTZjWEH&limit=5",
            "type": "application/hal+json"
        },
        "documentation": {
            "href": "https://docs.mollie.com/reference/v2/terminals-api/list-terminals",
            "type": "text/html"
        }
    }
}