Files
rust-mollie-sdk/docs/TerminalsApiApi.md
Zomatree e738db98b9 init
2025-10-20 14:41:17 +01:00

3.4 KiB

\TerminalsApiApi

All URIs are relative to https://api.mollie.com/v2

Method HTTP request Description
get_terminal GET /terminals/{terminalId} Get terminal
list_terminals GET /terminals List terminals

get_terminal

models::EntityTerminal get_terminal(terminal_id, testmode, idempotency_key) Get terminal

Retrieve a single terminal by its ID.

Parameters

Name Type Description Required Notes
terminal_id String Provide the ID of the related terminal. [required]
testmode Option<bool> Most API credentials are specifically created for either live mode or test mode. In those cases the testmode query parameter can be omitted. 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.
idempotency_key Option<String> A unique key to ensure idempotent requests. This key should be a UUID v4 string.

Return type

models::EntityTerminal

Authorization

apiKey, oAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/hal+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_terminals

models::ListTerminals200Response list_terminals(from, limit, sort, testmode, idempotency_key) List terminals

Retrieve a list of all physical point-of-sale devices. The results are paginated.

Parameters

Name Type Description Required Notes
from Option<String> 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.
limit Option<i32> The maximum number of items to return. Defaults to 50 items.
sort Option<String> Used for setting the direction of the result set. Defaults to descending order, meaning the results are ordered from newest to oldest.
testmode Option<bool> Most API credentials are specifically created for either live mode or test mode. In those cases the testmode query parameter can be omitted. 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.
idempotency_key Option<String> A unique key to ensure idempotent requests. This key should be a UUID v4 string.

Return type

models::ListTerminals200Response

Authorization

apiKey, oAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/hal+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]