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 inherited from class com.adyen.Service

GSON

Constructor Summary

Constructors

Constructor	Description
ModificationsApi(Client client)

Method Summary

Modifier and Type	Method	Description
StandalonePaymentCancelResource	cancelAuthorisedPayment(CreateStandalonePaymentCancelRequest createStandalonePaymentCancelRequest)	Cancel an authorised payment
StandalonePaymentCancelResource	cancelAuthorisedPayment(CreateStandalonePaymentCancelRequest createStandalonePaymentCancelRequest, RequestOptions requestOptions)	Cancel an authorised payment
PaymentCancelResource	cancelAuthorisedPaymentByPspReference(String paymentPspReference, CreatePaymentCancelRequest createPaymentCancelRequest)	Cancel an authorised payment
PaymentCancelResource	cancelAuthorisedPaymentByPspReference(String paymentPspReference, CreatePaymentCancelRequest createPaymentCancelRequest, RequestOptions requestOptions)	Cancel an authorised payment
PaymentCaptureResource	captureAuthorisedPayment(String paymentPspReference, CreatePaymentCaptureRequest createPaymentCaptureRequest)	Capture an authorised payment
PaymentCaptureResource	captureAuthorisedPayment(String paymentPspReference, CreatePaymentCaptureRequest createPaymentCaptureRequest, RequestOptions requestOptions)	Capture an authorised payment
PaymentRefundResource	refundCapturedPayment(String paymentPspReference, CreatePaymentRefundRequest createPaymentRefundRequest)	Refund a captured payment
PaymentRefundResource	refundCapturedPayment(String paymentPspReference, CreatePaymentRefundRequest createPaymentRefundRequest, RequestOptions requestOptions)	Refund a captured payment
PaymentReversalResource	refundOrCancelPayment(String paymentPspReference, CreatePaymentReversalRequest createPaymentReversalRequest)	Refund or cancel a payment
PaymentReversalResource	refundOrCancelPayment(String paymentPspReference, CreatePaymentReversalRequest createPaymentReversalRequest, RequestOptions requestOptions)	Refund or cancel a payment
PaymentAmountUpdateResource	updateAuthorisedAmount(String paymentPspReference, CreatePaymentAmountUpdateRequest createPaymentAmountUpdateRequest)	Update an authorised amount
PaymentAmountUpdateResource	updateAuthorisedAmount(String paymentPspReference, CreatePaymentAmountUpdateRequest createPaymentAmountUpdateRequest, 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

Constructor Detail

ModificationsApi

public ModificationsApi(Client client)

Method Detail

cancelAuthorisedPayment

public StandalonePaymentCancelResource cancelAuthorisedPayment(CreateStandalonePaymentCancelRequest createStandalonePaymentCancelRequest)
                                                        throws ApiException,
                                                               IOException

Cancel an authorised payment

Parameters:

createStandalonePaymentCancelRequest - CreateStandalonePaymentCancelRequest (required)

Returns:

StandalonePaymentCancelResource

Throws:

ApiException - if fails to make API call

IOException

cancelAuthorisedPayment

public StandalonePaymentCancelResource cancelAuthorisedPayment(CreateStandalonePaymentCancelRequest createStandalonePaymentCancelRequest,
                                                               RequestOptions requestOptions)
                                                        throws ApiException,
                                                               IOException

Cancel an authorised payment

Parameters:

createStandalonePaymentCancelRequest - CreateStandalonePaymentCancelRequest (required)

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

Returns:

StandalonePaymentCancelResource

Throws:

ApiException - if fails to make API call

IOException

updateAuthorisedAmount

public PaymentAmountUpdateResource updateAuthorisedAmount(String paymentPspReference,
                                                          CreatePaymentAmountUpdateRequest createPaymentAmountUpdateRequest)
                                                   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)

createPaymentAmountUpdateRequest - CreatePaymentAmountUpdateRequest (required)

Returns:

PaymentAmountUpdateResource

Throws:

ApiException - if fails to make API call

IOException

updateAuthorisedAmount

public PaymentAmountUpdateResource updateAuthorisedAmount(String paymentPspReference,
                                                          CreatePaymentAmountUpdateRequest createPaymentAmountUpdateRequest,
                                                          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)

createPaymentAmountUpdateRequest - CreatePaymentAmountUpdateRequest (required)

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

Returns:

PaymentAmountUpdateResource

Throws:

ApiException - if fails to make API call

IOException

cancelAuthorisedPaymentByPspReference

public PaymentCancelResource cancelAuthorisedPaymentByPspReference(String paymentPspReference,
                                                                   CreatePaymentCancelRequest createPaymentCancelRequest)
                                                            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)

createPaymentCancelRequest - CreatePaymentCancelRequest (required)

Returns:

PaymentCancelResource

Throws:

ApiException - if fails to make API call

IOException

cancelAuthorisedPaymentByPspReference

public PaymentCancelResource cancelAuthorisedPaymentByPspReference(String paymentPspReference,
                                                                   CreatePaymentCancelRequest createPaymentCancelRequest,
                                                                   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)

createPaymentCancelRequest - CreatePaymentCancelRequest (required)

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

Returns:

PaymentCancelResource

Throws:

ApiException - if fails to make API call

IOException

captureAuthorisedPayment

public PaymentCaptureResource captureAuthorisedPayment(String paymentPspReference,
                                                       CreatePaymentCaptureRequest createPaymentCaptureRequest)
                                                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)

createPaymentCaptureRequest - CreatePaymentCaptureRequest (required)

Returns:

PaymentCaptureResource

Throws:

ApiException - if fails to make API call

IOException

captureAuthorisedPayment

public PaymentCaptureResource captureAuthorisedPayment(String paymentPspReference,
                                                       CreatePaymentCaptureRequest createPaymentCaptureRequest,
                                                       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)

createPaymentCaptureRequest - CreatePaymentCaptureRequest (required)

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

Returns:

PaymentCaptureResource

Throws:

ApiException - if fails to make API call

IOException

refundCapturedPayment

public PaymentRefundResource refundCapturedPayment(String paymentPspReference,
                                                   CreatePaymentRefundRequest createPaymentRefundRequest)
                                            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)

createPaymentRefundRequest - CreatePaymentRefundRequest (required)

Returns:

PaymentRefundResource

Throws:

ApiException - if fails to make API call

IOException

refundCapturedPayment

public PaymentRefundResource refundCapturedPayment(String paymentPspReference,
                                                   CreatePaymentRefundRequest createPaymentRefundRequest,
                                                   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)

createPaymentRefundRequest - CreatePaymentRefundRequest (required)

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

Returns:

PaymentRefundResource

Throws:

ApiException - if fails to make API call

IOException

refundOrCancelPayment

public PaymentReversalResource refundOrCancelPayment(String paymentPspReference,
                                                     CreatePaymentReversalRequest createPaymentReversalRequest)
                                              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)

createPaymentReversalRequest - CreatePaymentReversalRequest (required)

Returns:

PaymentReversalResource

Throws:

ApiException - if fails to make API call

IOException

refundOrCancelPayment

public PaymentReversalResource refundOrCancelPayment(String paymentPspReference,
                                                     CreatePaymentReversalRequest createPaymentReversalRequest,
                                                     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)

createPaymentReversalRequest - CreatePaymentReversalRequest (required)

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

Returns:

PaymentReversalResource

Throws:

ApiException - if fails to make API call

IOException