Skip to content

README.md

Latest commit

 

History

History
174 lines (127 loc) · 15.1 KB

README.md

File metadata and controls

174 lines (127 loc) · 15.1 KB

Terminals

Overview

Available Operations

  • list - List terminals
  • get - Get terminal

list

Retrieve a list of all physical point-of-sale devices.

The results are paginated.

Example Usage: list-terminals-200-1

package hello.world;

import com.mollie.mollie.Client;
import com.mollie.mollie.models.components.Security;
import com.mollie.mollie.models.components.Sorting;
import com.mollie.mollie.models.errors.ErrorResponse;
import com.mollie.mollie.models.operations.ListTerminalsRequest;
import com.mollie.mollie.models.operations.ListTerminalsResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ErrorResponse, Exception {

        Client sdk = Client.builder()
                .testmode(false)
                .security(Security.builder()
                    .apiKey(System.getenv().getOrDefault("API_KEY", ""))
                    .build())
            .build();

        ListTerminalsRequest req = ListTerminalsRequest.builder()
                .from("term_vytxeTZskVKR7C7WgdSP3d")
                .limit(50L)
                .sort(Sorting.DESC)
                .idempotencyKey("123e4567-e89b-12d3-a456-426")
                .build();


        sdk.terminals().list()
                .callAsStream()
                .forEach((ListTerminalsResponse item) -> {
                   // handle page
                });

    }
}

Example Usage: list-terminals-200-2

package hello.world;

import com.mollie.mollie.Client;
import com.mollie.mollie.models.components.Security;
import com.mollie.mollie.models.components.Sorting;
import com.mollie.mollie.models.errors.ErrorResponse;
import com.mollie.mollie.models.operations.ListTerminalsRequest;
import com.mollie.mollie.models.operations.ListTerminalsResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ErrorResponse, Exception {

        Client sdk = Client.builder()
                .testmode(false)
                .security(Security.builder()
                    .apiKey(System.getenv().getOrDefault("API_KEY", ""))
                    .build())
            .build();

        ListTerminalsRequest req = ListTerminalsRequest.builder()
                .from("term_vytxeTZskVKR7C7WgdSP3d")
                .limit(50L)
                .sort(Sorting.DESC)
                .idempotencyKey("123e4567-e89b-12d3-a456-426")
                .build();


        sdk.terminals().list()
                .callAsStream()
                .forEach((ListTerminalsResponse item) -> {
                   // handle page
                });

    }
}

Parameters

Parameter Type Required Description
request ListTerminalsRequest ✔️ The request object to use for the request.

Response

ListTerminalsResponse

Errors

Error Type Status Code Content Type
models/errors/ErrorResponse 400 application/hal+json
models/errors/APIException 4XX, 5XX */*

get

Retrieve a single terminal by its ID.

Example Usage

package hello.world;

import com.mollie.mollie.Client;
import com.mollie.mollie.models.components.Security;
import com.mollie.mollie.models.errors.ErrorResponse;
import com.mollie.mollie.models.operations.GetTerminalResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ErrorResponse, Exception {

        Client sdk = Client.builder()
                .testmode(false)
                .security(Security.builder()
                    .apiKey(System.getenv().getOrDefault("API_KEY", ""))
                    .build())
            .build();

        GetTerminalResponse res = sdk.terminals().get()
                .terminalId("term_vytxeTZskVKR7C7WgdSP3d")
                .idempotencyKey("123e4567-e89b-12d3-a456-426")
                .call();

        if (res.entityTerminal().isPresent()) {
            System.out.println(res.entityTerminal().get());
        }
    }
}

Parameters

Parameter Type Required Description Example
terminalId String ✔️ Provide the ID of the related terminal. term_vytxeTZskVKR7C7WgdSP3d
testmode Optional<Boolean> ➖ 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.
idempotencyKey Optional<String> ➖ A unique key to ensure idempotent requests. This key should be a UUID v4 string. 123e4567-e89b-12d3-a456-426

Response

GetTerminalResponse

Errors

Error Type Status Code Content Type
models/errors/ErrorResponse 404 application/hal+json
models/errors/APIException 4XX, 5XX */*
⚡