Package com.adyen.service.checkout

Class PaymentLinksApi

java.lang.Object

com.adyen.Service

com.adyen.service.checkout.PaymentLinksApi

public class PaymentLinksApi
extends Service

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_VERSION
protected String	baseURL

Constructor Summary

Constructors

Constructor	Description
PaymentLinksApi(Client client)	Payment links constructor in package.
PaymentLinksApi(Client client, String baseURL)	Payment links constructor in package.

Method Summary

Modifier and Type	Method	Description
PaymentLinkResponse	getPaymentLink(String linkId)	Get a payment link
PaymentLinkResponse	getPaymentLink(String linkId, RequestOptions requestOptions)	Get a payment link
PaymentLinkResponse	paymentLinks(PaymentLinkRequest paymentLinkRequest)	Create a payment link
PaymentLinkResponse	paymentLinks(PaymentLinkRequest paymentLinkRequest, RequestOptions requestOptions)	Create a payment link
PaymentLinkResponse	updatePaymentLink(String linkId, UpdatePaymentLinkRequest updatePaymentLinkRequest)	Update the status of a payment link
PaymentLinkResponse	updatePaymentLink(String linkId, UpdatePaymentLinkRequest updatePaymentLinkRequest, RequestOptions requestOptions)	Update the status of a payment link

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

PaymentLinksApi

public PaymentLinksApi(Client client)

Payment links constructor in package.

Parameters:

client - Client (required)

PaymentLinksApi

public PaymentLinksApi(Client client,
                       String baseURL)

Payment links 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

getPaymentLink

public PaymentLinkResponse getPaymentLink(String linkId)
                                   throws ApiException,
                                          IOException

Get a payment link

Parameters:

linkId - String Unique identifier of the payment link. (required)

Returns:

PaymentLinkResponse

Throws:

ApiException - if fails to make API call

IOException

getPaymentLink

public PaymentLinkResponse getPaymentLink(String linkId,
                                          RequestOptions requestOptions)
                                   throws ApiException,
                                          IOException

Get a payment link

Parameters:

linkId - String Unique identifier of the payment link. (required)

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

Returns:

PaymentLinkResponse

Throws:

ApiException - if fails to make API call

IOException

paymentLinks

public PaymentLinkResponse paymentLinks(PaymentLinkRequest paymentLinkRequest)
                                 throws ApiException,
                                        IOException

Create a payment link

Parameters:

paymentLinkRequest - PaymentLinkRequest (required)

Returns:

PaymentLinkResponse

Throws:

ApiException - if fails to make API call

IOException

paymentLinks

public PaymentLinkResponse paymentLinks(PaymentLinkRequest paymentLinkRequest,
                                        RequestOptions requestOptions)
                                 throws ApiException,
                                        IOException

Create a payment link

Parameters:

paymentLinkRequest - PaymentLinkRequest (required)

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

Returns:

PaymentLinkResponse

Throws:

ApiException - if fails to make API call

IOException

updatePaymentLink

public PaymentLinkResponse updatePaymentLink(String linkId,
                                             UpdatePaymentLinkRequest updatePaymentLinkRequest)
                                      throws ApiException,
                                             IOException

Update the status of a payment link

Parameters:

linkId - String Unique identifier of the payment link. (required)

updatePaymentLinkRequest - UpdatePaymentLinkRequest (required)

Returns:

PaymentLinkResponse

Throws:

ApiException - if fails to make API call

IOException

updatePaymentLink

public PaymentLinkResponse updatePaymentLink(String linkId,
                                             UpdatePaymentLinkRequest updatePaymentLinkRequest,
                                             RequestOptions requestOptions)
                                      throws ApiException,
                                             IOException

Update the status of a payment link

Parameters:

linkId - String Unique identifier of the payment link. (required)

updatePaymentLinkRequest - UpdatePaymentLinkRequest (required)

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

Returns:

PaymentLinkResponse

Throws:

ApiException - if fails to make API call

IOException