Package com.adyen.service.management

Class TerminalsTerminalLevelApi

java.lang.Object

com.adyen.Service

com.adyen.service.management.TerminalsTerminalLevelApi

public class TerminalsTerminalLevelApi
extends Service

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_VERSION
protected String	baseURL

Constructor Summary

Constructors

Constructor	Description
TerminalsTerminalLevelApi(Client client)	Terminals - terminal level constructor in package.
TerminalsTerminalLevelApi(Client client, String baseURL)	Terminals - terminal level constructor in package.

Method Summary

Modifier and Type	Method	Description
ListTerminalsResponse	listTerminals()	Get a list of terminals
ListTerminalsResponse	listTerminals(String searchQuery, String otpQuery, String countries, String merchantIds, String storeIds, String brandModels, Integer pageNumber, Integer pageSize, RequestOptions requestOptions)	Get a list of terminals
void	reassignTerminal(String terminalId, TerminalReassignmentRequest terminalReassignmentRequest)	Reassign a terminal
void	reassignTerminal(String terminalId, TerminalReassignmentRequest terminalReassignmentRequest, RequestOptions requestOptions)	Reassign a terminal

Methods inherited from class com.adyen.Service

createBaseURL, getClient, isApiKeyRequired, setApiKeyRequired, setClient

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

API_VERSION

public static final String API_VERSION

See Also:

Constant Field Values

baseURL

protected String baseURL

Constructor Detail

TerminalsTerminalLevelApi

public TerminalsTerminalLevelApi(Client client)

Terminals - terminal level constructor in package.

Parameters:

client - Client (required)

TerminalsTerminalLevelApi

public TerminalsTerminalLevelApi(Client client,
                                 String baseURL)

Terminals - terminal level constructor in package. Please use this constructor only if you would like to pass along your own url for routing or testing purposes. The latest API version is defined in this class as a constant.

Parameters:

client - Client (required)

baseURL - String (required)

Method Detail

listTerminals

public ListTerminalsResponse listTerminals()
                                    throws ApiException,
                                           IOException

Get a list of terminals

Returns:

ListTerminalsResponse

Throws:

ApiException - if fails to make API call

IOException

listTerminals

public ListTerminalsResponse listTerminals(String searchQuery,
                                           String otpQuery,
                                           String countries,
                                           String merchantIds,
                                           String storeIds,
                                           String brandModels,
                                           Integer pageNumber,
                                           Integer pageSize,
                                           RequestOptions requestOptions)
                                    throws ApiException,
                                           IOException

Get a list of terminals

Parameters:

searchQuery - String Query: Returns terminals with an ID that contains the specified string. If present, other query parameters are ignored. (optional)

otpQuery - String Query: Returns one or more terminals associated with the one-time passwords specified in the request. If this query parameter is used, other query parameters are ignored. (optional)

countries - String Query: Returns terminals located in the countries specified by their [two-letter country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). (optional)

merchantIds - String Query: Returns terminals that belong to the merchant accounts specified by their unique merchant account ID. (optional)

storeIds - String Query: Returns terminals that are assigned to the [stores](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/stores) specified by their unique store ID. (optional)

brandModels - String Query: Returns terminals of the [models](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/companies/{companyId}/terminalModels) specified in the format *brand.model*. (optional)

pageNumber - Integer Query: The number of the page to fetch. (optional)

pageSize - Integer Query: The number of items to have on a page, maximum 100. The default is 20 items on a page. (optional)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Returns:

ListTerminalsResponse

Throws:

ApiException - if fails to make API call

IOException

reassignTerminal

public void reassignTerminal(String terminalId,
                             TerminalReassignmentRequest terminalReassignmentRequest)
                      throws ApiException,
                             IOException

Reassign a terminal

Parameters:

terminalId - String The unique identifier of the payment terminal. (required)

terminalReassignmentRequest - TerminalReassignmentRequest (required)

Throws:

ApiException - if fails to make API call

IOException

reassignTerminal

public void reassignTerminal(String terminalId,
                             TerminalReassignmentRequest terminalReassignmentRequest,
                             RequestOptions requestOptions)
                      throws ApiException,
                             IOException

Reassign a terminal

Parameters:

terminalId - String The unique identifier of the payment terminal. (required)

terminalReassignmentRequest - TerminalReassignmentRequest (required)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Throws:

ApiException - if fails to make API call

IOException