Client (Adyen Java API Library 17.1.0 API)

java.lang.Object
- com.adyen.Client

```
public class Client
extends Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`API_VERSION`
`static String`	`BIN_LOOKUP_API_VERSION`
`static String`	`BIN_LOOKUP_PAL_SUFFIX`
`static String`	`CHECKOUT_API_VERSION`
`static String`	`CHECKOUT_ENDPOINT_CERT_LIVE`
`static String`	`CHECKOUT_ENDPOINT_LIVE_SUFFIX`
`static String`	`CHECKOUT_ENDPOINT_TEST`
`static String`	`CHECKOUT_STORED_PAYMENT_METHODS_VERSION`
`static String`	`CHECKOUT_UTILITY_API_VERSION`
`static String`	`DATA_PROTECTION_ENDPOINT_LIVE`
`static String`	`DATA_PROTECTION_ENDPOINT_TEST`
`static String`	`DATA_PROTECTION_VERSION`
`static String`	`ENDPOINT_CERT_LIVE`
`static String`	`ENDPOINT_LIVE`
`static String`	`ENDPOINT_LIVE_SUFFIX`
`static String`	`ENDPOINT_PROTOCOL`
`static String`	`ENDPOINT_TEST`
`static String`	`HPP_LIVE`
`static String`	`HPP_TEST`
`static String`	`LIB_NAME`
`static String`	`LIB_VERSION`
`static String`	`MARKETPAY_ACCOUNT_API_VERSION`
`static String`	`MARKETPAY_ENDPOINT_LIVE`
`static String`	`MARKETPAY_ENDPOINT_TEST`
`static String`	`MARKETPAY_FUND_API_VERSION`
`static String`	`MARKETPAY_HOP_API_VERSION`
`static String`	`MARKETPAY_NOTIFICATION_API_VERSION`
`static String`	`PAYOUT_API_VERSION`
`static String`	`POS_TERMINAL_MANAGEMENT_ENDPOINT_LIVE`
`static String`	`POS_TERMINAL_MANAGEMENT_ENDPOINT_TEST`
`static String`	`POS_TERMINAL_MANAGEMENT_VERSION`
`static String`	`RECURRING_API_VERSION`
`static String`	`STORED_VALUE_API_VERSION`
`static String`	`STORED_VALUE_PAL_SUFFIX`
`static String`	`TERMINAL_API_ENDPOINT_LIVE`
`static String`	`TERMINAL_API_ENDPOINT_TEST`

Constructor Summary

Constructors
Constructor and Description
`Client()`
`Client(Config config)`
`Client(KeyStore trustStore, KeyStore clientKeyStore, String clientKeyStorePassword, String apiKey, Region region)` Use this constructor to create client for client certificate authentication along with API key.
`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)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and 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
  - ENDPOINT_TEST
```
public static final String ENDPOINT_TEST
```
    See Also:
    
    Constant Field Values
  - ENDPOINT_LIVE
```
public static final String ENDPOINT_LIVE
```
    See Also:
    
    Constant Field Values
  - ENDPOINT_CERT_LIVE
```
public static final String ENDPOINT_CERT_LIVE
```
    See Also:
    
    Constant Field Values
  - ENDPOINT_LIVE_SUFFIX
```
public static final String ENDPOINT_LIVE_SUFFIX
```
    See Also:
    
    Constant Field Values
  - HPP_TEST
```
public static final String HPP_TEST
```
    See Also:
    
    Constant Field Values
  - HPP_LIVE
```
public static final String HPP_LIVE
```
    See Also:
    
    Constant Field Values
  - MARKETPAY_ENDPOINT_TEST
```
public static final String MARKETPAY_ENDPOINT_TEST
```
    See Also:
    
    Constant Field Values
  - MARKETPAY_ENDPOINT_LIVE
```
public static final String MARKETPAY_ENDPOINT_LIVE
```
    See Also:
    
    Constant Field Values
  - API_VERSION
```
public static final String API_VERSION
```
    See Also:
    
    Constant Field Values
  - PAYOUT_API_VERSION
```
public static final String PAYOUT_API_VERSION
```
    See Also:
    
    Constant Field Values
  - RECURRING_API_VERSION
```
public static final String RECURRING_API_VERSION
```
    See Also:
    
    Constant Field Values
  - MARKETPAY_ACCOUNT_API_VERSION
```
public static final String MARKETPAY_ACCOUNT_API_VERSION
```
    See Also:
    
    Constant Field Values
  - MARKETPAY_FUND_API_VERSION
```
public static final String MARKETPAY_FUND_API_VERSION
```
    See Also:
    
    Constant Field Values
  - MARKETPAY_NOTIFICATION_API_VERSION
```
public static final String MARKETPAY_NOTIFICATION_API_VERSION
```
    See Also:
    
    Constant Field Values
  - MARKETPAY_HOP_API_VERSION
```
public static final String MARKETPAY_HOP_API_VERSION
```
    See Also:
    
    Constant Field Values
  - 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
  - CHECKOUT_ENDPOINT_TEST
```
public static final String CHECKOUT_ENDPOINT_TEST
```
    See Also:
    
    Constant Field Values
  - CHECKOUT_ENDPOINT_LIVE_SUFFIX
