Package com.adyen.service.checkout

Class RecurringApi

java.lang.Object

com.adyen.Service

com.adyen.service.checkout.RecurringApi

public class RecurringApi
extends Service

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_VERSION
protected String	baseURL

Constructor Summary

Constructors

Constructor	Description
RecurringApi(Client client)	Recurring constructor in package.
RecurringApi(Client client, String baseURL)	Recurring constructor in package.

Method Summary

Modifier and Type	Method	Description
void	deleteTokenForStoredPaymentDetails(String storedPaymentMethodId, String shopperReference, String merchantAccount)	Delete a token for stored payment details
void	deleteTokenForStoredPaymentDetails(String storedPaymentMethodId, String shopperReference, String merchantAccount, RequestOptions requestOptions)	Delete a token for stored payment details
ListStoredPaymentMethodsResponse	getTokensForStoredPaymentDetails()	Get tokens for stored payment details
ListStoredPaymentMethodsResponse	getTokensForStoredPaymentDetails(String shopperReference, String merchantAccount, RequestOptions requestOptions)	Get tokens for stored payment details
StoredPaymentMethodResource	storedPaymentMethods(StoredPaymentMethodRequest storedPaymentMethodRequest)	Create a token to store payment details
StoredPaymentMethodResource	storedPaymentMethods(StoredPaymentMethodRequest storedPaymentMethodRequest, RequestOptions requestOptions)	Create a token to store payment details

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

RecurringApi

public RecurringApi(Client client)

Recurring constructor in package.

Parameters:

client - Client (required)

RecurringApi

public RecurringApi(Client client,
                    String baseURL)

Recurring 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

deleteTokenForStoredPaymentDetails

public void deleteTokenForStoredPaymentDetails(String storedPaymentMethodId,
                                               String shopperReference,
                                               String merchantAccount)
                                        throws ApiException,
                                               IOException

Delete a token for stored payment details

Parameters:

storedPaymentMethodId - String The unique identifier of the token. (required)

shopperReference - String Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters. > Your reference must not include personally identifiable information (PII), for example name or email address. (required)

merchantAccount - String Your merchant account. (required)

Throws:

ApiException - if fails to make API call

IOException

deleteTokenForStoredPaymentDetails

public void deleteTokenForStoredPaymentDetails(String storedPaymentMethodId,
                                               String shopperReference,
                                               String merchantAccount,
                                               RequestOptions requestOptions)
                                        throws ApiException,
                                               IOException

Delete a token for stored payment details

Parameters:

storedPaymentMethodId - String The unique identifier of the token. (required)

shopperReference - String Query: Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters. > Your reference must not include personally identifiable information (PII), for example name or email address. (required)

merchantAccount - String Query: Your merchant account. (required)

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

Throws:

ApiException - if fails to make API call

IOException

getTokensForStoredPaymentDetails

public ListStoredPaymentMethodsResponse getTokensForStoredPaymentDetails()
                                                                  throws ApiException,
                                                                         IOException

Get tokens for stored payment details

Returns:

ListStoredPaymentMethodsResponse

Throws:

ApiException - if fails to make API call

IOException

getTokensForStoredPaymentDetails

public ListStoredPaymentMethodsResponse getTokensForStoredPaymentDetails(String shopperReference,
                                                                         String merchantAccount,
                                                                         RequestOptions requestOptions)
                                                                  throws ApiException,
                                                                         IOException

Get tokens for stored payment details

Parameters:

shopperReference - String Query: Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters. > Your reference must not include personally identifiable information (PII), for example name or email address. (optional)

merchantAccount - String Query: Your merchant account. (optional)

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

Returns:

ListStoredPaymentMethodsResponse

Throws:

ApiException - if fails to make API call

IOException

storedPaymentMethods

public StoredPaymentMethodResource storedPaymentMethods(StoredPaymentMethodRequest storedPaymentMethodRequest)
                                                 throws ApiException,
                                                        IOException

Create a token to store payment details

Parameters:

storedPaymentMethodRequest - StoredPaymentMethodRequest (required)

Returns:

StoredPaymentMethodResource

Throws:

ApiException - if fails to make API call

IOException

storedPaymentMethods

public StoredPaymentMethodResource storedPaymentMethods(StoredPaymentMethodRequest storedPaymentMethodRequest,
                                                        RequestOptions requestOptions)
                                                 throws ApiException,
                                                        IOException

Create a token to store payment details

Parameters:

storedPaymentMethodRequest - StoredPaymentMethodRequest (required)

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

Returns:

StoredPaymentMethodResource

Throws:

ApiException - if fails to make API call

IOException