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_APSE
static String	TERMINAL_API_ENDPOINT_AU
static String	TERMINAL_API_ENDPOINT_LIVE
static String	TERMINAL_API_ENDPOINT_TEST
static String	TERMINAL_API_ENDPOINT_US

Constructor Summary

Constructors

Constructor	Description
Client()	Create Client instance (empty config)
Client(Config config)	Create Client instance with the given configuration
Client(String apiKey, Environment environment)	Create Client instance
Client(String apiKey, Environment environment, String liveEndpointUrlPrefix)	Create Client instance
Client(String username, String password, Environment environment, String liveEndpointUrlPrefix)	Create Client instance
Client(String username, String password, Environment environment, String liveEndpointUrlPrefix, String applicationName)	Create Client instance
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()
String	retrieveCloudEndpoint(Region region, Environment environment)	Retrieve the Terminal Cloud endpoint based on Region and Environment
void	setApplicationName(String applicationName)
void	setConfig(Config config)
void	setEnvironment(Environment environment, String liveEndpointUrlPrefix)	Set Environment, together with the live endpoint url prefix.
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

TERMINAL_API_ENDPOINT_US

public static final String TERMINAL_API_ENDPOINT_US

See Also:

Constant Field Values

TERMINAL_API_ENDPOINT_AU

public static final String TERMINAL_API_ENDPOINT_AU

See Also:

Constant Field Values

TERMINAL_API_ENDPOINT_APSE

public static final String TERMINAL_API_ENDPOINT_APSE

See Also:

Constant Field Values

Constructor Detail

Client

public Client()

Create Client instance (empty config)

Client

public Client(Config config)

Create Client instance with the given configuration

Parameters:

config - Configuration

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)

Create Client instance

Parameters:

username - HTTP basic username

password - HTTP basic password

environment - Environment (Test or Live)

liveEndpointUrlPrefix - Prefix required for Live integrations

Client

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

Create Client instance

Parameters:

username - HTTP basic username

password - HTTP basic password

environment - Environment (Test or Live)

liveEndpointUrlPrefix - Prefix required for Live integrations

applicationName - Application name (additional name/tag passed in HTTP requests)

Client

public Client(String apiKey,
              Environment environment)

Create Client instance

Parameters:

apiKey - API Key

environment - Environment (Test or Live)

Client

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

Create Client instance

Parameters:

apiKey - API Key

environment - Environment (Test or Live)

liveEndpointUrlPrefix - Prefix required for the live integrations

Method Detail

setEnvironment

public void setEnvironment(Environment environment,
                           String liveEndpointUrlPrefix)

Set Environment, together with the live endpoint url prefix.

Parameters:

environment - Environment (Test or Live)

liveEndpointUrlPrefix - The unique live url prefix (required for live integrations)

retrieveCloudEndpoint

public String retrieveCloudEndpoint(Region region,
                                    Environment environment)

Retrieve the Terminal Cloud endpoint based on Region and Environment

Parameters:

region - The region for which the endpoint is requested. If null or the region is not found, defaults to default EU endpoint.

environment - Environment (Test or Live)

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)