Package com.adyen.service.payment

Class PaymentsApi

java.lang.Object

com.adyen.Service

com.adyen.service.payment.PaymentsApi

public class PaymentsApi
extends Service

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_VERSION
protected String	baseURL

Constructor Summary

Constructors

Constructor	Description
PaymentsApi(Client client)	Payments constructor in package.
PaymentsApi(Client client, String baseURL)	Payments constructor in package.

Method Summary

Modifier and Type	Method	Description
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
AuthenticationResultResponse	getAuthenticationResult(AuthenticationResultRequest authenticationResultRequest)	Get the 3DS authentication result
AuthenticationResultResponse	getAuthenticationResult(AuthenticationResultRequest authenticationResultRequest, RequestOptions requestOptions)	Get the 3DS authentication result
ThreeDS2ResultResponse	retrieve3ds2Result(ThreeDS2ResultRequest threeDS2ResultRequest)	Get the 3DS2 authentication result
ThreeDS2ResultResponse	retrieve3ds2Result(ThreeDS2ResultRequest threeDS2ResultRequest, RequestOptions requestOptions)	Get the 3DS2 authentication result

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

PaymentsApi

public PaymentsApi(Client client)

Payments constructor in package.

Parameters:

client - Client (required)

PaymentsApi

public PaymentsApi(Client client,
                   String baseURL)

Payments 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

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

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

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