Package com.adyen.service.checkout

Class PaymentsApi

java.lang.Object

com.adyen.Service

com.adyen.service.checkout.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
CardDetailsResponse	cardDetails(CardDetailsRequest cardDetailsRequest)	Get the list of brands on the card
CardDetailsResponse	cardDetails(CardDetailsRequest cardDetailsRequest, RequestOptions requestOptions)	Get the list of brands on the card
SessionResultResponse	getResultOfPaymentSession(String sessionId, String sessionResult)	Get the result of a payment session
SessionResultResponse	getResultOfPaymentSession(String sessionId, String sessionResult, RequestOptions requestOptions)	Get the result of a payment session
PaymentMethodsResponse	paymentMethods(PaymentMethodsRequest paymentMethodsRequest)	Get a list of available payment methods
PaymentMethodsResponse	paymentMethods(PaymentMethodsRequest paymentMethodsRequest, RequestOptions requestOptions)	Get a list of available payment methods
PaymentResponse	payments(PaymentRequest paymentRequest)	Start a transaction
PaymentResponse	payments(PaymentRequest paymentRequest, RequestOptions requestOptions)	Start a transaction
PaymentDetailsResponse	paymentsDetails(PaymentDetailsRequest paymentDetailsRequest)	Submit details for a payment
PaymentDetailsResponse	paymentsDetails(PaymentDetailsRequest paymentDetailsRequest, RequestOptions requestOptions)	Submit details for a payment
CreateCheckoutSessionResponse	sessions(CreateCheckoutSessionRequest createCheckoutSessionRequest)	Create a payment session
CreateCheckoutSessionResponse	sessions(CreateCheckoutSessionRequest createCheckoutSessionRequest, RequestOptions requestOptions)	Create a payment session

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

cardDetails

public CardDetailsResponse cardDetails(CardDetailsRequest cardDetailsRequest)
                                throws ApiException,
                                       IOException

Get the list of brands on the card

Parameters:

cardDetailsRequest - CardDetailsRequest (required)

Returns:

CardDetailsResponse

Throws:

ApiException - if fails to make API call

IOException

cardDetails

public CardDetailsResponse cardDetails(CardDetailsRequest cardDetailsRequest,
                                       RequestOptions requestOptions)
                                throws ApiException,
                                       IOException

Get the list of brands on the card

Parameters:

cardDetailsRequest - CardDetailsRequest (required)

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

Returns:

CardDetailsResponse

Throws:

ApiException - if fails to make API call

IOException

getResultOfPaymentSession

public SessionResultResponse getResultOfPaymentSession(String sessionId,
                                                       String sessionResult)
                                                throws ApiException,
                                                       IOException

Get the result of a payment session

Parameters:

sessionId - String A unique identifier of the session. (required)

sessionResult - String The `sessionResult` value from the Drop-in or Component. (required)

Returns:

SessionResultResponse

Throws:

ApiException - if fails to make API call

IOException

getResultOfPaymentSession

public SessionResultResponse getResultOfPaymentSession(String sessionId,
                                                       String sessionResult,
                                                       RequestOptions requestOptions)
                                                throws ApiException,
                                                       IOException

Get the result of a payment session

Parameters:

sessionId - String A unique identifier of the session. (required)

sessionResult - String Query: The `sessionResult` value from the Drop-in or Component. (required)

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

Returns:

SessionResultResponse

Throws:

ApiException - if fails to make API call

IOException

paymentMethods

public PaymentMethodsResponse paymentMethods(PaymentMethodsRequest paymentMethodsRequest)
                                      throws ApiException,
                                             IOException

Get a list of available payment methods

Parameters:

paymentMethodsRequest - PaymentMethodsRequest (required)

Returns:

PaymentMethodsResponse

Throws:

ApiException - if fails to make API call

IOException

paymentMethods

public PaymentMethodsResponse paymentMethods(PaymentMethodsRequest paymentMethodsRequest,
                                             RequestOptions requestOptions)
                                      throws ApiException,
                                             IOException

Get a list of available payment methods

Parameters:

paymentMethodsRequest - PaymentMethodsRequest (required)

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

Returns:

PaymentMethodsResponse

Throws:

ApiException - if fails to make API call

IOException

payments

public PaymentResponse payments(PaymentRequest paymentRequest)
                         throws ApiException,
                                IOException

Start a transaction

Parameters:

paymentRequest - PaymentRequest (required)

Returns:

PaymentResponse

Throws:

ApiException - if fails to make API call

IOException

payments

public PaymentResponse payments(PaymentRequest paymentRequest,
                                RequestOptions requestOptions)
                         throws ApiException,
                                IOException

Start a transaction

Parameters:

paymentRequest - PaymentRequest (required)

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

Returns:

PaymentResponse

Throws:

ApiException - if fails to make API call

IOException

paymentsDetails

public PaymentDetailsResponse paymentsDetails(PaymentDetailsRequest paymentDetailsRequest)
                                       throws ApiException,
                                              IOException

Submit details for a payment

Parameters:

paymentDetailsRequest - PaymentDetailsRequest (required)

Returns:

PaymentDetailsResponse

Throws:

ApiException - if fails to make API call

IOException

paymentsDetails

public PaymentDetailsResponse paymentsDetails(PaymentDetailsRequest paymentDetailsRequest,
                                              RequestOptions requestOptions)
                                       throws ApiException,
                                              IOException

Submit details for a payment

Parameters:

paymentDetailsRequest - PaymentDetailsRequest (required)

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

Returns:

PaymentDetailsResponse

Throws:

ApiException - if fails to make API call

IOException

sessions

public CreateCheckoutSessionResponse sessions(CreateCheckoutSessionRequest createCheckoutSessionRequest)
                                       throws ApiException,
                                              IOException

Create a payment session

Parameters:

createCheckoutSessionRequest - CreateCheckoutSessionRequest (required)

Returns:

CreateCheckoutSessionResponse

Throws:

ApiException - if fails to make API call

IOException

sessions

public CreateCheckoutSessionResponse sessions(CreateCheckoutSessionRequest createCheckoutSessionRequest,
                                              RequestOptions requestOptions)
                                       throws ApiException,
                                              IOException

Create a payment session

Parameters:

createCheckoutSessionRequest - CreateCheckoutSessionRequest (required)

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

Returns:

CreateCheckoutSessionResponse

Throws:

ApiException - if fails to make API call

IOException