Package com.adyen.service.management

Class ApiCredentialsMerchantLevelApi

java.lang.Object

com.adyen.Service

com.adyen.service.management.ApiCredentialsMerchantLevelApi

public class ApiCredentialsMerchantLevelApi
extends Service

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_VERSION
protected String	baseURL

Constructor Summary

Constructors

Constructor	Description
ApiCredentialsMerchantLevelApi(Client client)	API credentials - merchant level constructor in package.
ApiCredentialsMerchantLevelApi(Client client, String baseURL)	API credentials - merchant level constructor in package.

Method Summary

Modifier and Type	Method	Description
CreateApiCredentialResponse	createApiCredential(String merchantId, CreateMerchantApiCredentialRequest createMerchantApiCredentialRequest)	Create an API credential
CreateApiCredentialResponse	createApiCredential(String merchantId, CreateMerchantApiCredentialRequest createMerchantApiCredentialRequest, RequestOptions requestOptions)	Create an API credential
ApiCredential	getApiCredential(String merchantId, String apiCredentialId)	Get an API credential
ApiCredential	getApiCredential(String merchantId, String apiCredentialId, RequestOptions requestOptions)	Get an API credential
ListMerchantApiCredentialsResponse	listApiCredentials(String merchantId)	Get a list of API credentials
ListMerchantApiCredentialsResponse	listApiCredentials(String merchantId, Integer pageNumber, Integer pageSize, RequestOptions requestOptions)	Get a list of API credentials
ApiCredential	updateApiCredential(String merchantId, String apiCredentialId, UpdateMerchantApiCredentialRequest updateMerchantApiCredentialRequest)	Update an API credential
ApiCredential	updateApiCredential(String merchantId, String apiCredentialId, UpdateMerchantApiCredentialRequest updateMerchantApiCredentialRequest, RequestOptions requestOptions)	Update an API credential

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

ApiCredentialsMerchantLevelApi

public ApiCredentialsMerchantLevelApi(Client client)

API credentials - merchant level constructor in package.

Parameters:

client - Client (required)

ApiCredentialsMerchantLevelApi

public ApiCredentialsMerchantLevelApi(Client client,
                                      String baseURL)

API credentials - merchant 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

createApiCredential

public CreateApiCredentialResponse createApiCredential(String merchantId,
                                                       CreateMerchantApiCredentialRequest createMerchantApiCredentialRequest)
                                                throws ApiException,
                                                       IOException

Create an API credential

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

createMerchantApiCredentialRequest - CreateMerchantApiCredentialRequest (required)

Returns:

CreateApiCredentialResponse

Throws:

ApiException - if fails to make API call

IOException

createApiCredential

public CreateApiCredentialResponse createApiCredential(String merchantId,
                                                       CreateMerchantApiCredentialRequest createMerchantApiCredentialRequest,
                                                       RequestOptions requestOptions)
                                                throws ApiException,
                                                       IOException

Create an API credential

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

createMerchantApiCredentialRequest - CreateMerchantApiCredentialRequest (required)

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

Returns:

CreateApiCredentialResponse

Throws:

ApiException - if fails to make API call

IOException

getApiCredential

public ApiCredential getApiCredential(String merchantId,
                                      String apiCredentialId)
                               throws ApiException,
                                      IOException

Get an API credential

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

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

Returns:

ApiCredential

Throws:

ApiException - if fails to make API call

IOException

getApiCredential

public ApiCredential getApiCredential(String merchantId,
                                      String apiCredentialId,
                                      RequestOptions requestOptions)
                               throws ApiException,
                                      IOException

Get an API credential

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

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

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

Returns:

ApiCredential

Throws:

ApiException - if fails to make API call

IOException

listApiCredentials

public ListMerchantApiCredentialsResponse listApiCredentials(String merchantId)
                                                      throws ApiException,
                                                             IOException

Get a list of API credentials

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

Returns:

ListMerchantApiCredentialsResponse

Throws:

ApiException - if fails to make API call

IOException

listApiCredentials

public ListMerchantApiCredentialsResponse listApiCredentials(String merchantId,
                                                             Integer pageNumber,
                                                             Integer pageSize,
                                                             RequestOptions requestOptions)
                                                      throws ApiException,
                                                             IOException

Get a list of API credentials

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

pageNumber - Integer Query: The number of the page to fetch. (optional)

pageSize - Integer Query: The number of items to have on a page, maximum 100. The default is 10 items on a page. (optional)

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

Returns:

ListMerchantApiCredentialsResponse

Throws:

ApiException - if fails to make API call

IOException

updateApiCredential

public ApiCredential updateApiCredential(String merchantId,
                                         String apiCredentialId,
                                         UpdateMerchantApiCredentialRequest updateMerchantApiCredentialRequest)
                                  throws ApiException,
                                         IOException

Update an API credential

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

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

updateMerchantApiCredentialRequest - UpdateMerchantApiCredentialRequest (required)

Returns:

ApiCredential

Throws:

ApiException - if fails to make API call

IOException

updateApiCredential

public ApiCredential updateApiCredential(String merchantId,
                                         String apiCredentialId,
                                         UpdateMerchantApiCredentialRequest updateMerchantApiCredentialRequest,
                                         RequestOptions requestOptions)
                                  throws ApiException,
                                         IOException

Update an API credential

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

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

updateMerchantApiCredentialRequest - UpdateMerchantApiCredentialRequest (required)

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

Returns:

ApiCredential

Throws:

ApiException - if fails to make API call

IOException