Package com.adyen.service.checkout

Class ModificationsApi

java.lang.Object

com.adyen.Service

com.adyen.service.checkout.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
StandalonePaymentCancelResponse	cancelAuthorisedPayment(StandalonePaymentCancelRequest standalonePaymentCancelRequest)	Cancel an authorised payment
StandalonePaymentCancelResponse	cancelAuthorisedPayment(StandalonePaymentCancelRequest standalonePaymentCancelRequest, RequestOptions requestOptions)	Cancel an authorised payment
PaymentCancelResponse	cancelAuthorisedPaymentByPspReference(String paymentPspReference, PaymentCancelRequest paymentCancelRequest)	Cancel an authorised payment
PaymentCancelResponse	cancelAuthorisedPaymentByPspReference(String paymentPspReference, PaymentCancelRequest paymentCancelRequest, RequestOptions requestOptions)	Cancel an authorised payment
PaymentCaptureResponse	captureAuthorisedPayment(String paymentPspReference, PaymentCaptureRequest paymentCaptureRequest)	Capture an authorised payment
PaymentCaptureResponse	captureAuthorisedPayment(String paymentPspReference, PaymentCaptureRequest paymentCaptureRequest, RequestOptions requestOptions)	Capture an authorised payment
PaymentRefundResponse	refundCapturedPayment(String paymentPspReference, PaymentRefundRequest paymentRefundRequest)	Refund a captured payment
PaymentRefundResponse	refundCapturedPayment(String paymentPspReference, PaymentRefundRequest paymentRefundRequest, RequestOptions requestOptions)	Refund a captured payment
PaymentReversalResponse	refundOrCancelPayment(String paymentPspReference, PaymentReversalRequest paymentReversalRequest)	Refund or cancel a payment
PaymentReversalResponse	refundOrCancelPayment(String paymentPspReference, PaymentReversalRequest paymentReversalRequest, RequestOptions requestOptions)	Refund or cancel a payment
PaymentAmountUpdateResponse	updateAuthorisedAmount(String paymentPspReference, PaymentAmountUpdateRequest paymentAmountUpdateRequest)	Update an authorised amount
PaymentAmountUpdateResponse	updateAuthorisedAmount(String paymentPspReference, PaymentAmountUpdateRequest paymentAmountUpdateRequest, RequestOptions requestOptions)	Update an authorised amount

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

cancelAuthorisedPayment

public StandalonePaymentCancelResponse cancelAuthorisedPayment(StandalonePaymentCancelRequest standalonePaymentCancelRequest)
                                                        throws ApiException,
                                                               IOException

Cancel an authorised payment

Parameters:

standalonePaymentCancelRequest - StandalonePaymentCancelRequest (required)

Returns:

StandalonePaymentCancelResponse

Throws:

ApiException - if fails to make API call

IOException

cancelAuthorisedPayment

public StandalonePaymentCancelResponse cancelAuthorisedPayment(StandalonePaymentCancelRequest standalonePaymentCancelRequest,
                                                               RequestOptions requestOptions)
                                                        throws ApiException,
                                                               IOException

Cancel an authorised payment

Parameters:

standalonePaymentCancelRequest - StandalonePaymentCancelRequest (required)

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

Returns:

StandalonePaymentCancelResponse

Throws:

ApiException - if fails to make API call

IOException

cancelAuthorisedPaymentByPspReference

public PaymentCancelResponse cancelAuthorisedPaymentByPspReference(String paymentPspReference,
                                                                   PaymentCancelRequest paymentCancelRequest)
                                                            throws ApiException,
                                                                   IOException

Cancel an authorised payment

Parameters:

paymentPspReference - String The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to cancel. (required)

paymentCancelRequest - PaymentCancelRequest (required)

Returns:

PaymentCancelResponse

Throws:

ApiException - if fails to make API call

IOException

cancelAuthorisedPaymentByPspReference

public PaymentCancelResponse cancelAuthorisedPaymentByPspReference(String paymentPspReference,
                                                                   PaymentCancelRequest paymentCancelRequest,
                                                                   RequestOptions requestOptions)
                                                            throws ApiException,
                                                                   IOException

Cancel an authorised payment

Parameters:

paymentPspReference - String The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to cancel. (required)

