Package com.adyen.service

Class RecurringApi

java.lang.Object

com.adyen.Service

com.adyen.service.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)	Default constructor in package.
RecurringApi(Client client, String baseURL)	Alternative constructor in package.

Method Summary

Modifier and Type	Method	Description
CreatePermitResult	createPermit(CreatePermitRequest createPermitRequest)	Create new permits linked to a recurring contract.
CreatePermitResult	createPermit(CreatePermitRequest createPermitRequest, RequestOptions requestOptions)	Create new permits linked to a recurring contract.
DisableResult	disable(DisableRequest disableRequest)	Disable stored payment details
DisableResult	disable(DisableRequest disableRequest, RequestOptions requestOptions)	Disable stored payment details
DisablePermitResult	disablePermit(DisablePermitRequest disablePermitRequest)	Disable an existing permit.
DisablePermitResult	disablePermit(DisablePermitRequest disablePermitRequest, RequestOptions requestOptions)	Disable an existing permit.
RecurringDetailsResult	listRecurringDetails(RecurringDetailsRequest recurringDetailsRequest)	Get stored payment details
RecurringDetailsResult	listRecurringDetails(RecurringDetailsRequest recurringDetailsRequest, RequestOptions requestOptions)	Get stored payment details
NotifyShopperResult	notifyShopper(NotifyShopperRequest notifyShopperRequest)	Ask issuer to notify the shopper
NotifyShopperResult	notifyShopper(NotifyShopperRequest notifyShopperRequest, RequestOptions requestOptions)	Ask issuer to notify the shopper
ScheduleAccountUpdaterResult	scheduleAccountUpdater(ScheduleAccountUpdaterRequest scheduleAccountUpdaterRequest)	Schedule running the Account Updater
ScheduleAccountUpdaterResult	scheduleAccountUpdater(ScheduleAccountUpdaterRequest scheduleAccountUpdaterRequest, RequestOptions requestOptions)	Schedule running the Account Updater

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)

Default constructor in package.

Parameters:

client - Client (required)

RecurringApi

public RecurringApi(Client client,
                    String baseURL)

Alternative 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

createPermit

public CreatePermitResult createPermit(CreatePermitRequest createPermitRequest)
                                throws ApiException,
                                       IOException

Create new permits linked to a recurring contract.

Parameters:

createPermitRequest - CreatePermitRequest (required)

Returns:

CreatePermitResult

Throws:

ApiException - if fails to make API call

IOException

createPermit

public CreatePermitResult createPermit(CreatePermitRequest createPermitRequest,
                                       RequestOptions requestOptions)
                                throws ApiException,
                                       IOException

Create new permits linked to a recurring contract.

Parameters:

createPermitRequest - CreatePermitRequest (required)

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

Returns:

CreatePermitResult

Throws:

ApiException - if fails to make API call

IOException

disable

public DisableResult disable(DisableRequest disableRequest)
                      throws ApiException,
                             IOException

Disable stored payment details

Parameters:

disableRequest - DisableRequest (required)

Returns:

DisableResult

Throws:

ApiException - if fails to make API call

IOException

disable

public DisableResult disable(DisableRequest disableRequest,
                             RequestOptions requestOptions)
                      throws ApiException,
                             IOException

Disable stored payment details

Parameters:

disableRequest - DisableRequest (required)

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

Returns:

DisableResult

Throws:

ApiException - if fails to make API call

IOException

disablePermit

public DisablePermitResult disablePermit(DisablePermitRequest disablePermitRequest)
                                  throws ApiException,
                                         IOException

Disable an existing permit.

Parameters:

disablePermitRequest - DisablePermitRequest (required)

Returns:

DisablePermitResult

Throws:

ApiException - if fails to make API call

IOException

disablePermit

public DisablePermitResult disablePermit(DisablePermitRequest disablePermitRequest,
                                         RequestOptions requestOptions)
                                  throws ApiException,
                                         IOException

Disable an existing permit.

Parameters:

disablePermitRequest - DisablePermitRequest (required)

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

Returns:

DisablePermitResult

Throws:

ApiException - if fails to make API call

IOException

listRecurringDetails

public RecurringDetailsResult listRecurringDetails(RecurringDetailsRequest recurringDetailsRequest)
                                            throws ApiException,
                                                   IOException

Get stored payment details

Parameters:

recurringDetailsRequest - RecurringDetailsRequest (required)

Returns:

RecurringDetailsResult

Throws:

ApiException - if fails to make API call

IOException

listRecurringDetails

public RecurringDetailsResult listRecurringDetails(RecurringDetailsRequest recurringDetailsRequest,
                                                   RequestOptions requestOptions)
                                            throws ApiException,
                                                   IOException

Get stored payment details

Parameters:

recurringDetailsRequest - RecurringDetailsRequest (required)

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

Returns:

RecurringDetailsResult

Throws:

ApiException - if fails to make API call

IOException

notifyShopper

public NotifyShopperResult notifyShopper(NotifyShopperRequest notifyShopperRequest)
                                  throws ApiException,
                                         IOException

Ask issuer to notify the shopper

Parameters:

notifyShopperRequest - NotifyShopperRequest (required)

Returns:

NotifyShopperResult

Throws:

ApiException - if fails to make API call

IOException

notifyShopper

public NotifyShopperResult notifyShopper(NotifyShopperRequest notifyShopperRequest,
                                         RequestOptions requestOptions)
                                  throws ApiException,
                                         IOException

Ask issuer to notify the shopper

Parameters:

notifyShopperRequest - NotifyShopperRequest (required)

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

Returns:

NotifyShopperResult

Throws:

ApiException - if fails to make API call

IOException

scheduleAccountUpdater

public ScheduleAccountUpdaterResult scheduleAccountUpdater(ScheduleAccountUpdaterRequest scheduleAccountUpdaterRequest)
                                                    throws ApiException,
                                                           IOException

Schedule running the Account Updater

Parameters:

scheduleAccountUpdaterRequest - ScheduleAccountUpdaterRequest (required)

Returns:

ScheduleAccountUpdaterResult

Throws:

ApiException - if fails to make API call

IOException

scheduleAccountUpdater

public ScheduleAccountUpdaterResult scheduleAccountUpdater(ScheduleAccountUpdaterRequest scheduleAccountUpdaterRequest,
                                                           RequestOptions requestOptions)
                                                    throws ApiException,
                                                           IOException

Schedule running the Account Updater

Parameters:

scheduleAccountUpdaterRequest - ScheduleAccountUpdaterRequest (required)

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

Returns:

ScheduleAccountUpdaterResult

Throws:

ApiException - if fails to make API call

IOException