Package com.adyen.service.management

Class PaymentMethodsMerchantLevelApi

java.lang.Object

com.adyen.Service

com.adyen.service.management.PaymentMethodsMerchantLevelApi

public class PaymentMethodsMerchantLevelApi
extends Service

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_VERSION
protected String	baseURL

Constructor Summary

Constructors

Constructor	Description
PaymentMethodsMerchantLevelApi(Client client)	Payment methods - merchant level constructor in package.
PaymentMethodsMerchantLevelApi(Client client, String baseURL)	Payment methods - merchant level constructor in package.

Method Summary

Modifier and Type	Method	Description
void	addApplePayDomain(String merchantId, String paymentMethodId, ApplePayInfo applePayInfo)	Add an Apple Pay domain
void	addApplePayDomain(String merchantId, String paymentMethodId, ApplePayInfo applePayInfo, RequestOptions requestOptions)	Add an Apple Pay domain
PaymentMethodResponse	getAllPaymentMethods(String merchantId)	Get all payment methods
PaymentMethodResponse	getAllPaymentMethods(String merchantId, String storeId, String businessLineId, Integer pageSize, Integer pageNumber, RequestOptions requestOptions)	Get all payment methods
ApplePayInfo	getApplePayDomains(String merchantId, String paymentMethodId)	Get Apple Pay domains
ApplePayInfo	getApplePayDomains(String merchantId, String paymentMethodId, RequestOptions requestOptions)	Get Apple Pay domains
PaymentMethod	getPaymentMethodDetails(String merchantId, String paymentMethodId)	Get payment method details
PaymentMethod	getPaymentMethodDetails(String merchantId, String paymentMethodId, RequestOptions requestOptions)	Get payment method details
PaymentMethod	requestPaymentMethod(String merchantId, PaymentMethodSetupInfo paymentMethodSetupInfo)	Request a payment method
PaymentMethod	requestPaymentMethod(String merchantId, PaymentMethodSetupInfo paymentMethodSetupInfo, RequestOptions requestOptions)	Request a payment method
PaymentMethod	updatePaymentMethod(String merchantId, String paymentMethodId, UpdatePaymentMethodInfo updatePaymentMethodInfo)	Update a payment method
PaymentMethod	updatePaymentMethod(String merchantId, String paymentMethodId, UpdatePaymentMethodInfo updatePaymentMethodInfo, RequestOptions requestOptions)	Update a payment method

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

PaymentMethodsMerchantLevelApi

public PaymentMethodsMerchantLevelApi(Client client)

Payment methods - merchant level constructor in package.

Parameters:

client - Client (required)

PaymentMethodsMerchantLevelApi

public PaymentMethodsMerchantLevelApi(Client client,
                                      String baseURL)

Payment methods - 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

addApplePayDomain

public void addApplePayDomain(String merchantId,
                              String paymentMethodId,
                              ApplePayInfo applePayInfo)
                       throws ApiException,
                              IOException

Add an Apple Pay domain

Parameters:

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

paymentMethodId - String The unique identifier of the payment method. (required)

applePayInfo - ApplePayInfo (required)

Throws:

ApiException - if fails to make API call

IOException

addApplePayDomain

public void addApplePayDomain(String merchantId,
                              String paymentMethodId,
                              ApplePayInfo applePayInfo,
                              RequestOptions requestOptions)
                       throws ApiException,
                              IOException

Add an Apple Pay domain

Parameters:

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

paymentMethodId - String The unique identifier of the payment method. (required)

applePayInfo - ApplePayInfo (required)

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

Throws:

ApiException - if fails to make API call

IOException

getAllPaymentMethods

public PaymentMethodResponse getAllPaymentMethods(String merchantId)
                                           throws ApiException,
                                                  IOException

Get all payment methods

Parameters:

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

Returns:

PaymentMethodResponse

Throws:

ApiException - if fails to make API call

IOException

getAllPaymentMethods

