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 inherited from class com.adyen.Service

GSON

Constructor Summary

Constructors

Constructor	Description
TerminalsTerminalLevelApi(Client client)

Method Summary

Modifier and Type	Method	Description
ListTerminalsResponse	listTerminals()	Get a list of terminals
ListTerminalsResponse	listTerminals(String searchQuery, String countries, String merchantIds, String storeIds, String brandModels, Integer pageNumber, Integer pageSize, RequestOptions requestOptions)	Get a list of terminals

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

Constructor Detail

TerminalsTerminalLevelApi

public TerminalsTerminalLevelApi(Client client)

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 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)

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