```
public static final String CHECKOUT_ENDPOINT_LIVE_SUFFIX
```
    See Also:
    
    Constant Field Values
  - CHECKOUT_ENDPOINT_CERT_LIVE
```
public static final String CHECKOUT_ENDPOINT_CERT_LIVE
```
    See Also:
    
    Constant Field Values
  - CHECKOUT_API_VERSION
```
public static final String CHECKOUT_API_VERSION
```
    See Also:
    
    Constant Field Values
  - CHECKOUT_STORED_PAYMENT_METHODS_VERSION
```
public static final String CHECKOUT_STORED_PAYMENT_METHODS_VERSION
```
    See Also:
    
    Constant Field Values
  - BIN_LOOKUP_PAL_SUFFIX
```
public static final String BIN_LOOKUP_PAL_SUFFIX
```
    See Also:
    
    Constant Field Values
  - BIN_LOOKUP_API_VERSION
```
public static final String BIN_LOOKUP_API_VERSION
```
    See Also:
    
    Constant Field Values
  - CHECKOUT_UTILITY_API_VERSION
```
public static final String CHECKOUT_UTILITY_API_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
  - STORED_VALUE_PAL_SUFFIX
```
public static final String STORED_VALUE_PAL_SUFFIX
```
    See Also:
    
    Constant Field Values
  - STORED_VALUE_API_VERSION
```
public static final String STORED_VALUE_API_VERSION
```
    See Also:
    
    Constant Field Values
  - ENDPOINT_PROTOCOL
```
public static final String ENDPOINT_PROTOCOL
```
    See Also:
    
    Constant Field Values
  - POS_TERMINAL_MANAGEMENT_ENDPOINT_TEST
```
public static final String POS_TERMINAL_MANAGEMENT_ENDPOINT_TEST
```
    See Also:
    
    Constant Field Values
  - POS_TERMINAL_MANAGEMENT_ENDPOINT_LIVE
```
public static final String POS_TERMINAL_MANAGEMENT_ENDPOINT_LIVE
```
    See Also:
    
    Constant Field Values
  - DATA_PROTECTION_ENDPOINT_TEST
```
public static final String DATA_PROTECTION_ENDPOINT_TEST
```
    See Also:
    
    Constant Field Values
  - DATA_PROTECTION_ENDPOINT_LIVE
```
public static final String DATA_PROTECTION_ENDPOINT_LIVE
```
    See Also:
    
    Constant Field Values
  - POS_TERMINAL_MANAGEMENT_VERSION
```
public static final String POS_TERMINAL_MANAGEMENT_VERSION
```
    See Also:
    
    Constant Field Values
  - DATA_PROTECTION_VERSION
```
public static final String DATA_PROTECTION_VERSION
```
    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(KeyStore trustStore,
              KeyStore clientKeyStore,
              String clientKeyStorePassword,
              String apiKey,
              Region region)
```
    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:
    
    trustStore - Trust store containing server certificate
    
    clientKeyStore - Client Key store containing client certificate and key
    
    clientKeyStorePassword - Password for client key store
    
    apiKey - Adyen API Key
    
    region - Data center region (EU/US/AU), default EU if not provided
  - 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)
```

Class Client

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ENDPOINT_TEST

ENDPOINT_LIVE

ENDPOINT_CERT_LIVE

ENDPOINT_LIVE_SUFFIX

HPP_TEST

HPP_LIVE

MARKETPAY_ENDPOINT_TEST

MARKETPAY_ENDPOINT_LIVE

API_VERSION

PAYOUT_API_VERSION

RECURRING_API_VERSION

MARKETPAY_ACCOUNT_API_VERSION

MARKETPAY_FUND_API_VERSION

MARKETPAY_NOTIFICATION_API_VERSION

MARKETPAY_HOP_API_VERSION

LIB_NAME

LIB_VERSION

CHECKOUT_ENDPOINT_TEST

CHECKOUT_ENDPOINT_LIVE_SUFFIX

CHECKOUT_ENDPOINT_CERT_LIVE

CHECKOUT_API_VERSION

CHECKOUT_STORED_PAYMENT_METHODS_VERSION

BIN_LOOKUP_PAL_SUFFIX

BIN_LOOKUP_API_VERSION

CHECKOUT_UTILITY_API_VERSION

TERMINAL_API_ENDPOINT_TEST

TERMINAL_API_ENDPOINT_LIVE

STORED_VALUE_PAL_SUFFIX

STORED_VALUE_API_VERSION

ENDPOINT_PROTOCOL

POS_TERMINAL_MANAGEMENT_ENDPOINT_TEST

POS_TERMINAL_MANAGEMENT_ENDPOINT_LIVE

DATA_PROTECTION_ENDPOINT_TEST

DATA_PROTECTION_ENDPOINT_LIVE

POS_TERMINAL_MANAGEMENT_VERSION

DATA_PROTECTION_VERSION

Constructor Detail

Client

Client

Client

Client

Client

Client

Client

Client

Client

Client

Client

Method Detail

setEnvironment

setEnvironment

toString

getHttpClient

setHttpClient

getConfig

setConfig

setApplicationName

setTimeouts