Package com.adyen.service

Class PaymentApi

java.lang.Object

com.adyen.Service

com.adyen.service.PaymentApi

@Deprecated(since="v37.0.0",
            forRemoval=true)
public class PaymentApi
extends Service

Deprecated, for removal: This API element is subject to removal in a future version.

Use instead PaymentsApi and ModificationsApi in the com.adyen.service.payment package

This class is deprecated and NO LONGER updated

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_VERSION	Deprecated, for removal: This API element is subject to removal in a future version.
protected String	baseURL	Deprecated, for removal: This API element is subject to removal in a future version.

Constructor Summary

Constructors

Constructor	Description
PaymentApi(Client client)	Deprecated, for removal: This API element is subject to removal in a future version.
PaymentApi(Client client, String baseURL)	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
ModificationResult	adjustAuthorisation(AdjustAuthorisationRequest adjustAuthorisationRequest)	Deprecated, for removal: This API element is subject to removal in a future version.
ModificationResult	adjustAuthorisation(AdjustAuthorisationRequest adjustAuthorisationRequest, RequestOptions requestOptions)	Deprecated, for removal: This API element is subject to removal in a future version.
PaymentResult	authorise(PaymentRequest paymentRequest)	Deprecated, for removal: This API element is subject to removal in a future version.
PaymentResult	authorise(PaymentRequest paymentRequest, RequestOptions requestOptions)	Deprecated, for removal: This API element is subject to removal in a future version.
PaymentResult	authorise3d(PaymentRequest3d paymentRequest3d)	Deprecated, for removal: This API element is subject to removal in a future version.
PaymentResult	authorise3d(PaymentRequest3d paymentRequest3d, RequestOptions requestOptions)	Deprecated, for removal: This API element is subject to removal in a future version.
PaymentResult	authorise3ds2(PaymentRequest3ds2 paymentRequest3ds2)	Deprecated, for removal: This API element is subject to removal in a future version.
PaymentResult	authorise3ds2(PaymentRequest3ds2 paymentRequest3ds2, RequestOptions requestOptions)	Deprecated, for removal: This API element is subject to removal in a future version.
ModificationResult	cancel(CancelRequest cancelRequest)	Deprecated, for removal: This API element is subject to removal in a future version.
ModificationResult	cancel(CancelRequest cancelRequest, RequestOptions requestOptions)	Deprecated, for removal: This API element is subject to removal in a future version.
ModificationResult	cancelOrRefund(CancelOrRefundRequest cancelOrRefundRequest)	Deprecated, for removal: This API element is subject to removal in a future version.
ModificationResult	cancelOrRefund(CancelOrRefundRequest cancelOrRefundRequest, RequestOptions requestOptions)	Deprecated, for removal: This API element is subject to removal in a future version.
ModificationResult	capture(CaptureRequest captureRequest)	Deprecated, for removal: This API element is subject to removal in a future version.
ModificationResult	capture(CaptureRequest captureRequest, RequestOptions requestOptions)	Deprecated, for removal: This API element is subject to removal in a future version.
ModificationResult	donate(DonationRequest donationRequest)	Deprecated. // Use Checkout donations instead
ModificationResult	donate(DonationRequest donationRequest, RequestOptions requestOptions)	Deprecated. // Use Checkout donations instead
AuthenticationResultResponse	getAuthenticationResult(AuthenticationResultRequest authenticationResultRequest)	Deprecated, for removal: This API element is subject to removal in a future version.
AuthenticationResultResponse	getAuthenticationResult(AuthenticationResultRequest authenticationResultRequest, RequestOptions requestOptions)	Deprecated, for removal: This API element is subject to removal in a future version.
ModificationResult	refund(RefundRequest refundRequest)	Deprecated, for removal: This API element is subject to removal in a future version.
ModificationResult	refund(RefundRequest refundRequest, RequestOptions requestOptions)	Deprecated, for removal: This API element is subject to removal in a future version.
ThreeDS2ResultResponse	retrieve3ds2Result(ThreeDS2ResultRequest threeDS2ResultRequest)	Deprecated, for removal: This API element is subject to removal in a future version.
ThreeDS2ResultResponse	retrieve3ds2Result(ThreeDS2ResultRequest threeDS2ResultRequest, RequestOptions requestOptions)	Deprecated, for removal: This API element is subject to removal in a future version.
ModificationResult	technicalCancel(TechnicalCancelRequest technicalCancelRequest)	Deprecated, for removal: This API element is subject to removal in a future version.
ModificationResult	technicalCancel(TechnicalCancelRequest technicalCancelRequest, RequestOptions requestOptions)	Deprecated, for removal: This API element is subject to removal in a future version.
ModificationResult	voidPendingRefund(VoidPendingRefundRequest voidPendingRefundRequest)	Deprecated, for removal: This API element is subject to removal in a future version.
ModificationResult	voidPendingRefund(VoidPendingRefundRequest voidPendingRefundRequest, RequestOptions requestOptions)	Deprecated, for removal: This API element is subject to removal in a future version.

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

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

