Package com.adyen.service.management

Class ClientKeyCompanyLevelApi

java.lang.Object

com.adyen.Service

com.adyen.service.management.ClientKeyCompanyLevelApi

public class ClientKeyCompanyLevelApi
extends Service

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_VERSION
protected String	baseURL

Constructor Summary

Constructors

Constructor	Description
ClientKeyCompanyLevelApi(Client client)	Client key - company level constructor in package.
ClientKeyCompanyLevelApi(Client client, String baseURL)	Client key - company level constructor in package.

Method Summary

Modifier and Type	Method	Description
GenerateClientKeyResponse	generateNewClientKey(String companyId, String apiCredentialId)	Generate new client key
GenerateClientKeyResponse	generateNewClientKey(String companyId, String apiCredentialId, RequestOptions requestOptions)	Generate new client key

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

ClientKeyCompanyLevelApi

public ClientKeyCompanyLevelApi(Client client)

Client key - company level constructor in package.

Parameters:

client - Client (required)

ClientKeyCompanyLevelApi

public ClientKeyCompanyLevelApi(Client client,
                                String baseURL)

Client key - company 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

generateNewClientKey

public GenerateClientKeyResponse generateNewClientKey(String companyId,
                                                      String apiCredentialId)
                                               throws ApiException,
                                                      IOException

Generate new client key

Parameters:

companyId - String The unique identifier of the company account. (required)

apiCredentialId - String Unique identifier of the API credential. (required)

Returns:

GenerateClientKeyResponse

Throws:

ApiException - if fails to make API call

IOException

generateNewClientKey

public GenerateClientKeyResponse generateNewClientKey(String companyId,
                                                      String apiCredentialId,
                                                      RequestOptions requestOptions)
                                               throws ApiException,
                                                      IOException

Generate new client key

Parameters:

companyId - String The unique identifier of the company account. (required)

apiCredentialId - String Unique identifier of the API credential. (required)

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

Returns:

GenerateClientKeyResponse

Throws:

ApiException - if fails to make API call

IOException