Package com.adyen.service.payment

Class ModificationsApi

java.lang.Object

com.adyen.Service

com.adyen.service.payment.ModificationsApi

public class ModificationsApi
extends Service

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_VERSION
protected String	baseURL

Constructor Summary

Constructors

Constructor	Description
ModificationsApi(Client client)	Modifications constructor in package.
ModificationsApi(Client client, String baseURL)	Modifications constructor in package.

Method Summary

Modifier and Type	Method	Description
ModificationResult	adjustAuthorisation(AdjustAuthorisationRequest adjustAuthorisationRequest)	Change the authorised amount
ModificationResult	adjustAuthorisation(AdjustAuthorisationRequest adjustAuthorisationRequest, RequestOptions requestOptions)	Change the authorised amount
ModificationResult	cancel(CancelRequest cancelRequest)	Cancel an authorisation
ModificationResult	cancel(CancelRequest cancelRequest, RequestOptions requestOptions)	Cancel an authorisation
ModificationResult	cancelOrRefund(CancelOrRefundRequest cancelOrRefundRequest)	Cancel or refund a payment
ModificationResult	cancelOrRefund(CancelOrRefundRequest cancelOrRefundRequest, RequestOptions requestOptions)	Cancel or refund a payment
ModificationResult	capture(CaptureRequest captureRequest)	Capture an authorisation
ModificationResult	capture(CaptureRequest captureRequest, RequestOptions requestOptions)	Capture an authorisation
ModificationResult	donate(DonationRequest donationRequest)	Deprecated.
ModificationResult	donate(DonationRequest donationRequest, RequestOptions requestOptions)	Deprecated.
ModificationResult	refund(RefundRequest refundRequest)	Refund a captured payment
ModificationResult	refund(RefundRequest refundRequest, RequestOptions requestOptions)	Refund a captured payment
ModificationResult	technicalCancel(TechnicalCancelRequest technicalCancelRequest)	Cancel an authorisation using your reference
ModificationResult	technicalCancel(TechnicalCancelRequest technicalCancelRequest, RequestOptions requestOptions)	Cancel an authorisation using your reference
ModificationResult	voidPendingRefund(VoidPendingRefundRequest voidPendingRefundRequest)	Cancel an in-person refund
ModificationResult	voidPendingRefund(VoidPendingRefundRequest voidPendingRefundRequest, RequestOptions requestOptions)	Cancel an in-person refund

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

ModificationsApi

public ModificationsApi(Client client)

Modifications constructor in package.

Parameters:

client - Client (required)

ModificationsApi

public ModificationsApi(Client client,
                        String baseURL)

Modifications 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

adjustAuthorisation

public ModificationResult adjustAuthorisation(AdjustAuthorisationRequest adjustAuthorisationRequest)
                                       throws ApiException,
                                              IOException

Change the authorised amount

Parameters:

adjustAuthorisationRequest - AdjustAuthorisationRequest (required)

Returns:

ModificationResult

Throws:

ApiException - if fails to make API call

IOException

adjustAuthorisation

public ModificationResult adjustAuthorisation(AdjustAuthorisationRequest adjustAuthorisationRequest,
                                              RequestOptions requestOptions)
                                       throws ApiException,
                                              IOException

Change the authorised amount

Parameters:

adjustAuthorisationRequest - AdjustAuthorisationRequest (required)

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

Returns:

ModificationResult

Throws:

ApiException - if fails to make API call

IOException

cancel

public ModificationResult cancel(CancelRequest cancelRequest)
                          throws ApiException,
                                 IOException

Cancel an authorisation

Parameters:

cancelRequest - CancelRequest (required)

Returns:

ModificationResult

Throws:

ApiException - if fails to make API call

IOException

cancel

public ModificationResult cancel(CancelRequest cancelRequest,
                                 RequestOptions requestOptions)
                          throws ApiException,
                                 IOException

Cancel an authorisation

Parameters:

cancelRequest - CancelRequest (required)

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

Returns:

ModificationResult

Throws:

ApiException - if fails to make API call

IOException

cancelOrRefund