Constant Field Values

baseURL

protected String baseURL

Deprecated, for removal: This API element is subject to removal in a future version.

Constructor Detail

PaymentApi

@Deprecated(since="v37.0.0",
            forRemoval=true)
public PaymentApi(Client client)

Deprecated, for removal: This API element is subject to removal in a future version.

Default constructor in package.

Parameters:

client - Client (required)

PaymentApi

@Deprecated(since="v37.0.0",
            forRemoval=true)
public PaymentApi(Client client,
                  String baseURL)

Deprecated, for removal: This API element is subject to removal in a future version.

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

adjustAuthorisation

@Deprecated(since="v37.0.0",
            forRemoval=true)
public ModificationResult adjustAuthorisation(AdjustAuthorisationRequest adjustAuthorisationRequest)
                                       throws ApiException,
                                              IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Change the authorised amount

Parameters:

adjustAuthorisationRequest - AdjustAuthorisationRequest (required)

Returns:

ModificationResult

Throws:

ApiException - if fails to make API call

IOException

adjustAuthorisation

@Deprecated(since="v37.0.0",
            forRemoval=true)
public ModificationResult adjustAuthorisation(AdjustAuthorisationRequest adjustAuthorisationRequest,
                                              RequestOptions requestOptions)
                                       throws ApiException,
                                              IOException

Deprecated, for removal: This API element is subject to removal in a future version.

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

authorise

@Deprecated(since="v37.0.0",
            forRemoval=true)
public PaymentResult authorise(PaymentRequest paymentRequest)
                        throws ApiException,
                               IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Create an authorisation

Parameters:

paymentRequest - PaymentRequest (required)

Returns:

PaymentResult

Throws:

ApiException - if fails to make API call

IOException

authorise

@Deprecated(since="v37.0.0",
            forRemoval=true)
public PaymentResult authorise(PaymentRequest paymentRequest,
                               RequestOptions requestOptions)
                        throws ApiException,
                               IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Create an authorisation

Parameters:

paymentRequest - PaymentRequest (required)

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

Returns:

PaymentResult

Throws:

ApiException - if fails to make API call

IOException

authorise3d

@Deprecated(since="v37.0.0",
            forRemoval=true)
public PaymentResult authorise3d(PaymentRequest3d paymentRequest3d)
                          throws ApiException,
                                 IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Complete a 3DS authorisation

Parameters:

paymentRequest3d - PaymentRequest3d (required)

Returns:

PaymentResult

Throws:

ApiException - if fails to make API call

IOException

authorise3d

@Deprecated(since="v37.0.0",
            forRemoval=true)
public PaymentResult authorise3d(PaymentRequest3d paymentRequest3d,
                                 RequestOptions requestOptions)
                          throws ApiException,
                                 IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Complete a 3DS authorisation

Parameters:

paymentRequest3d - PaymentRequest3d (required)

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

Returns:

PaymentResult

Throws:

ApiException - if fails to make API call

IOException

authorise3ds2

@Deprecated(since="v37.0.0",
            forRemoval=true)
public PaymentResult authorise3ds2(PaymentRequest3ds2 paymentRequest3ds2)
                            throws ApiException,
                                   IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Complete a 3DS2 authorisation

Parameters:

paymentRequest3ds2 - PaymentRequest3ds2 (required)

Returns:

PaymentResult

Throws:

ApiException - if fails to make API call

IOException

authorise3ds2

@Deprecated(since="v37.0.0",
            forRemoval=true)
public PaymentResult authorise3ds2(PaymentRequest3ds2 paymentRequest3ds2,
                                   RequestOptions requestOptions)
                            throws ApiException,
                                   IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Complete a 3DS2 authorisation

Parameters:

paymentRequest3ds2 - PaymentRequest3ds2 (required)

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

Returns:

PaymentResult

Throws:

ApiException - if fails to make API call

IOException

cancel

@Deprecated(since="v37.0.0",
            forRemoval=true)
public ModificationResult cancel(CancelRequest cancelRequest)
                          throws ApiException,
                                 IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Cancel an authorisation

Parameters:

cancelRequest - CancelRequest (required)

Returns:

ModificationResult

Throws:

ApiException - if fails to make API call

IOException

cancel

@Deprecated(since="v37.0.0",
            forRemoval=true)
public ModificationResult cancel(CancelRequest cancelRequest,
                                 RequestOptions requestOptions)
                          throws ApiException,
                                 IOException

Deprecated, for removal: This API element is subject to removal in a future version.

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

@Deprecated(since="v37.0.0",
            forRemoval=true)
public ModificationResult cancelOrRefund(CancelOrRefundRequest cancelOrRefundRequest)
                                  throws ApiException,
                                         IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Cancel or refund a payment

Parameters:

cancelOrRefundRequest - CancelOrRefundRequest (required)

Returns:

ModificationResult

Throws:

ApiException - if fails to make API call

IOException

cancelOrRefund

@Deprecated(since="v37.0.0",
            forRemoval=true)
