java.lang.Object
- com.adyen.Service
- - com.adyen.service.PaymentApi

```
public class PaymentApi
extends Service
```

Field Summary

Fields
Modifier and Type Field Description

static String API_VERSION

protected String baseURL

Constructor Summary

Constructors
Constructor	Description
`PaymentApi(Client client)`	Default constructor in `package`.
`PaymentApi(Client client, String baseURL)`	Alternative constructor in `package`.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`ModificationResult`	`adjustAuthorisation(AdjustAuthorisationRequest adjustAuthorisationRequest)`	Change the authorised amount
`ModificationResult`	`adjustAuthorisation(AdjustAuthorisationRequest adjustAuthorisationRequest, RequestOptions requestOptions)`	Change the authorised amount
`PaymentResult`	`authorise(PaymentRequest paymentRequest)`	Create an authorisation
`PaymentResult`	`authorise(PaymentRequest paymentRequest, RequestOptions requestOptions)`	Create an authorisation
`PaymentResult`	`authorise3d(PaymentRequest3d paymentRequest3d)`	Complete a 3DS authorisation
`PaymentResult`	`authorise3d(PaymentRequest3d paymentRequest3d, RequestOptions requestOptions)`	Complete a 3DS authorisation
`PaymentResult`	`authorise3ds2(PaymentRequest3ds2 paymentRequest3ds2)`	Complete a 3DS2 authorisation
`PaymentResult`	`authorise3ds2(PaymentRequest3ds2 paymentRequest3ds2, RequestOptions requestOptions)`	Complete a 3DS2 authorisation
`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.
`AuthenticationResultResponse`	`getAuthenticationResult(AuthenticationResultRequest authenticationResultRequest)`	Get the 3DS authentication result
`AuthenticationResultResponse`	`getAuthenticationResult(AuthenticationResultRequest authenticationResultRequest, RequestOptions requestOptions)`	Get the 3DS authentication result
`ModificationResult`	`refund(RefundRequest refundRequest)`	Refund a captured payment
`ModificationResult`	`refund(RefundRequest refundRequest, RequestOptions requestOptions)`	Refund a captured payment
`ThreeDS2ResultResponse`	`retrieve3ds2Result(ThreeDS2ResultRequest threeDS2ResultRequest)`	Get the 3DS2 authentication result
`ThreeDS2ResultResponse`	`retrieve3ds2Result(ThreeDS2ResultRequest threeDS2ResultRequest, RequestOptions requestOptions)`	Get the 3DS2 authentication result
`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
- PaymentApi
```
public PaymentApi(Client client)
```
  Default constructor in package.
  
  Parameters:
  
  client - Client (required)
- PaymentApi
```
public PaymentApi(Client client,
                  String baseURL)
```
  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

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

authorise

public PaymentResult authorise(PaymentRequest paymentRequest)
                        throws ApiException,
                               IOException

Create an authorisation

Parameters:: paymentRequest - PaymentRequest (required)
Returns:: PaymentResult
Throws:: ApiException - if fails to make API call; IOException

authorise

public PaymentResult authorise(PaymentRequest paymentRequest,
                               RequestOptions requestOptions)
                        throws ApiException,
                               IOException

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

public PaymentResult authorise3d(PaymentRequest3d paymentRequest3d)
                          throws ApiException,
                                 IOException

Complete a 3DS authorisation

Parameters:: paymentRequest3d - PaymentRequest3d (required)
Returns:: PaymentResult
Throws:: ApiException - if fails to make API call; IOException

authorise3d

public PaymentResult authorise3d(PaymentRequest3d paymentRequest3d,
                                 RequestOptions requestOptions)
                          throws ApiException,
                                 IOException

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

public PaymentResult authorise3ds2(PaymentRequest3ds2 paymentRequest3ds2)
                            throws ApiException,
                                   IOException

Complete a 3DS2 authorisation

Parameters:: paymentRequest3ds2 - PaymentRequest3ds2 (required)
Returns:: PaymentResult
Throws:: ApiException - if fails to make API call; IOException

authorise3ds2

public PaymentResult authorise3ds2(PaymentRequest3ds2 paymentRequest3ds2,
                                   RequestOptions requestOptions)
                            throws ApiException,
                                   IOException

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

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

getAuthenticationResult

public AuthenticationResultResponse getAuthenticationResult(AuthenticationResultRequest authenticationResultRequest)
                                                     throws ApiException,
                                                            IOException

Get the 3DS authentication result

Parameters:: authenticationResultRequest - AuthenticationResultRequest (required)
Returns:: AuthenticationResultResponse
Throws:: ApiException - if fails to make API call; IOException

getAuthenticationResult

public AuthenticationResultResponse getAuthenticationResult(AuthenticationResultRequest authenticationResultRequest,
                                                            RequestOptions requestOptions)
                                                     throws ApiException,
                                                            IOException

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

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

retrieve3ds2Result

public ThreeDS2ResultResponse retrieve3ds2Result(ThreeDS2ResultRequest threeDS2ResultRequest)
                                          throws ApiException,
                                                 IOException

Get the 3DS2 authentication result

Parameters:: threeDS2ResultRequest - ThreeDS2ResultRequest (required)
Returns:: ThreeDS2ResultResponse
Throws:: ApiException - if fails to make API call; IOException

retrieve3ds2Result

public ThreeDS2ResultResponse retrieve3ds2Result(ThreeDS2ResultRequest threeDS2ResultRequest,
                                                 RequestOptions requestOptions)
                                          throws ApiException,
                                                 IOException

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

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

Fields
Modifier and Type	Field	Description
`static String`	`API_VERSION`
`protected String`	`baseURL`

Class PaymentApi

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.adyen.Service

Methods inherited from class java.lang.Object

Field Detail

API_VERSION

baseURL

Constructor Detail

PaymentApi

PaymentApi

Method Detail

adjustAuthorisation

adjustAuthorisation

authorise

authorise

authorise3d

authorise3d

authorise3ds2

authorise3ds2

cancel

cancel

cancelOrRefund

cancelOrRefund

capture

capture

donate

donate

getAuthenticationResult

getAuthenticationResult

refund

refund

retrieve3ds2Result

retrieve3ds2Result

technicalCancel

technicalCancel

voidPendingRefund

voidPendingRefund