Package com.adyen.service.management

Class TerminalSettingsTerminalLevelApi

java.lang.Object

com.adyen.Service

com.adyen.service.management.TerminalSettingsTerminalLevelApi

public class TerminalSettingsTerminalLevelApi
extends Service

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_VERSION
protected String	baseURL

Constructor Summary

Constructors

Constructor	Description
TerminalSettingsTerminalLevelApi(Client client)	Terminal settings - terminal level constructor in package.
TerminalSettingsTerminalLevelApi(Client client, String baseURL)	Terminal settings - terminal level constructor in package.

Method Summary

Modifier and Type	Method	Description
Logo	getTerminalLogo(String terminalId)	Get the terminal logo
Logo	getTerminalLogo(String terminalId, RequestOptions requestOptions)	Get the terminal logo
TerminalSettings	getTerminalSettings(String terminalId)	Get terminal settings
TerminalSettings	getTerminalSettings(String terminalId, RequestOptions requestOptions)	Get terminal settings
Logo	updateLogo(String terminalId, Logo logo)	Update the logo
Logo	updateLogo(String terminalId, Logo logo, RequestOptions requestOptions)	Update the logo
TerminalSettings	updateTerminalSettings(String terminalId, TerminalSettings terminalSettings)	Update terminal settings
TerminalSettings	updateTerminalSettings(String terminalId, TerminalSettings terminalSettings, RequestOptions requestOptions)	Update terminal settings

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

TerminalSettingsTerminalLevelApi

public TerminalSettingsTerminalLevelApi(Client client)

Terminal settings - terminal level constructor in package.

Parameters:

client - Client (required)

TerminalSettingsTerminalLevelApi

public TerminalSettingsTerminalLevelApi(Client client,
                                        String baseURL)

Terminal settings - 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

getTerminalLogo

public Logo getTerminalLogo(String terminalId)
                     throws ApiException,
                            IOException

Get the terminal logo

Parameters:

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

Returns:

Logo

Throws:

ApiException - if fails to make API call

IOException

getTerminalLogo

public Logo getTerminalLogo(String terminalId,
                            RequestOptions requestOptions)
                     throws ApiException,
                            IOException

Get the terminal logo

Parameters:

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

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

Returns:

Logo

Throws:

ApiException - if fails to make API call

IOException

getTerminalSettings

public TerminalSettings getTerminalSettings(String terminalId)
                                     throws ApiException,
                                            IOException

Get terminal settings

Parameters:

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

Returns:

TerminalSettings

Throws:

ApiException - if fails to make API call

IOException

getTerminalSettings

public TerminalSettings getTerminalSettings(String terminalId,
                                            RequestOptions requestOptions)
                                     throws ApiException,
                                            IOException

Get terminal settings

Parameters:

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

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

Returns:

TerminalSettings

Throws:

ApiException - if fails to make API call

IOException

updateLogo

public Logo updateLogo(String terminalId,
                       Logo logo)
                throws ApiException,
                       IOException

Update the logo

Parameters:

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

logo - Logo (required)

Returns:

Logo

Throws:

ApiException - if fails to make API call

IOException

updateLogo

public Logo updateLogo(String terminalId,
                       Logo logo,
                       RequestOptions requestOptions)
                throws ApiException,
                       IOException

Update the logo

Parameters:

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

logo - Logo (required)

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

Returns:

Logo

Throws:

ApiException - if fails to make API call

IOException

updateTerminalSettings

public TerminalSettings updateTerminalSettings(String terminalId,
                                               TerminalSettings terminalSettings)
                                        throws ApiException,
                                               IOException

Update terminal settings

Parameters:

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

terminalSettings - TerminalSettings (required)

Returns:

TerminalSettings

Throws:

ApiException - if fails to make API call

IOException

updateTerminalSettings

public TerminalSettings updateTerminalSettings(String terminalId,
                                               TerminalSettings terminalSettings,
                                               RequestOptions requestOptions)
                                        throws ApiException,
                                               IOException

Update terminal settings

Parameters:

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

terminalSettings - TerminalSettings (required)

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

Returns:

TerminalSettings

Throws:

ApiException - if fails to make API call

IOException