paymentCancelRequest - PaymentCancelRequest (required)

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

Returns:

PaymentCancelResponse

Throws:

ApiException - if fails to make API call

IOException

captureAuthorisedPayment

public PaymentCaptureResponse captureAuthorisedPayment(String paymentPspReference,
                                                       PaymentCaptureRequest paymentCaptureRequest)
                                                throws ApiException,
                                                       IOException

Capture an authorised payment

Parameters:

paymentPspReference - String The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to capture. (required)

paymentCaptureRequest - PaymentCaptureRequest (required)

Returns:

PaymentCaptureResponse

Throws:

ApiException - if fails to make API call

IOException

captureAuthorisedPayment

public PaymentCaptureResponse captureAuthorisedPayment(String paymentPspReference,
                                                       PaymentCaptureRequest paymentCaptureRequest,
                                                       RequestOptions requestOptions)
                                                throws ApiException,
                                                       IOException

Capture an authorised payment

Parameters:

paymentPspReference - String The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to capture. (required)

paymentCaptureRequest - PaymentCaptureRequest (required)

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

Returns:

PaymentCaptureResponse

Throws:

ApiException - if fails to make API call

IOException

refundCapturedPayment

public PaymentRefundResponse refundCapturedPayment(String paymentPspReference,
                                                   PaymentRefundRequest paymentRefundRequest)
                                            throws ApiException,
                                                   IOException

Refund a captured payment

Parameters:

paymentPspReference - String The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to refund. (required)

paymentRefundRequest - PaymentRefundRequest (required)

Returns:

PaymentRefundResponse

Throws:

ApiException - if fails to make API call

IOException

refundCapturedPayment

public PaymentRefundResponse refundCapturedPayment(String paymentPspReference,
                                                   PaymentRefundRequest paymentRefundRequest,
                                                   RequestOptions requestOptions)
                                            throws ApiException,
                                                   IOException

Refund a captured payment

Parameters:

paymentPspReference - String The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to refund. (required)

paymentRefundRequest - PaymentRefundRequest (required)

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

Returns:

PaymentRefundResponse

Throws:

ApiException - if fails to make API call

IOException

refundOrCancelPayment

public PaymentReversalResponse refundOrCancelPayment(String paymentPspReference,
                                                     PaymentReversalRequest paymentReversalRequest)
                                              throws ApiException,
                                                     IOException

Refund or cancel a payment

Parameters:

paymentPspReference - String The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to reverse. (required)

paymentReversalRequest - PaymentReversalRequest (required)

Returns:

PaymentReversalResponse

Throws:

ApiException - if fails to make API call

IOException

refundOrCancelPayment

public PaymentReversalResponse refundOrCancelPayment(String paymentPspReference,
                                                     PaymentReversalRequest paymentReversalRequest,
                                                     RequestOptions requestOptions)
                                              throws ApiException,
                                                     IOException

Refund or cancel a payment

Parameters:

paymentPspReference - String The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to reverse. (required)

paymentReversalRequest - PaymentReversalRequest (required)

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

Returns:

PaymentReversalResponse

Throws:

ApiException - if fails to make API call

IOException

updateAuthorisedAmount

public PaymentAmountUpdateResponse updateAuthorisedAmount(String paymentPspReference,
                                                          PaymentAmountUpdateRequest paymentAmountUpdateRequest)
                                                   throws ApiException,
                                                          IOException

Update an authorised amount

Parameters:

paymentPspReference - String The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment. (required)

paymentAmountUpdateRequest - PaymentAmountUpdateRequest (required)

Returns:

PaymentAmountUpdateResponse

Throws:

ApiException - if fails to make API call

IOException

updateAuthorisedAmount

public PaymentAmountUpdateResponse updateAuthorisedAmount(String paymentPspReference,
                                                          PaymentAmountUpdateRequest paymentAmountUpdateRequest,
                                                          RequestOptions requestOptions)
                                                   throws ApiException,
                                                          IOException

Update an authorised amount

Parameters:

paymentPspReference - String The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment. (required)

paymentAmountUpdateRequest - PaymentAmountUpdateRequest (required)

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

Returns:

PaymentAmountUpdateResponse

Throws:

ApiException - if fails to make API call

IOException