public PaymentMethodResponse getAllPaymentMethods(String merchantId,
                                                  String storeId,
                                                  String businessLineId,
                                                  Integer pageSize,
                                                  Integer pageNumber,
                                                  RequestOptions requestOptions)
                                           throws ApiException,
                                                  IOException

Get all payment methods

Parameters:

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

storeId - String Query: The unique identifier of the store for which to return the payment methods. (optional)

businessLineId - String Query: The unique identifier of the Business Line for which to return the payment methods. (optional)

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

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

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

Returns:

PaymentMethodResponse

Throws:

ApiException - if fails to make API call

IOException

getApplePayDomains

public ApplePayInfo getApplePayDomains(String merchantId,
                                       String paymentMethodId)
                                throws ApiException,
                                       IOException

Get Apple Pay domains

Parameters:

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

paymentMethodId - String The unique identifier of the payment method. (required)

Returns:

ApplePayInfo

Throws:

ApiException - if fails to make API call

IOException

getApplePayDomains

public ApplePayInfo getApplePayDomains(String merchantId,
                                       String paymentMethodId,
                                       RequestOptions requestOptions)
                                throws ApiException,
                                       IOException

Get Apple Pay domains

Parameters:

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

paymentMethodId - String The unique identifier of the payment method. (required)

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

Returns:

ApplePayInfo

Throws:

ApiException - if fails to make API call

IOException

getPaymentMethodDetails

public PaymentMethod getPaymentMethodDetails(String merchantId,
                                             String paymentMethodId)
                                      throws ApiException,
                                             IOException

Get payment method details

Parameters:

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

paymentMethodId - String The unique identifier of the payment method. (required)

Returns:

PaymentMethod

Throws:

ApiException - if fails to make API call

IOException

getPaymentMethodDetails

public PaymentMethod getPaymentMethodDetails(String merchantId,
                                             String paymentMethodId,
                                             RequestOptions requestOptions)
                                      throws ApiException,
                                             IOException

Get payment method details

Parameters:

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

paymentMethodId - String The unique identifier of the payment method. (required)

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

Returns:

PaymentMethod

Throws:

ApiException - if fails to make API call

IOException

requestPaymentMethod

public PaymentMethod requestPaymentMethod(String merchantId,
                                          PaymentMethodSetupInfo paymentMethodSetupInfo)
                                   throws ApiException,
                                          IOException

Request a payment method

Parameters:

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

paymentMethodSetupInfo - PaymentMethodSetupInfo (required)

Returns:

PaymentMethod

Throws:

ApiException - if fails to make API call

IOException

requestPaymentMethod

public PaymentMethod requestPaymentMethod(String merchantId,
                                          PaymentMethodSetupInfo paymentMethodSetupInfo,
                                          RequestOptions requestOptions)
                                   throws ApiException,
                                          IOException

Request a payment method

Parameters:

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

paymentMethodSetupInfo - PaymentMethodSetupInfo (required)

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

Returns:

PaymentMethod

Throws:

ApiException - if fails to make API call

IOException

updatePaymentMethod

public PaymentMethod updatePaymentMethod(String merchantId,
                                         String paymentMethodId,
                                         UpdatePaymentMethodInfo updatePaymentMethodInfo)
                                  throws ApiException,
                                         IOException

Update a payment method

Parameters:

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

paymentMethodId - String The unique identifier of the payment method. (required)

updatePaymentMethodInfo - UpdatePaymentMethodInfo (required)

Returns:

PaymentMethod

Throws:

ApiException - if fails to make API call

IOException

updatePaymentMethod

public PaymentMethod updatePaymentMethod(String merchantId,
                                         String paymentMethodId,
                                         UpdatePaymentMethodInfo updatePaymentMethodInfo,
                                         RequestOptions requestOptions)
                                  throws ApiException,
                                         IOException

Update a payment method

Parameters:

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

paymentMethodId - String The unique identifier of the payment method. (required)

updatePaymentMethodInfo - UpdatePaymentMethodInfo (required)

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

Returns:

PaymentMethod

Throws:

ApiException - if fails to make API call

IOException