public ModificationResult cancelOrRefund(CancelOrRefundRequest cancelOrRefundRequest,
                                         RequestOptions requestOptions)
                                  throws ApiException,
                                         IOException

Deprecated, for removal: This API element is subject to removal in a future version.

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

@Deprecated(since="v37.0.0",
            forRemoval=true)
public ModificationResult capture(CaptureRequest captureRequest)
                           throws ApiException,
                                  IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Capture an authorisation

Parameters:

captureRequest - CaptureRequest (required)

Returns:

ModificationResult

Throws:

ApiException - if fails to make API call

IOException

capture

@Deprecated(since="v37.0.0",
            forRemoval=true)
public ModificationResult capture(CaptureRequest captureRequest,
                                  RequestOptions requestOptions)
                           throws ApiException,
                                  IOException

Deprecated, for removal: This API element is subject to removal in a future version.

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.

// Use Checkout donations instead

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.

// Use Checkout donations instead

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

getAuthenticationResult

@Deprecated(since="v37.0.0",
            forRemoval=true)
public AuthenticationResultResponse getAuthenticationResult(AuthenticationResultRequest authenticationResultRequest)
                                                     throws ApiException,
                                                            IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Get the 3DS authentication result

Parameters:

authenticationResultRequest - AuthenticationResultRequest (required)

Returns:

AuthenticationResultResponse

Throws:

ApiException - if fails to make API call

IOException

getAuthenticationResult

@Deprecated(since="v37.0.0",
            forRemoval=true)
public AuthenticationResultResponse getAuthenticationResult(AuthenticationResultRequest authenticationResultRequest,
                                                            RequestOptions requestOptions)
                                                     throws ApiException,
                                                            IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Get the 3DS authentication result

Parameters:

authenticationResultRequest - AuthenticationResultRequest (required)

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

Returns:

AuthenticationResultResponse

Throws:

ApiException - if fails to make API call

IOException

refund

@Deprecated(since="v37.0.0",
            forRemoval=true)
public ModificationResult refund(RefundRequest refundRequest)
                          throws ApiException,
                                 IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Refund a captured payment

Parameters:

refundRequest - RefundRequest (required)

Returns:

ModificationResult

Throws:

ApiException - if fails to make API call

IOException

refund

@Deprecated(since="v37.0.0",
            forRemoval=true)
public ModificationResult refund(RefundRequest refundRequest,
                                 RequestOptions requestOptions)
                          throws ApiException,
                                 IOException

Deprecated, for removal: This API element is subject to removal in a future version.

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

retrieve3ds2Result

@Deprecated(since="v37.0.0",
            forRemoval=true)
public ThreeDS2ResultResponse retrieve3ds2Result(ThreeDS2ResultRequest threeDS2ResultRequest)
                                          throws ApiException,
                                                 IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Get the 3DS2 authentication result

Parameters:

threeDS2ResultRequest - ThreeDS2ResultRequest (required)

Returns:

ThreeDS2ResultResponse

Throws:

ApiException - if fails to make API call

IOException

retrieve3ds2Result

@Deprecated(since="v37.0.0",
            forRemoval=true)
public ThreeDS2ResultResponse retrieve3ds2Result(ThreeDS2ResultRequest threeDS2ResultRequest,
                                                 RequestOptions requestOptions)
                                          throws ApiException,
                                                 IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Get the 3DS2 authentication result

Parameters:

threeDS2ResultRequest - ThreeDS2ResultRequest (required)

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

Returns:

ThreeDS2ResultResponse

Throws:

ApiException - if fails to make API call

IOException

technicalCancel

@Deprecated(since="v37.0.0",
            forRemoval=true)
public ModificationResult technicalCancel(TechnicalCancelRequest technicalCancelRequest)
                                   throws ApiException,
                                          IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Cancel an authorisation using your reference

Parameters:

technicalCancelRequest - TechnicalCancelRequest (required)

Returns:

ModificationResult

Throws:

ApiException - if fails to make API call

IOException

technicalCancel

@Deprecated(since="v37.0.0",
            forRemoval=true)
public ModificationResult technicalCancel(TechnicalCancelRequest technicalCancelRequest,
                                          RequestOptions requestOptions)
                                   throws ApiException,
                                          IOException

Deprecated, for removal: This API element is subject to removal in a future version.

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

@Deprecated(since="v37.0.0",
            forRemoval=true)
public ModificationResult voidPendingRefund(VoidPendingRefundRequest voidPendingRefundRequest)
                                     throws ApiException,
                                            IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Cancel an in-person refund

Parameters:

voidPendingRefundRequest - VoidPendingRefundRequest (required)

Returns:

ModificationResult

Throws:

ApiException - if fails to make API call

IOException

voidPendingRefund

@Deprecated(since="v37.0.0",
            forRemoval=true)
public ModificationResult voidPendingRefund(VoidPendingRefundRequest voidPendingRefundRequest,
                                            RequestOptions requestOptions)
                                     throws ApiException,
                                            IOException

Deprecated, for removal: This API element is subject to removal in a future version.

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