Package com.adyen

Class Client

java.lang.Object

com.adyen.Client

public class Client
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static String	LIB_NAME
static String	LIB_VERSION
static String	TERMINAL_API_ENDPOINT_LIVE
static String	TERMINAL_API_ENDPOINT_TEST

Constructor Summary

Constructors

Constructor	Description
Client()
Client(Config config)
Client(String apiKey, Environment environment)
Client(String apiKey, Environment environment, int connectionTimeoutMillis)	Deprecated. As of library version 1.6.1, timeouts should be set by setTimeouts(int connectionTimeoutMillis, int readTimeoutMillis) or directly by Config.setConnectionTimeoutMillis(int connectionTimeoutMillis).
Client(String apiKey, Environment environment, int connectionTimeoutMillis, String liveEndpointUrlPrefix)	Deprecated. As of library version 1.6.1, timeouts should be set by setTimeouts(int connectionTimeoutMillis, int readTimeoutMillis) or directly by Config.setConnectionTimeoutMillis(int connectionTimeoutMillis).
Client(String apiKey, Environment environment, String liveEndpointUrlPrefix)
Client(String username, String password, Environment environment, int connectionTimeoutMillis)	Deprecated. As of library version 1.6.1, timeouts should be set by setTimeouts(int connectionTimeoutMillis, int readTimeoutMillis) or directly by Config.setConnectionTimeoutMillis(int connectionTimeoutMillis).
Client(String username, String password, Environment environment, int connectionTimeoutMillis, String liveEndpointUrlPrefix)	Deprecated. As of library version 1.6.1, timeouts should be set by setTimeouts(int connectionTimeoutMillis, int readTimeoutMillis) or directly by Config.setConnectionTimeoutMillis(int connectionTimeoutMillis).
Client(String username, String password, Environment environment, String applicationName)
Client(String username, String password, Environment environment, String liveEndpointUrlPrefix, String applicationName)
Client(SSLContext sslContext, String apiKey)	Use this constructor to create client for client certificate authentication along with API key.

Method Summary

Modifier and Type	Method	Description
Config	getConfig()
ClientInterface	getHttpClient()
void	setApplicationName(String applicationName)
void	setConfig(Config config)
void	setEnvironment(Environment environment)	Deprecated. As of library version 1.5.4, replaced by setEnvironment(Environment environment, String liveEndpointUrlPrefix).
void	setEnvironment(Environment environment, String liveEndpointUrlPrefix)
void	setHttpClient(ClientInterface httpClient)
void	setTimeouts(int connectionTimeoutMillis, int readTimeoutMillis)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

LIB_NAME

public static final String LIB_NAME

See Also:

Constant Field Values

LIB_VERSION

public static final String LIB_VERSION

See Also:

Constant Field Values

TERMINAL_API_ENDPOINT_TEST

public static final String TERMINAL_API_ENDPOINT_TEST

See Also:

Constant Field Values

TERMINAL_API_ENDPOINT_LIVE

public static final String TERMINAL_API_ENDPOINT_LIVE

See Also:

Constant Field Values

Constructor Detail

Client

public Client()

Client

public Client(Config config)

Client

public Client(String username,
              String password,
              Environment environment,
              String applicationName)

Client

public Client(SSLContext sslContext,
              String apiKey)

Use this constructor to create client for client certificate authentication along with API key. Note: Client certificate authentication is only applicable for PAL and Checkout services in LIVE, Other services will just use API key for authentication.

Parameters:

sslContext - SSLContext for client certificate authentication

apiKey - Adyen API Key

Client

public Client(String username,
              String password,
              Environment environment,
              String liveEndpointUrlPrefix,
              String applicationName)

Client

@Deprecated
public Client(String username,
              String password,
              Environment environment,
              int connectionTimeoutMillis)

Deprecated.

As of library version 1.6.1, timeouts should be set by setTimeouts(int connectionTimeoutMillis, int readTimeoutMillis) or directly by Config.setConnectionTimeoutMillis(int connectionTimeoutMillis).

Parameters:

username - your merchant account Username

password - your merchant accont Password

environment - This defines the payment environment live or test

connectionTimeoutMillis - Provide the time to time out

Client

@Deprecated
public Client(String username,
              String password,
              Environment environment,
              int connectionTimeoutMillis,
              String liveEndpointUrlPrefix)

Deprecated.

As of library version 1.6.1, timeouts should be set by setTimeouts(int connectionTimeoutMillis, int readTimeoutMillis) or directly by Config.setConnectionTimeoutMillis(int connectionTimeoutMillis).

Parameters:

username - your merchant account Username

password - your merchant accont Password

environment - This defines the payment environment live or test

connectionTimeoutMillis - Provide the time to time out

liveEndpointUrlPrefix - provide the merchant specific url

Client

public Client(String apiKey,
              Environment environment)

Client

public Client(String apiKey,
              Environment environment,
              String liveEndpointUrlPrefix)

Client

@Deprecated
public Client(String apiKey,
              Environment environment,
              int connectionTimeoutMillis)

Deprecated.

As of library version 1.6.1, timeouts should be set by setTimeouts(int connectionTimeoutMillis, int readTimeoutMillis) or directly by Config.setConnectionTimeoutMillis(int connectionTimeoutMillis).

Parameters:

apiKey - Defines the api key that can be retrieved by back office

environment - This defines the payment environment live or test

connectionTimeoutMillis - Provide the time to time out

Client

@Deprecated
public Client(String apiKey,
              Environment environment,
              int connectionTimeoutMillis,
              String liveEndpointUrlPrefix)

Deprecated.

As of library version 1.6.1, timeouts should be set by setTimeouts(int connectionTimeoutMillis, int readTimeoutMillis) or directly by Config.setConnectionTimeoutMillis(int connectionTimeoutMillis).

Parameters:

apiKey - Defines the api key that can be retrieved by back office

environment - This defines the payment environment live or test

connectionTimeoutMillis - Provide the time to time out

liveEndpointUrlPrefix - provide the merchant specific url

Method Detail

setEnvironment

@Deprecated
public void setEnvironment(Environment environment)

Deprecated.

As of library version 1.5.4, replaced by setEnvironment(Environment environment, String liveEndpointUrlPrefix).

Parameters:

environment - This defines the payment environment live or test

setEnvironment

public void setEnvironment(Environment environment,
                           String liveEndpointUrlPrefix)

Parameters:

environment - This defines the payment environment live or test

liveEndpointUrlPrefix - Provide the unique live url prefix from the "API URLs and Response" menu in the Adyen Customer Area

toString

public String toString()

Overrides:

toString in class Object

getHttpClient

public ClientInterface getHttpClient()

setHttpClient

public void setHttpClient(ClientInterface httpClient)

getConfig

public Config getConfig()

setConfig

public void setConfig(Config config)

setApplicationName

public void setApplicationName(String applicationName)

setTimeouts

public void setTimeouts(int connectionTimeoutMillis,
                        int readTimeoutMillis)