Get terminal¶
GET
https://api.mollie.com/v2/terminals/*id*
With this endpoint you can retrieve a single terminal object by its terminal ID. This terminal object symbolizes the physical device that you have received from us. This endpoint is not publicly available yet — please reach out to your account manager to sign up for early access.
For more information on accepting point-of-sale payments, please refer to the point-of-sale guide.
Parameters¶
Replace id
in the endpoint URL by the Terminal’s ID, for example term_7MgL4wea46qkRcoTZjWEH
.
Response¶
200
application/hal+json
resource
stringterminal
for this endpoint.id
stringterm_7MgL4wea46qkRcoTZjWEH
. This ID will be used by Mollie to refer to a certain terminal and will be
used for assigning a payment to a specific terminal.profileId
stringpfl_QkEhN94Ba
.status
stringThe status of the terminal, which is a read-only value determined by Mollie, according to the actions performed for
that terminal. Its values can be pending
, active
, inactive
.
pending
means the device has been linked to your account, but has not yet been activated. This is the first state
that the terminal gets, as soon as it’s ordered from us and assigned to your account.
active
means that the terminal is fully configured and ready to accept payments. As soon as we configure the terminal
for you, it will be moved to this state.
inactive
means that the terminal has been deactivated, which can mean that you returned the device to us,
or you requested to move it to another profile or organization.
brand
stringmodel
stringserialNumber
stringcurrency
stringoptionaldescription
stringcreatedAt
datetimeupdatedAt
datetime_links
objectAn object with several URL objects relevant to the terminal. Every URL object will contain an href
and a type
field.
self
URL objectdocumentation
URL objectExample¶
1 2 | curl -X GET https://api.mollie.com/v2/terminals/term_7MgL4wea46qkRcoTZjWEH \ -H "Authorization: Bearer test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM" |
1 2 3 4 | <?php $mollie = new \Mollie\Api\MollieApiClient(); $mollie->setApiKey("test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM"); $terminal = $mollie->terminals->get("term_7MgL4wea46qkRcoTZjWEH"); |
1 2 3 4 5 | from mollie.api.client import Client mollie_client = Client() mollie_client.set_api_key('test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM') terminal = mollie_client.terminals.get('term_7MgL4wea46qkRcoTZjWEH') |
1 2 3 4 5 6 7 | require 'mollie-api-ruby' Mollie::Client.configure do |config| config.api_key = 'test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM' end terminal = Mollie::Terminal.get('term_7MgL4wea46qkRcoTZjWEH') |
1 2 3 4 5 6 | const { createMollieClient } = require('@mollie/api-client'); const mollieClient = createMollieClient({ apiKey: 'test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM' }); (async () => { const terminal = await mollieClient.terminals.get('term_7MgL4wea46qkRcoTZjWEH'); })(); |
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 | HTTP/1.1 200 OK Content-Type: application/hal+json { "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" }, "documentation": { "href": "https://docs.mollie.com/reference/v2/terminals-api/get-terminal", "type": "text/html" } } } |