Package com.adyen.service.balanceplatform

Class DirectDebitMandatesApi

java.lang.Object

com.adyen.Service

com.adyen.service.balanceplatform.DirectDebitMandatesApi

public class DirectDebitMandatesApi
extends Service

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_VERSION
protected String	baseURL

Constructor Summary

Constructors

Constructor	Description
DirectDebitMandatesApi(Client client)	Direct debit mandates constructor in package.
DirectDebitMandatesApi(Client client, String baseURL)	Direct debit mandates constructor in package.

Method Summary

Modifier and Type	Method	Description
void	cancelMandate(String mandateId)	Cancel a mandate
void	cancelMandate(String mandateId, RequestOptions requestOptions)	Cancel a mandate
ListMandatesResponse	getListOfMandates()	Get a list of mandates
ListMandatesResponse	getListOfMandates(String balanceAccountId, String paymentInstrumentId, String cursor, RequestOptions requestOptions)	Get a list of mandates
Mandate	getMandateById(String mandateId)	Get a specific mandate
Mandate	getMandateById(String mandateId, RequestOptions requestOptions)	Get a specific mandate
void	updateMandate(String mandateId, MandateUpdate mandateUpdate)	Amend a mandate
void	updateMandate(String mandateId, MandateUpdate mandateUpdate, RequestOptions requestOptions)	Amend a mandate

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

DirectDebitMandatesApi

public DirectDebitMandatesApi(Client client)

Direct debit mandates constructor in package.

Parameters:

client - Client (required)

DirectDebitMandatesApi

public DirectDebitMandatesApi(Client client,
                              String baseURL)

Direct debit mandates 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

cancelMandate

public void cancelMandate(String mandateId)
                   throws ApiException,
                          IOException

Cancel a mandate

Parameters:

mandateId - String The unique identifier of the mandate. (required)

Throws:

ApiException - if fails to make API call

IOException

cancelMandate

public void cancelMandate(String mandateId,
                          RequestOptions requestOptions)
                   throws ApiException,
                          IOException

Cancel a mandate

Parameters:

mandateId - String The unique identifier of the mandate. (required)

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

Throws:

ApiException - if fails to make API call

IOException

getListOfMandates

public ListMandatesResponse getListOfMandates()
                                       throws ApiException,
                                              IOException

Get a list of mandates

Returns:

ListMandatesResponse

Throws:

ApiException - if fails to make API call

IOException

getListOfMandates

public ListMandatesResponse getListOfMandates(String balanceAccountId,
                                              String paymentInstrumentId,
                                              String cursor,
                                              RequestOptions requestOptions)
                                       throws ApiException,
                                              IOException

Get a list of mandates

Parameters:

balanceAccountId - String Query: The unique identifier of the balance account linked to the payment instrument. (optional)

paymentInstrumentId - String Query: The unique identifier of the payment instrument linked to the mandate. (optional)

cursor - String Query: The pagination cursor returned in a previous GET `/mandates` request. (optional)

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

Returns:

ListMandatesResponse

Throws:

ApiException - if fails to make API call

IOException

getMandateById

public Mandate getMandateById(String mandateId)
                       throws ApiException,
                              IOException

Get a specific mandate

Parameters:

mandateId - String The unique identifier of the mandate. (required)

Returns:

Mandate

Throws:

ApiException - if fails to make API call

IOException

getMandateById

public Mandate getMandateById(String mandateId,
                              RequestOptions requestOptions)
                       throws ApiException,
                              IOException

Get a specific mandate

Parameters:

mandateId - String The unique identifier of the mandate. (required)

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

Returns:

Mandate

Throws:

ApiException - if fails to make API call

IOException

updateMandate

public void updateMandate(String mandateId,
                          MandateUpdate mandateUpdate)
                   throws ApiException,
                          IOException

Amend a mandate

Parameters:

mandateId - String The unique identifier of the mandate. (required)

mandateUpdate - MandateUpdate (required)

Throws:

ApiException - if fails to make API call

IOException

updateMandate

public void updateMandate(String mandateId,
                          MandateUpdate mandateUpdate,
                          RequestOptions requestOptions)
                   throws ApiException,
                          IOException

Amend a mandate

Parameters:

mandateId - String The unique identifier of the mandate. (required)

mandateUpdate - MandateUpdate (required)

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

Throws:

ApiException - if fails to make API call

IOException