public ModificationResult cancelOrRefund(CancelOrRefundRequest cancelOrRefundRequest)
                                  throws ApiException,
                                         IOException

Cancel or refund a payment

Parameters:

cancelOrRefundRequest - CancelOrRefundRequest (required)

Returns:

ModificationResult

Throws:

ApiException - if fails to make API call

IOException

cancelOrRefund

public ModificationResult cancelOrRefund(CancelOrRefundRequest cancelOrRefundRequest,
                                         RequestOptions requestOptions)
                                  throws ApiException,
                                         IOException

Cancel or refund a payment

Parameters:

cancelOrRefundRequest - CancelOrRefundRequest (required)

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

Returns:

ModificationResult

Throws:

ApiException - if fails to make API call

IOException

capture

public ModificationResult capture(CaptureRequest captureRequest)
                           throws ApiException,
                                  IOException

Capture an authorisation

Parameters:

captureRequest - CaptureRequest (required)

Returns:

ModificationResult

Throws:

ApiException - if fails to make API call

IOException

capture

public ModificationResult capture(CaptureRequest captureRequest,
                                  RequestOptions requestOptions)
                           throws ApiException,
                                  IOException

Capture an authorisation

Parameters:

captureRequest - CaptureRequest (required)

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

Returns:

ModificationResult

Throws:

ApiException - if fails to make API call

IOException

donate

@Deprecated
public ModificationResult donate(DonationRequest donationRequest)
                          throws ApiException,
                                 IOException

Deprecated.

Create a donation

Parameters:

donationRequest - DonationRequest (required)

Returns:

ModificationResult

Throws:

ApiException - if fails to make API call

IOException

donate

@Deprecated
public ModificationResult donate(DonationRequest donationRequest,
                                 RequestOptions requestOptions)
                          throws ApiException,
                                 IOException

Deprecated.

Create a donation

Parameters:

donationRequest - DonationRequest (required)

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

Returns:

ModificationResult

Throws:

ApiException - if fails to make API call

IOException

refund

public ModificationResult refund(RefundRequest refundRequest)
                          throws ApiException,
                                 IOException

Refund a captured payment

Parameters:

refundRequest - RefundRequest (required)

Returns:

ModificationResult

Throws:

ApiException - if fails to make API call

IOException

refund

public ModificationResult refund(RefundRequest refundRequest,
                                 RequestOptions requestOptions)
                          throws ApiException,
                                 IOException

Refund a captured payment

Parameters:

refundRequest - RefundRequest (required)

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

Returns:

ModificationResult

Throws:

ApiException - if fails to make API call

IOException

technicalCancel

public ModificationResult technicalCancel(TechnicalCancelRequest technicalCancelRequest)
                                   throws ApiException,
                                          IOException

Cancel an authorisation using your reference

Parameters:

technicalCancelRequest - TechnicalCancelRequest (required)

Returns:

ModificationResult

Throws:

ApiException - if fails to make API call

IOException

technicalCancel

public ModificationResult technicalCancel(TechnicalCancelRequest technicalCancelRequest,
                                          RequestOptions requestOptions)
                                   throws ApiException,
                                          IOException

Cancel an authorisation using your reference

Parameters:

technicalCancelRequest - TechnicalCancelRequest (required)

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

Returns:

ModificationResult

Throws:

ApiException - if fails to make API call

IOException

voidPendingRefund

public ModificationResult voidPendingRefund(VoidPendingRefundRequest voidPendingRefundRequest)
                                     throws ApiException,
                                            IOException

Cancel an in-person refund

Parameters:

voidPendingRefundRequest - VoidPendingRefundRequest (required)

Returns:

ModificationResult

Throws:

ApiException - if fails to make API call

IOException

voidPendingRefund

public ModificationResult voidPendingRefund(VoidPendingRefundRequest voidPendingRefundRequest,
                                            RequestOptions requestOptions)
                                     throws ApiException,
                                            IOException

Cancel an in-person refund

Parameters:

voidPendingRefundRequest - VoidPendingRefundRequest (required)

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

Returns:

ModificationResult

Throws:

ApiException - if fails to make API call

IOException