java.lang.Object
- com.adyen.model.checkout.PaymentLinkRequest

public class PaymentLinkRequest
extends Object

PaymentLinkRequest

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`PaymentLinkRequest.RecurringProcessingModelEnum`	Defines a recurring payment type.
`static class`	`PaymentLinkRequest.RequiredShopperFieldsEnum`	Gets or Sets requiredShopperFields
`static class`	`PaymentLinkRequest.StorePaymentMethodModeEnum`	Indicates if the details of the payment method will be stored for the shopper.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`JSON_PROPERTY_ALLOWED_PAYMENT_METHODS`
`static String`	`JSON_PROPERTY_AMOUNT`
`static String`	`JSON_PROPERTY_APPLICATION_INFO`
`static String`	`JSON_PROPERTY_BILLING_ADDRESS`
`static String`	`JSON_PROPERTY_BLOCKED_PAYMENT_METHODS`
`static String`	`JSON_PROPERTY_CAPTURE_DELAY_HOURS`
`static String`	`JSON_PROPERTY_COUNTRY_CODE`
`static String`	`JSON_PROPERTY_DATE_OF_BIRTH`
`static String`	`JSON_PROPERTY_DELIVER_AT`
`static String`	`JSON_PROPERTY_DELIVERY_ADDRESS`
`static String`	`JSON_PROPERTY_DESCRIPTION`
`static String`	`JSON_PROPERTY_EXPIRES_AT`
`static String`	`JSON_PROPERTY_FUND_ORIGIN`
`static String`	`JSON_PROPERTY_FUND_RECIPIENT`
`static String`	`JSON_PROPERTY_INSTALLMENT_OPTIONS`
`static String`	`JSON_PROPERTY_LINE_ITEMS`
`static String`	`JSON_PROPERTY_MANUAL_CAPTURE`
`static String`	`JSON_PROPERTY_MCC`
`static String`	`JSON_PROPERTY_MERCHANT_ACCOUNT`
`static String`	`JSON_PROPERTY_MERCHANT_ORDER_REFERENCE`
`static String`	`JSON_PROPERTY_METADATA`
`static String`	`JSON_PROPERTY_PLATFORM_CHARGEBACK_LOGIC`
`static String`	`JSON_PROPERTY_RECURRING_PROCESSING_MODEL`
`static String`	`JSON_PROPERTY_REFERENCE`
`static String`	`JSON_PROPERTY_REQUIRED_SHOPPER_FIELDS`
`static String`	`JSON_PROPERTY_RETURN_URL`
`static String`	`JSON_PROPERTY_REUSABLE`
`static String`	`JSON_PROPERTY_RISK_DATA`
`static String`	`JSON_PROPERTY_SHOPPER_EMAIL`
`static String`	`JSON_PROPERTY_SHOPPER_LOCALE`
`static String`	`JSON_PROPERTY_SHOPPER_NAME`
`static String`	`JSON_PROPERTY_SHOPPER_REFERENCE`
`static String`	`JSON_PROPERTY_SHOPPER_STATEMENT`
`static String`	`JSON_PROPERTY_SHOW_REMOVE_PAYMENT_METHOD_BUTTON`
`static String`	`JSON_PROPERTY_SOCIAL_SECURITY_NUMBER`
`static String`	`JSON_PROPERTY_SPLIT_CARD_FUNDING_SOURCES`
`static String`	`JSON_PROPERTY_SPLITS`
`static String`	`JSON_PROPERTY_STORE`
`static String`	`JSON_PROPERTY_STORE_PAYMENT_METHOD_MODE`
`static String`	`JSON_PROPERTY_TELEPHONE_NUMBER`
`static String`	`JSON_PROPERTY_THEME_ID`
`static String`	`JSON_PROPERTY_THREE_D_S2_REQUEST_DATA`

Constructor Summary

Constructors
Constructor Description

PaymentLinkRequest()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`PaymentLinkRequest`	`addAllowedPaymentMethodsItem(String allowedPaymentMethodsItem)`
`PaymentLinkRequest`	`addBlockedPaymentMethodsItem(String blockedPaymentMethodsItem)`
`PaymentLinkRequest`	`addLineItemsItem(LineItem lineItemsItem)`
`PaymentLinkRequest`	`addRequiredShopperFieldsItem(PaymentLinkRequest.RequiredShopperFieldsEnum requiredShopperFieldsItem)`
`PaymentLinkRequest`	`addSplitsItem(Split splitsItem)`
`PaymentLinkRequest`	`allowedPaymentMethods(List<String> allowedPaymentMethods)`	List of payment methods to be presented to the shopper.
`PaymentLinkRequest`	`amount(Amount amount)`	amount
`PaymentLinkRequest`	`applicationInfo(ApplicationInfo applicationInfo)`	applicationInfo
`PaymentLinkRequest`	`billingAddress(Address billingAddress)`	billingAddress
`PaymentLinkRequest`	`blockedPaymentMethods(List<String> blockedPaymentMethods)`	List of payment methods to be hidden from the shopper.
`PaymentLinkRequest`	`captureDelayHours(Integer captureDelayHours)`	The delay between the authorisation and scheduled auto-capture, specified in hours.
`PaymentLinkRequest`	`countryCode(String countryCode)`	The shopper's two-letter country code.
`PaymentLinkRequest`	`dateOfBirth(LocalDate dateOfBirth)`	The shopper's date of birth.
`PaymentLinkRequest`	`deliverAt(OffsetDateTime deliverAt)`	The date and time when the purchased goods should be delivered.
`PaymentLinkRequest`	`deliveryAddress(Address deliveryAddress)`	deliveryAddress
`PaymentLinkRequest`	`description(String description)`	A short description visible on the payment page.
`boolean`	`equals(Object o)`	Return true if this PaymentLinkRequest object is equal to o.
`PaymentLinkRequest`	`expiresAt(OffsetDateTime expiresAt)`	The date when the payment link expires.
`static PaymentLinkRequest`	`fromJson(String jsonString)`	Create an instance of PaymentLinkRequest given an JSON string
`PaymentLinkRequest`	`fundOrigin(FundOrigin fundOrigin)`	fundOrigin
`PaymentLinkRequest`	`fundRecipient(FundRecipient fundRecipient)`	fundRecipient
`List<String>`	`getAllowedPaymentMethods()`	List of payment methods to be presented to the shopper.
`Amount`	`getAmount()`	amount
`ApplicationInfo`	`getApplicationInfo()`	applicationInfo
`Address`	`getBillingAddress()`	billingAddress
`List<String>`	`getBlockedPaymentMethods()`	List of payment methods to be hidden from the shopper.
`Integer`	`getCaptureDelayHours()`	The delay between the authorisation and scheduled auto-capture, specified in hours.
`String`	`getCountryCode()`	The shopper's two-letter country code.
`LocalDate`	`getDateOfBirth()`	The shopper's date of birth.
`OffsetDateTime`	`getDeliverAt()`	The date and time when the purchased goods should be delivered.
`Address`	`getDeliveryAddress()`	deliveryAddress
`String`	`getDescription()`	A short description visible on the payment page.
`OffsetDateTime`	`getExpiresAt()`	The date when the payment link expires.
`FundOrigin`	`getFundOrigin()`	fundOrigin
`FundRecipient`	`getFundRecipient()`	fundRecipient
`Map<String,InstallmentOption>`	`getInstallmentOptions()`	A set of key-value pairs that specifies the installment options available per payment method.
`List<LineItem>`	`getLineItems()`	Price and product information about the purchased items, to be included on the invoice sent to the shopper.
`Boolean`	`getManualCapture()`	Indicates if the payment must be [captured manually](https://docs.adyen.com/online-payments/capture).
`String`	`getMcc()`	The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment.
`String`	`getMerchantAccount()`	The merchant account identifier for which the payment link is created.
`String`	`getMerchantOrderReference()`	This reference allows linking multiple transactions to each other for reporting purposes (for example, order auth-rate).
`Map<String,String>`	`getMetadata()`	Metadata consists of entries, each of which includes a key and a value.
`PlatformChargebackLogic`	`getPlatformChargebackLogic()`	platformChargebackLogic
`PaymentLinkRequest.RecurringProcessingModelEnum`	`getRecurringProcessingModel()`	Defines a recurring payment type.
`String`	`getReference()`	A reference that is used to uniquely identify the payment in future communications about the payment status.
`List<PaymentLinkRequest.RequiredShopperFieldsEnum>`	`getRequiredShopperFields()`	List of fields that the shopper has to provide on the payment page before completing the payment.
`String`	`getReturnUrl()`	Website URL used for redirection after payment is completed.
`Boolean`	`getReusable()`	Indicates whether the payment link can be reused for multiple payments.
`RiskData`	`getRiskData()`	riskData
`String`	`getShopperEmail()`	The shopper's email address.
`String`	`getShopperLocale()`	The language to be used in the payment page, specified by a combination of a language and country code.
`Name`	`getShopperName()`	shopperName
`String`	`getShopperReference()`	Your reference to uniquely identify this shopper, for example user ID or account ID.
`String`	`getShopperStatement()`	The text to be shown on the shopper's bank statement.
`Boolean`	`getShowRemovePaymentMethodButton()`	Set to false to hide the button that lets the shopper remove a stored payment method.
`String`	`getSocialSecurityNumber()`	The shopper's social security number.
`Boolean`	`getSplitCardFundingSources()`	Boolean value indicating whether the card payment method should be split into separate debit and credit options.
`List<Split>`	`getSplits()`	An array of objects specifying how to split a payment when using [Adyen for Platforms](https://docs.adyen.com/platforms/process-payments#providing-split-information), [Classic Platforms integration](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information), or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).
`String`	`getStore()`	The physical store, for which this payment is processed.
`PaymentLinkRequest.StorePaymentMethodModeEnum`	`getStorePaymentMethodMode()`	Indicates if the details of the payment method will be stored for the shopper.
`String`	`getTelephoneNumber()`	The shopper's telephone number.
`String`	`getThemeId()`	A [theme](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#themes) to customize the appearance of the payment page.
`CheckoutSessionThreeDS2RequestData`	`getThreeDS2RequestData()`	threeDS2RequestData
`int`	`hashCode()`
`PaymentLinkRequest`	`installmentOptions(Map<String,InstallmentOption> installmentOptions)`	A set of key-value pairs that specifies the installment options available per payment method.
`PaymentLinkRequest`	`lineItems(List<LineItem> lineItems)`	Price and product information about the purchased items, to be included on the invoice sent to the shopper.
`PaymentLinkRequest`	`manualCapture(Boolean manualCapture)`	Indicates if the payment must be [captured manually](https://docs.adyen.com/online-payments/capture).
`PaymentLinkRequest`	`mcc(String mcc)`	The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment.
`PaymentLinkRequest`	`merchantAccount(String merchantAccount)`	The merchant account identifier for which the payment link is created.
`PaymentLinkRequest`	`merchantOrderReference(String merchantOrderReference)`	This reference allows linking multiple transactions to each other for reporting purposes (for example, order auth-rate).
`PaymentLinkRequest`	`metadata(Map<String,String> metadata)`	Metadata consists of entries, each of which includes a key and a value.
`PaymentLinkRequest`	`platformChargebackLogic(PlatformChargebackLogic platformChargebackLogic)`	platformChargebackLogic
`PaymentLinkRequest`	`putInstallmentOptionsItem(String key, InstallmentOption installmentOptionsItem)`
`PaymentLinkRequest`	`putMetadataItem(String key, String metadataItem)`
`PaymentLinkRequest`	`recurringProcessingModel(PaymentLinkRequest.RecurringProcessingModelEnum recurringProcessingModel)`	Defines a recurring payment type.
`PaymentLinkRequest`	`reference(String reference)`	A reference that is used to uniquely identify the payment in future communications about the payment status.
`PaymentLinkRequest`	`requiredShopperFields(List<PaymentLinkRequest.RequiredShopperFieldsEnum> requiredShopperFields)`	List of fields that the shopper has to provide on the payment page before completing the payment.
`PaymentLinkRequest`	`returnUrl(String returnUrl)`	Website URL used for redirection after payment is completed.
`PaymentLinkRequest`	`reusable(Boolean reusable)`	Indicates whether the payment link can be reused for multiple payments.
`PaymentLinkRequest`	`riskData(RiskData riskData)`	riskData
`void`	`setAllowedPaymentMethods(List<String> allowedPaymentMethods)`	List of payment methods to be presented to the shopper.
`void`	`setAmount(Amount amount)`	amount
`void`	`setApplicationInfo(ApplicationInfo applicationInfo)`	applicationInfo
`void`	`setBillingAddress(Address billingAddress)`	billingAddress
`void`	`setBlockedPaymentMethods(List<String> blockedPaymentMethods)`	List of payment methods to be hidden from the shopper.
`void`	`setCaptureDelayHours(Integer captureDelayHours)`	The delay between the authorisation and scheduled auto-capture, specified in hours.
`void`	`setCountryCode(String countryCode)`	The shopper's two-letter country code.
`void`	`setDateOfBirth(LocalDate dateOfBirth)`	The shopper's date of birth.
`void`	`setDeliverAt(OffsetDateTime deliverAt)`	The date and time when the purchased goods should be delivered.
`void`	`setDeliveryAddress(Address deliveryAddress)`	deliveryAddress
`void`	`setDescription(String description)`	A short description visible on the payment page.
`void`	`setExpiresAt(OffsetDateTime expiresAt)`	The date when the payment link expires.
`void`	`setFundOrigin(FundOrigin fundOrigin)`	fundOrigin
`void`	`setFundRecipient(FundRecipient fundRecipient)`	fundRecipient
`void`	`setInstallmentOptions(Map<String,InstallmentOption> installmentOptions)`	A set of key-value pairs that specifies the installment options available per payment method.
`void`	`setLineItems(List<LineItem> lineItems)`	Price and product information about the purchased items, to be included on the invoice sent to the shopper.
`void`	`setManualCapture(Boolean manualCapture)`	Indicates if the payment must be [captured manually](https://docs.adyen.com/online-payments/capture).
`void`	`setMcc(String mcc)`	The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment.
`void`	`setMerchantAccount(String merchantAccount)`	The merchant account identifier for which the payment link is created.
`void`	`setMerchantOrderReference(String merchantOrderReference)`	This reference allows linking multiple transactions to each other for reporting purposes (for example, order auth-rate).
`void`	`setMetadata(Map<String,String> metadata)`	Metadata consists of entries, each of which includes a key and a value.
`void`	`setPlatformChargebackLogic(PlatformChargebackLogic platformChargebackLogic)`	platformChargebackLogic
`void`	`setRecurringProcessingModel(PaymentLinkRequest.RecurringProcessingModelEnum recurringProcessingModel)`	Defines a recurring payment type.
`void`	`setReference(String reference)`	A reference that is used to uniquely identify the payment in future communications about the payment status.
`void`	`setRequiredShopperFields(List<PaymentLinkRequest.RequiredShopperFieldsEnum> requiredShopperFields)`	List of fields that the shopper has to provide on the payment page before completing the payment.
`void`	`setReturnUrl(String returnUrl)`	Website URL used for redirection after payment is completed.
`void`	`setReusable(Boolean reusable)`	Indicates whether the payment link can be reused for multiple payments.
`void`	`setRiskData(RiskData riskData)`	riskData
`void`	`setShopperEmail(String shopperEmail)`	The shopper's email address.
`void`	`setShopperLocale(String shopperLocale)`	The language to be used in the payment page, specified by a combination of a language and country code.
`void`	`setShopperName(Name shopperName)`	shopperName
`void`	`setShopperReference(String shopperReference)`	Your reference to uniquely identify this shopper, for example user ID or account ID.
`void`	`setShopperStatement(String shopperStatement)`	The text to be shown on the shopper's bank statement.
`void`	`setShowRemovePaymentMethodButton(Boolean showRemovePaymentMethodButton)`	Set to false to hide the button that lets the shopper remove a stored payment method.
`void`	`setSocialSecurityNumber(String socialSecurityNumber)`	The shopper's social security number.
`void`	`setSplitCardFundingSources(Boolean splitCardFundingSources)`	Boolean value indicating whether the card payment method should be split into separate debit and credit options.
`void`	`setSplits(List<Split> splits)`	An array of objects specifying how to split a payment when using [Adyen for Platforms](https://docs.adyen.com/platforms/process-payments#providing-split-information), [Classic Platforms integration](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information), or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).
`void`	`setStore(String store)`	The physical store, for which this payment is processed.
`void`	`setStorePaymentMethodMode(PaymentLinkRequest.StorePaymentMethodModeEnum storePaymentMethodMode)`	Indicates if the details of the payment method will be stored for the shopper.
`void`	`setTelephoneNumber(String telephoneNumber)`	The shopper's telephone number.
`void`	`setThemeId(String themeId)`	A [theme](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#themes) to customize the appearance of the payment page.
`void`	`setThreeDS2RequestData(CheckoutSessionThreeDS2RequestData threeDS2RequestData)`	threeDS2RequestData
`PaymentLinkRequest`	`shopperEmail(String shopperEmail)`	The shopper's email address.
`PaymentLinkRequest`	`shopperLocale(String shopperLocale)`	The language to be used in the payment page, specified by a combination of a language and country code.
`PaymentLinkRequest`	`shopperName(Name shopperName)`	shopperName
`PaymentLinkRequest`	`shopperReference(String shopperReference)`	Your reference to uniquely identify this shopper, for example user ID or account ID.
`PaymentLinkRequest`	`shopperStatement(String shopperStatement)`	The text to be shown on the shopper's bank statement.
`PaymentLinkRequest`	`showRemovePaymentMethodButton(Boolean showRemovePaymentMethodButton)`	Set to false to hide the button that lets the shopper remove a stored payment method.
`PaymentLinkRequest`	`socialSecurityNumber(String socialSecurityNumber)`	The shopper's social security number.
`PaymentLinkRequest`	`splitCardFundingSources(Boolean splitCardFundingSources)`	Boolean value indicating whether the card payment method should be split into separate debit and credit options.
`PaymentLinkRequest`	`splits(List<Split> splits)`	An array of objects specifying how to split a payment when using [Adyen for Platforms](https://docs.adyen.com/platforms/process-payments#providing-split-information), [Classic Platforms integration](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information), or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).
`PaymentLinkRequest`	`store(String store)`	The physical store, for which this payment is processed.
`PaymentLinkRequest`	`storePaymentMethodMode(PaymentLinkRequest.StorePaymentMethodModeEnum storePaymentMethodMode)`	Indicates if the details of the payment method will be stored for the shopper.
`PaymentLinkRequest`	`telephoneNumber(String telephoneNumber)`	The shopper's telephone number.
`PaymentLinkRequest`	`themeId(String themeId)`	A [theme](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#themes) to customize the appearance of the payment page.
`PaymentLinkRequest`	`threeDS2RequestData(CheckoutSessionThreeDS2RequestData threeDS2RequestData)`	threeDS2RequestData
`String`	`toJson()`	Convert an instance of PaymentLinkRequest to an JSON string
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - JSON_PROPERTY_ALLOWED_PAYMENT_METHODS
```
public static final String JSON_PROPERTY_ALLOWED_PAYMENT_METHODS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_AMOUNT
```
public static final String JSON_PROPERTY_AMOUNT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_APPLICATION_INFO
```
public static final String JSON_PROPERTY_APPLICATION_INFO
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_BILLING_ADDRESS
```
public static final String JSON_PROPERTY_BILLING_ADDRESS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_BLOCKED_PAYMENT_METHODS
```
public static final String JSON_PROPERTY_BLOCKED_PAYMENT_METHODS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_CAPTURE_DELAY_HOURS
```
public static final String JSON_PROPERTY_CAPTURE_DELAY_HOURS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_COUNTRY_CODE
```
public static final String JSON_PROPERTY_COUNTRY_CODE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_DATE_OF_BIRTH
```
public static final String JSON_PROPERTY_DATE_OF_BIRTH
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_DELIVER_AT
```
public static final String JSON_PROPERTY_DELIVER_AT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_DELIVERY_ADDRESS
```
public static final String JSON_PROPERTY_DELIVERY_ADDRESS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_DESCRIPTION
```
public static final String JSON_PROPERTY_DESCRIPTION
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_EXPIRES_AT
```
public static final String JSON_PROPERTY_EXPIRES_AT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_FUND_ORIGIN
```
public static final String JSON_PROPERTY_FUND_ORIGIN
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_FUND_RECIPIENT
```
public static final String JSON_PROPERTY_FUND_RECIPIENT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_INSTALLMENT_OPTIONS
```
public static final String JSON_PROPERTY_INSTALLMENT_OPTIONS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_LINE_ITEMS
```
public static final String JSON_PROPERTY_LINE_ITEMS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_MANUAL_CAPTURE
```
public static final String JSON_PROPERTY_MANUAL_CAPTURE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_MCC
```
public static final String JSON_PROPERTY_MCC
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_MERCHANT_ACCOUNT
```
public static final String JSON_PROPERTY_MERCHANT_ACCOUNT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_MERCHANT_ORDER_REFERENCE
```
public static final String JSON_PROPERTY_MERCHANT_ORDER_REFERENCE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_METADATA
```
public static final String JSON_PROPERTY_METADATA
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_PLATFORM_CHARGEBACK_LOGIC
```
public static final String JSON_PROPERTY_PLATFORM_CHARGEBACK_LOGIC
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_RECURRING_PROCESSING_MODEL
```
public static final String JSON_PROPERTY_RECURRING_PROCESSING_MODEL
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_REFERENCE
```
public static final String JSON_PROPERTY_REFERENCE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_REQUIRED_SHOPPER_FIELDS
```
public static final String JSON_PROPERTY_REQUIRED_SHOPPER_FIELDS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_RETURN_URL
```
public static final String JSON_PROPERTY_RETURN_URL
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_REUSABLE
```
public static final String JSON_PROPERTY_REUSABLE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_RISK_DATA
```
public static final String JSON_PROPERTY_RISK_DATA
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SHOPPER_EMAIL
```
public static final String JSON_PROPERTY_SHOPPER_EMAIL
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SHOPPER_LOCALE
```
public static final String JSON_PROPERTY_SHOPPER_LOCALE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SHOPPER_NAME
```
public static final String JSON_PROPERTY_SHOPPER_NAME
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SHOPPER_REFERENCE
```
public static final String JSON_PROPERTY_SHOPPER_REFERENCE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SHOPPER_STATEMENT
```
public static final String JSON_PROPERTY_SHOPPER_STATEMENT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SHOW_REMOVE_PAYMENT_METHOD_BUTTON
```
public static final String JSON_PROPERTY_SHOW_REMOVE_PAYMENT_METHOD_BUTTON
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SOCIAL_SECURITY_NUMBER
```
public static final String JSON_PROPERTY_SOCIAL_SECURITY_NUMBER
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SPLIT_CARD_FUNDING_SOURCES
```
public static final String JSON_PROPERTY_SPLIT_CARD_FUNDING_SOURCES
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SPLITS
```
public static final String JSON_PROPERTY_SPLITS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_STORE
```
public static final String JSON_PROPERTY_STORE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_STORE_PAYMENT_METHOD_MODE
```
public static final String JSON_PROPERTY_STORE_PAYMENT_METHOD_MODE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_TELEPHONE_NUMBER
```
public static final String JSON_PROPERTY_TELEPHONE_NUMBER
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_THEME_ID
```
public static final String JSON_PROPERTY_THEME_ID
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_THREE_D_S2_REQUEST_DATA
```
public static final String JSON_PROPERTY_THREE_D_S2_REQUEST_DATA
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PaymentLinkRequest
```
public PaymentLinkRequest()
```
- Method Detail
  - allowedPaymentMethods
```
public PaymentLinkRequest allowedPaymentMethods(List<String> allowedPaymentMethods)
```
    List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`
    
    Parameters:
    
    allowedPaymentMethods -
    
    Returns:
    
    the current PaymentLinkRequest instance, allowing for method chaining
  - addAllowedPaymentMethodsItem
```
public PaymentLinkRequest addAllowedPaymentMethodsItem(String allowedPaymentMethodsItem)
```
  - getAllowedPaymentMethods
```
public List<String> getAllowedPaymentMethods()
```
    List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`
    
    Returns:
    
    allowedPaymentMethods
  - setAllowedPaymentMethods
```
public void setAllowedPaymentMethods(List<String> allowedPaymentMethods)
```
    List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`
    
    Parameters:
    
    allowedPaymentMethods -
  - amount
```
public PaymentLinkRequest amount(Amount amount)
```
    amount
    
    Parameters:
    
    amount -
    
    Returns:
    
    the current PaymentLinkRequest instance, allowing for method chaining
  - getAmount
```
public Amount getAmount()
```
    amount
    
    Returns:
    
    amount
  - setAmount
```
public void setAmount(Amount amount)
```
    amount
    
    Parameters:
    
    amount -
  - applicationInfo
```
public PaymentLinkRequest applicationInfo(ApplicationInfo applicationInfo)
```
    applicationInfo
    
    Parameters:
    
    applicationInfo -
    
    Returns:
    
    the current PaymentLinkRequest instance, allowing for method chaining
  - getApplicationInfo
```
public ApplicationInfo getApplicationInfo()
```
    applicationInfo
    
    Returns:
    
    applicationInfo
  - setApplicationInfo
```
public void setApplicationInfo(ApplicationInfo applicationInfo)
```
    applicationInfo
    
    Parameters:
    
    applicationInfo -
  - billingAddress
```
public PaymentLinkRequest billingAddress(Address billingAddress)
```
    billingAddress
    
    Parameters:
    
    billingAddress -
    
    Returns:
    
    the current PaymentLinkRequest instance, allowing for method chaining
  - getBillingAddress
```
public Address getBillingAddress()
```
    billingAddress
    
    Returns:
    
    billingAddress
  - setBillingAddress
```
public void setBillingAddress(Address billingAddress)
```
    billingAddress
    
    Parameters:
    
    billingAddress -
  - blockedPaymentMethods
```
public PaymentLinkRequest blockedPaymentMethods(List<String> blockedPaymentMethods)
```
    List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`
    
    Parameters:
    
    blockedPaymentMethods -
    
    Returns:
    
    the current PaymentLinkRequest instance, allowing for method chaining
  - addBlockedPaymentMethodsItem
```
public PaymentLinkRequest addBlockedPaymentMethodsItem(String blockedPaymentMethodsItem)
```
  - getBlockedPaymentMethods
```
public List<String> getBlockedPaymentMethods()
```
    List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`
    
    Returns:
    
    blockedPaymentMethods
  - setBlockedPaymentMethods
```
public void setBlockedPaymentMethods(List<String> blockedPaymentMethods)
```
    List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`
    
    Parameters:
    
    blockedPaymentMethods -
  - captureDelayHours
```
public PaymentLinkRequest captureDelayHours(Integer captureDelayHours)
```
    The delay between the authorisation and scheduled auto-capture, specified in hours.
    
    Parameters:
    
    captureDelayHours -
    
    Returns:
    
    the current PaymentLinkRequest instance, allowing for method chaining
  - getCaptureDelayHours
```
public Integer getCaptureDelayHours()
```
    The delay between the authorisation and scheduled auto-capture, specified in hours.
    
    Returns:
    
    captureDelayHours
  - setCaptureDelayHours
```
public void setCaptureDelayHours(Integer captureDelayHours)
```
    The delay between the authorisation and scheduled auto-capture, specified in hours.
    
    Parameters:
    
    captureDelayHours -
  - countryCode
```
public PaymentLinkRequest countryCode(String countryCode)
```
    The shopper's two-letter country code.
    
    Parameters:
    
    countryCode -
    
    Returns:
    
    the current PaymentLinkRequest instance, allowing for method chaining
  - getCountryCode
```
public String getCountryCode()
```
    The shopper's two-letter country code.
    
    Returns:
    
    countryCode
  - setCountryCode
```
public void setCountryCode(String countryCode)
```
    The shopper's two-letter country code.
    
    Parameters:
    
    countryCode -
  - dateOfBirth
```
public PaymentLinkRequest dateOfBirth(LocalDate dateOfBirth)
```
    The shopper's date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD
    
    Parameters:
    
    dateOfBirth -
    
    Returns:
    
    the current PaymentLinkRequest instance, allowing for method chaining
  - getDateOfBirth
```
public LocalDate getDateOfBirth()
```
    The shopper's date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD
    
    Returns:
    
    dateOfBirth
  - setDateOfBirth
```
public void setDateOfBirth(LocalDate dateOfBirth)
```
    The shopper's date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD
    
    Parameters:
    
    dateOfBirth -
  - deliverAt
```
public PaymentLinkRequest deliverAt(OffsetDateTime deliverAt)
```
    The date and time when the purchased goods should be delivered. [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format: YYYY-MM-DDThh:mm:ss+TZD, for example, **2020-12-18T10:15:30+01:00**.
    
    Parameters:
    
    deliverAt -
    
    Returns:
    
    the current PaymentLinkRequest instance, allowing for method chaining
  - getDeliverAt
```
public OffsetDateTime getDeliverAt()
```
    The date and time when the purchased goods should be delivered. [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format: YYYY-MM-DDThh:mm:ss+TZD, for example, **2020-12-18T10:15:30+01:00**.
    
    Returns:
    
    deliverAt
  - setDeliverAt
```
public void setDeliverAt(OffsetDateTime deliverAt)
```
    The date and time when the purchased goods should be delivered. [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format: YYYY-MM-DDThh:mm:ss+TZD, for example, **2020-12-18T10:15:30+01:00**.
    
    Parameters:
    
    deliverAt -
  - deliveryAddress
```
public PaymentLinkRequest deliveryAddress(Address deliveryAddress)
```
    deliveryAddress
    
    Parameters:
    
    deliveryAddress -
    
    Returns:
    
    the current PaymentLinkRequest instance, allowing for method chaining
  - getDeliveryAddress
```
public Address getDeliveryAddress()
```
    deliveryAddress
    
    Returns:
    
    deliveryAddress
  - setDeliveryAddress
```
public void setDeliveryAddress(Address deliveryAddress)
```
    deliveryAddress
    
    Parameters:
    
    deliveryAddress -
  - description
```
public PaymentLinkRequest description(String description)
```
    A short description visible on the payment page. Maximum length: 280 characters.
    
    Parameters:
    
    description -
    
    Returns:
    
    the current PaymentLinkRequest instance, allowing for method chaining
  - getDescription
```
public String getDescription()
```
    A short description visible on the payment page. Maximum length: 280 characters.
    
    Returns:
    
    description
  - setDescription
```
public void setDescription(String description)
```
    A short description visible on the payment page. Maximum length: 280 characters.
    
    Parameters:
    
    description -
  - expiresAt
```
public PaymentLinkRequest expiresAt(OffsetDateTime expiresAt)
```
    The date when the payment link expires. [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format with time zone offset: YYYY-MM-DDThh:mm:ss+TZD, for example, **2020-12-18T10:15:30+01:00**. The maximum expiry date is 70 days after the payment link is created. If not provided, the payment link expires 24 hours after it was created.
    
    Parameters:
    
    expiresAt -
    
    Returns:
    
    the current PaymentLinkRequest instance, allowing for method chaining
  - getExpiresAt
```
public OffsetDateTime getExpiresAt()
```
    The date when the payment link expires. [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format with time zone offset: YYYY-MM-DDThh:mm:ss+TZD, for example, **2020-12-18T10:15:30+01:00**. The maximum expiry date is 70 days after the payment link is created. If not provided, the payment link expires 24 hours after it was created.
    
    Returns:
    
    expiresAt
  - setExpiresAt
```
public void setExpiresAt(OffsetDateTime expiresAt)
```
    The date when the payment link expires. [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format with time zone offset: YYYY-MM-DDThh:mm:ss+TZD, for example, **2020-12-18T10:15:30+01:00**. The maximum expiry date is 70 days after the payment link is created. If not provided, the payment link expires 24 hours after it was created.
    
    Parameters:
    
    expiresAt -
  - fundOrigin
```
public PaymentLinkRequest fundOrigin(FundOrigin fundOrigin)
```
    fundOrigin
    
    Parameters:
    
    fundOrigin -
    
    Returns:
    
    the current PaymentLinkRequest instance, allowing for method chaining
  - getFundOrigin
```
public FundOrigin getFundOrigin()
```
    fundOrigin
    
    Returns:
    
    fundOrigin
  - setFundOrigin
```
public void setFundOrigin(FundOrigin fundOrigin)
```
    fundOrigin
    
    Parameters:
    
    fundOrigin -
  - fundRecipient
```
public PaymentLinkRequest fundRecipient(FundRecipient fundRecipient)
```
    fundRecipient
    
    Parameters:
    
    fundRecipient -
    
    Returns:
    
    the current PaymentLinkRequest instance, allowing for method chaining
  - getFundRecipient
```
public FundRecipient getFundRecipient()
```
    fundRecipient
    
    Returns:
    
    fundRecipient
  - setFundRecipient
```
public void setFundRecipient(FundRecipient fundRecipient)
```
    fundRecipient
    
    Parameters:
    
    fundRecipient -
  - installmentOptions
```
public PaymentLinkRequest installmentOptions(Map<String,InstallmentOption> installmentOptions)
```
    A set of key-value pairs that specifies the installment options available per payment method. The key must be a payment method name in lowercase. For example, **card** to specify installment options for all cards, or **visa** or **mc**. The value must be an object containing the installment options.
    
    Parameters:
    
    installmentOptions -
    
    Returns:
    
    the current PaymentLinkRequest instance, allowing for method chaining
  - putInstallmentOptionsItem
```
public PaymentLinkRequest putInstallmentOptionsItem(String key,
                                                    InstallmentOption installmentOptionsItem)
```
  - getInstallmentOptions
```
public Map<String,InstallmentOption> getInstallmentOptions()
```
    A set of key-value pairs that specifies the installment options available per payment method. The key must be a payment method name in lowercase. For example, **card** to specify installment options for all cards, or **visa** or **mc**. The value must be an object containing the installment options.
    
    Returns:
    
    installmentOptions
  - setInstallmentOptions
```
public void setInstallmentOptions(Map<String,InstallmentOption> installmentOptions)
```
    A set of key-value pairs that specifies the installment options available per payment method. The key must be a payment method name in lowercase. For example, **card** to specify installment options for all cards, or **visa** or **mc**. The value must be an object containing the installment options.
    
    Parameters:
    
    installmentOptions -
  - lineItems
```
public PaymentLinkRequest lineItems(List<LineItem> lineItems)
```
    Price and product information about the purchased items, to be included on the invoice sent to the shopper. This parameter is required for open invoice (_buy now, pay later_) payment methods such Afterpay, Clearpay, Klarna, RatePay, Riverty, and Zip.
    
    Parameters:
    
    lineItems -
    
    Returns:
    
    the current PaymentLinkRequest instance, allowing for method chaining
  - addLineItemsItem
```
public PaymentLinkRequest addLineItemsItem(LineItem lineItemsItem)
```
  - getLineItems
```
public List<LineItem> getLineItems()
```
    Price and product information about the purchased items, to be included on the invoice sent to the shopper. This parameter is required for open invoice (_buy now, pay later_) payment methods such Afterpay, Clearpay, Klarna, RatePay, Riverty, and Zip.
    
    Returns:
    
    lineItems
  - setLineItems
```
public void setLineItems(List<LineItem> lineItems)
```
    Price and product information about the purchased items, to be included on the invoice sent to the shopper. This parameter is required for open invoice (_buy now, pay later_) payment methods such Afterpay, Clearpay, Klarna, RatePay, Riverty, and Zip.
    
    Parameters:
    
    lineItems -
  - manualCapture
```
public PaymentLinkRequest manualCapture(Boolean manualCapture)
```
    Indicates if the payment must be [captured manually](https://docs.adyen.com/online-payments/capture).
    
    Parameters:
    
    manualCapture -
    
    Returns:
    
    the current PaymentLinkRequest instance, allowing for method chaining
  - getManualCapture
```
public Boolean getManualCapture()
```
    Indicates if the payment must be [captured manually](https://docs.adyen.com/online-payments/capture).
    
    Returns:
    
    manualCapture
  - setManualCapture
```
public void setManualCapture(Boolean manualCapture)
```
    Indicates if the payment must be [captured manually](https://docs.adyen.com/online-payments/capture).
    
    Parameters:
    
    manualCapture -
  - mcc
```
public PaymentLinkRequest mcc(String mcc)
```
    The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.
    
    Parameters:
    
    mcc -
    
    Returns:
    
    the current PaymentLinkRequest instance, allowing for method chaining
  - getMcc
```
public String getMcc()
```
    The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.
    
    Returns:
    
    mcc
  - setMcc
```
public void setMcc(String mcc)
```
    The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.
    
    Parameters:
    
    mcc -
  - merchantAccount
```
public PaymentLinkRequest merchantAccount(String merchantAccount)
```
    The merchant account identifier for which the payment link is created.
    
    Parameters:
    
    merchantAccount -
    
    Returns:
    
    the current PaymentLinkRequest instance, allowing for method chaining
  - getMerchantAccount
```
public String getMerchantAccount()
```
    The merchant account identifier for which the payment link is created.
    
    Returns:
    
    merchantAccount
  - setMerchantAccount
```
public void setMerchantAccount(String merchantAccount)
```
    The merchant account identifier for which the payment link is created.
    
    Parameters:
    
    merchantAccount -
  - merchantOrderReference
```
public PaymentLinkRequest merchantOrderReference(String merchantOrderReference)
```
    This reference allows linking multiple transactions to each other for reporting purposes (for example, order auth-rate). The reference should be unique per billing cycle.
    
    Parameters:
    
    merchantOrderReference -
    
    Returns:
    
    the current PaymentLinkRequest instance, allowing for method chaining
  - getMerchantOrderReference
```
public String getMerchantOrderReference()
```
    This reference allows linking multiple transactions to each other for reporting purposes (for example, order auth-rate). The reference should be unique per billing cycle.
    
    Returns:
    
    merchantOrderReference
  - setMerchantOrderReference
```
public void setMerchantOrderReference(String merchantOrderReference)
```
    This reference allows linking multiple transactions to each other for reporting purposes (for example, order auth-rate). The reference should be unique per billing cycle.
    
    Parameters:
    
    merchantOrderReference -
  - metadata
```
public PaymentLinkRequest metadata(Map<String,String> metadata)
```
    Metadata consists of entries, each of which includes a key and a value. Limitations: * Maximum 20 key-value pairs per request. Otherwise, error \"177\" occurs: \"Metadata size exceeds limit\" * Maximum 20 characters per key. Otherwise, error \"178\" occurs: \"Metadata key size exceeds limit\" * A key cannot have the name `checkout.linkId`. Any value that you provide with this key is going to be replaced by the real payment link ID.
    
    Parameters:
    
    metadata -
    
    Returns:
    
    the current PaymentLinkRequest instance, allowing for method chaining
  - putMetadataItem
```
public PaymentLinkRequest putMetadataItem(String key,
                                          String metadataItem)
```
  - getMetadata
```
public Map<String,String> getMetadata()
```
    Metadata consists of entries, each of which includes a key and a value. Limitations: * Maximum 20 key-value pairs per request. Otherwise, error \"177\" occurs: \"Metadata size exceeds limit\" * Maximum 20 characters per key. Otherwise, error \"178\" occurs: \"Metadata key size exceeds limit\" * A key cannot have the name `checkout.linkId`. Any value that you provide with this key is going to be replaced by the real payment link ID.
    
    Returns:
    
    metadata
  - setMetadata
```
public void setMetadata(Map<String,String> metadata)
```
    Metadata consists of entries, each of which includes a key and a value. Limitations: * Maximum 20 key-value pairs per request. Otherwise, error \"177\" occurs: \"Metadata size exceeds limit\" * Maximum 20 characters per key. Otherwise, error \"178\" occurs: \"Metadata key size exceeds limit\" * A key cannot have the name `checkout.linkId`. Any value that you provide with this key is going to be replaced by the real payment link ID.
    
    Parameters:
    
    metadata -
  - platformChargebackLogic
```
public PaymentLinkRequest platformChargebackLogic(PlatformChargebackLogic platformChargebackLogic)
```
    platformChargebackLogic
    
    Parameters:
    
    platformChargebackLogic -
    
    Returns:
    
    the current PaymentLinkRequest instance, allowing for method chaining
  - getPlatformChargebackLogic
```
public PlatformChargebackLogic getPlatformChargebackLogic()
```
    platformChargebackLogic
    
    Returns:
    
    platformChargebackLogic
  - setPlatformChargebackLogic
```
public void setPlatformChargebackLogic(PlatformChargebackLogic platformChargebackLogic)
```
    platformChargebackLogic
    
    Parameters:
    
    platformChargebackLogic -
  - recurringProcessingModel
```
public PaymentLinkRequest recurringProcessingModel(PaymentLinkRequest.RecurringProcessingModelEnum recurringProcessingModel)
```
    Defines a recurring payment type. Required when `storePaymentMethodMode` is set to **askForConsent** or **enabled**. Possible values: * **Subscription** – A transaction for a fixed or variable amount, which follows a fixed schedule. * **CardOnFile** – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. * **UnscheduledCardOnFile** – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or has variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.
    
    Parameters:
    
    recurringProcessingModel -
    
    Returns:
    
    the current PaymentLinkRequest instance, allowing for method chaining
  - getRecurringProcessingModel
```
public PaymentLinkRequest.RecurringProcessingModelEnum getRecurringProcessingModel()
```
    Defines a recurring payment type. Required when `storePaymentMethodMode` is set to **askForConsent** or **enabled**. Possible values: * **Subscription** – A transaction for a fixed or variable amount, which follows a fixed schedule. * **CardOnFile** – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. * **UnscheduledCardOnFile** – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or has variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.
    
    Returns:
    
    recurringProcessingModel
  - setRecurringProcessingModel
```
public void setRecurringProcessingModel(PaymentLinkRequest.RecurringProcessingModelEnum recurringProcessingModel)
```
    Defines a recurring payment type. Required when `storePaymentMethodMode` is set to **askForConsent** or **enabled**. Possible values: * **Subscription** – A transaction for a fixed or variable amount, which follows a fixed schedule. * **CardOnFile** – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. * **UnscheduledCardOnFile** – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or has variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.
    
    Parameters:
    
    recurringProcessingModel -
  - reference
```
public PaymentLinkRequest reference(String reference)
```
    A reference that is used to uniquely identify the payment in future communications about the payment status.
    
    Parameters:
    
    reference -
    
    Returns:
    
    the current PaymentLinkRequest instance, allowing for method chaining
  - getReference
```
public String getReference()
```
    A reference that is used to uniquely identify the payment in future communications about the payment status.
    
    Returns:
    
    reference
  - setReference
```
public void setReference(String reference)
```
    A reference that is used to uniquely identify the payment in future communications about the payment status.
    
    Parameters:
    
    reference -
  - requiredShopperFields
```
public PaymentLinkRequest requiredShopperFields(List<PaymentLinkRequest.RequiredShopperFieldsEnum> requiredShopperFields)
```
    List of fields that the shopper has to provide on the payment page before completing the payment. For more information, refer to [Provide shopper information](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#shopper-information). Possible values: * **billingAddress** – The address where to send the invoice. * **deliveryAddress** – The address where the purchased goods should be delivered. * **shopperEmail** – The shopper's email address. * **shopperName** – The shopper's full name. * **telephoneNumber** – The shopper's phone number.
    
    Parameters:
    
    requiredShopperFields -
    
    Returns:
    
    the current PaymentLinkRequest instance, allowing for method chaining
  - addRequiredShopperFieldsItem
```
public PaymentLinkRequest addRequiredShopperFieldsItem(PaymentLinkRequest.RequiredShopperFieldsEnum requiredShopperFieldsItem)
```
  - getRequiredShopperFields
```
public List<PaymentLinkRequest.RequiredShopperFieldsEnum> getRequiredShopperFields()
```
    List of fields that the shopper has to provide on the payment page before completing the payment. For more information, refer to [Provide shopper information](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#shopper-information). Possible values: * **billingAddress** – The address where to send the invoice. * **deliveryAddress** – The address where the purchased goods should be delivered. * **shopperEmail** – The shopper's email address. * **shopperName** – The shopper's full name. * **telephoneNumber** – The shopper's phone number.
    
    Returns:
    
    requiredShopperFields
  - setRequiredShopperFields
```
public void setRequiredShopperFields(List<PaymentLinkRequest.RequiredShopperFieldsEnum> requiredShopperFields)
```
    List of fields that the shopper has to provide on the payment page before completing the payment. For more information, refer to [Provide shopper information](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#shopper-information). Possible values: * **billingAddress** – The address where to send the invoice. * **deliveryAddress** – The address where the purchased goods should be delivered. * **shopperEmail** – The shopper's email address. * **shopperName** – The shopper's full name. * **telephoneNumber** – The shopper's phone number.
    
    Parameters:
    
    requiredShopperFields -
  - returnUrl
```
public PaymentLinkRequest returnUrl(String returnUrl)
```
    Website URL used for redirection after payment is completed. If provided, a **Continue** button will be shown on the payment page. If shoppers select the button, they are redirected to the specified URL.
    
    Parameters:
    
    returnUrl -
    
    Returns:
    
    the current PaymentLinkRequest instance, allowing for method chaining
  - getReturnUrl
```
public String getReturnUrl()
```
    Website URL used for redirection after payment is completed. If provided, a **Continue** button will be shown on the payment page. If shoppers select the button, they are redirected to the specified URL.
    
    Returns:
    
    returnUrl
  - setReturnUrl
```
public void setReturnUrl(String returnUrl)
```
    Website URL used for redirection after payment is completed. If provided, a **Continue** button will be shown on the payment page. If shoppers select the button, they are redirected to the specified URL.
    
    Parameters:
    
    returnUrl -
  - reusable
```
public PaymentLinkRequest reusable(Boolean reusable)
```
    Indicates whether the payment link can be reused for multiple payments. If not provided, this defaults to **false** which means the link can be used for one successful payment only.
    
    Parameters:
    
    reusable -
    
    Returns:
    
    the current PaymentLinkRequest instance, allowing for method chaining
  - getReusable
```
public Boolean getReusable()
```
    Indicates whether the payment link can be reused for multiple payments. If not provided, this defaults to **false** which means the link can be used for one successful payment only.
    
    Returns:
    
    reusable
  - setReusable
```
public void setReusable(Boolean reusable)
```
    Indicates whether the payment link can be reused for multiple payments. If not provided, this defaults to **false** which means the link can be used for one successful payment only.
    
    Parameters:
    
    reusable -
  - riskData
```
public PaymentLinkRequest riskData(RiskData riskData)
```
    riskData
    
    Parameters:
    
    riskData -
    
    Returns:
    
    the current PaymentLinkRequest instance, allowing for method chaining
  - getRiskData
```
public RiskData getRiskData()
```
    riskData
    
    Returns:
    
    riskData
  - setRiskData
```
public void setRiskData(RiskData riskData)
```
    riskData
    
    Parameters:
    
    riskData -
  - shopperEmail
```
public PaymentLinkRequest shopperEmail(String shopperEmail)
```
    The shopper's email address.
    
    Parameters:
    
    shopperEmail -
    
    Returns:
    
    the current PaymentLinkRequest instance, allowing for method chaining
  - getShopperEmail
```
public String getShopperEmail()
```
    The shopper's email address.
    
    Returns:
    
    shopperEmail
  - setShopperEmail
```
public void setShopperEmail(String shopperEmail)
```
    The shopper's email address.
    
    Parameters:
    
    shopperEmail -
  - shopperLocale
```
public PaymentLinkRequest shopperLocale(String shopperLocale)
```
    The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`. For a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).
    
    Parameters:
    
    shopperLocale -
    
    Returns:
    
    the current PaymentLinkRequest instance, allowing for method chaining
  - getShopperLocale
```
public String getShopperLocale()
```
    The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`. For a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).
    
    Returns:
    
    shopperLocale
  - setShopperLocale
```
public void setShopperLocale(String shopperLocale)
```
    The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`. For a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).
    
    Parameters:
    
    shopperLocale -
  - shopperName
```
public PaymentLinkRequest shopperName(Name shopperName)
```
    shopperName
    
    Parameters:
    
    shopperName -
    
    Returns:
    
    the current PaymentLinkRequest instance, allowing for method chaining
  - getShopperName
```
public Name getShopperName()
```
    shopperName
    
    Returns:
    
    shopperName
  - setShopperName
```
public void setShopperName(Name shopperName)
```
    shopperName
    
    Parameters:
    
    shopperName -
  - shopperReference
```
public PaymentLinkRequest shopperReference(String shopperReference)
```
    Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters. > Your reference must not include personally identifiable information (PII), for example name or email address.
    
    Parameters:
    
    shopperReference -
    
    Returns:
    
    the current PaymentLinkRequest instance, allowing for method chaining
  - getShopperReference
```
public String getShopperReference()
```
    Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters. > Your reference must not include personally identifiable information (PII), for example name or email address.
    
    Returns:
    
    shopperReference
  - setShopperReference
```
public void setShopperReference(String shopperReference)
```
    Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters. > Your reference must not include personally identifiable information (PII), for example name or email address.
    
    Parameters:
    
    shopperReference -
  - shopperStatement
```
public PaymentLinkRequest shopperStatement(String shopperStatement)
```
    The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: **a-z**, **A-Z**, **0-9**, spaces, and special characters **. , ' _ - ? + * /_**.
    
    Parameters:
    
    shopperStatement -
    
    Returns:
    
    the current PaymentLinkRequest instance, allowing for method chaining
  - getShopperStatement
```
public String getShopperStatement()
```
    The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: **a-z**, **A-Z**, **0-9**, spaces, and special characters **. , ' _ - ? + * /_**.
    
    Returns:
    
    shopperStatement
  - setShopperStatement
```
public void setShopperStatement(String shopperStatement)
```
    The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: **a-z**, **A-Z**, **0-9**, spaces, and special characters **. , ' _ - ? + * /_**.
    
    Parameters:
    
    shopperStatement -
  - showRemovePaymentMethodButton
```
public PaymentLinkRequest showRemovePaymentMethodButton(Boolean showRemovePaymentMethodButton)
```
    Set to **false** to hide the button that lets the shopper remove a stored payment method.
    
    Parameters:
    
    showRemovePaymentMethodButton -
    
    Returns:
    
    the current PaymentLinkRequest instance, allowing for method chaining
  - getShowRemovePaymentMethodButton
```
public Boolean getShowRemovePaymentMethodButton()
```
    Set to **false** to hide the button that lets the shopper remove a stored payment method.
    
    Returns:
    
    showRemovePaymentMethodButton
  - setShowRemovePaymentMethodButton
```
public void setShowRemovePaymentMethodButton(Boolean showRemovePaymentMethodButton)
```
    Set to **false** to hide the button that lets the shopper remove a stored payment method.
    
    Parameters:
    
    showRemovePaymentMethodButton -
  - socialSecurityNumber
```
public PaymentLinkRequest socialSecurityNumber(String socialSecurityNumber)
```
    The shopper's social security number.
    
    Parameters:
    
    socialSecurityNumber -
    
    Returns:
    
    the current PaymentLinkRequest instance, allowing for method chaining
  - getSocialSecurityNumber
```
public String getSocialSecurityNumber()
```
    The shopper's social security number.
    
    Returns:
    
    socialSecurityNumber
  - setSocialSecurityNumber
```
public void setSocialSecurityNumber(String socialSecurityNumber)
```
    The shopper's social security number.
    
    Parameters:
    
    socialSecurityNumber -
  - splitCardFundingSources
```
public PaymentLinkRequest splitCardFundingSources(Boolean splitCardFundingSources)
```
    Boolean value indicating whether the card payment method should be split into separate debit and credit options.
    
    Parameters:
    
    splitCardFundingSources -
    
    Returns:
    
    the current PaymentLinkRequest instance, allowing for method chaining
  - getSplitCardFundingSources
```
public Boolean getSplitCardFundingSources()
```
    Boolean value indicating whether the card payment method should be split into separate debit and credit options.
    
    Returns:
    
    splitCardFundingSources
  - setSplitCardFundingSources
```
public void setSplitCardFundingSources(Boolean splitCardFundingSources)
```
    Boolean value indicating whether the card payment method should be split into separate debit and credit options.
    
    Parameters:
    
    splitCardFundingSources -
  - splits
```
public PaymentLinkRequest splits(List<Split> splits)
```
    An array of objects specifying how to split a payment when using [Adyen for Platforms](https://docs.adyen.com/platforms/process-payments#providing-split-information), [Classic Platforms integration](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information), or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).
    
    Parameters:
    
    splits -
    
    Returns:
    
    the current PaymentLinkRequest instance, allowing for method chaining
  - addSplitsItem
```
public PaymentLinkRequest addSplitsItem(Split splitsItem)
```
  - getSplits
```
public List<Split> getSplits()
```
    An array of objects specifying how to split a payment when using [Adyen for Platforms](https://docs.adyen.com/platforms/process-payments#providing-split-information), [Classic Platforms integration](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information), or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).
    
    Returns:
    
    splits
  - setSplits
```
public void setSplits(List<Split> splits)
```
    An array of objects specifying how to split a payment when using [Adyen for Platforms](https://docs.adyen.com/platforms/process-payments#providing-split-information), [Classic Platforms integration](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information), or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).
    
    Parameters:
    
    splits -
  - store
```
public PaymentLinkRequest store(String store)
```
    The physical store, for which this payment is processed.
    
    Parameters:
    
    store -
    
    Returns:
    
    the current PaymentLinkRequest instance, allowing for method chaining
  - getStore
```
public String getStore()
```
    The physical store, for which this payment is processed.
    
    Returns:
    
    store
  - setStore
```
public void setStore(String store)
```
    The physical store, for which this payment is processed.
    
    Parameters:
    
    store -
  - storePaymentMethodMode
```
public PaymentLinkRequest storePaymentMethodMode(PaymentLinkRequest.StorePaymentMethodModeEnum storePaymentMethodMode)
```
    Indicates if the details of the payment method will be stored for the shopper. Possible values: * **disabled** – No details will be stored (default). * **askForConsent** – If the `shopperReference` is provided, the UI lets the shopper choose if they want their payment details to be stored. * **enabled** – If the `shopperReference` is provided, the details will be stored without asking the shopper for consent. When set to **askForConsent** or **enabled**, you must also include the `recurringProcessingModel` parameter.
    
    Parameters:
    
    storePaymentMethodMode -
    
    Returns:
    
    the current PaymentLinkRequest instance, allowing for method chaining
  - getStorePaymentMethodMode
```
public PaymentLinkRequest.StorePaymentMethodModeEnum getStorePaymentMethodMode()
```
    Indicates if the details of the payment method will be stored for the shopper. Possible values: * **disabled** – No details will be stored (default). * **askForConsent** – If the `shopperReference` is provided, the UI lets the shopper choose if they want their payment details to be stored. * **enabled** – If the `shopperReference` is provided, the details will be stored without asking the shopper for consent. When set to **askForConsent** or **enabled**, you must also include the `recurringProcessingModel` parameter.
    
    Returns:
    
    storePaymentMethodMode
  - setStorePaymentMethodMode
```
public void setStorePaymentMethodMode(PaymentLinkRequest.StorePaymentMethodModeEnum storePaymentMethodMode)
```
    Indicates if the details of the payment method will be stored for the shopper. Possible values: * **disabled** – No details will be stored (default). * **askForConsent** – If the `shopperReference` is provided, the UI lets the shopper choose if they want their payment details to be stored. * **enabled** – If the `shopperReference` is provided, the details will be stored without asking the shopper for consent. When set to **askForConsent** or **enabled**, you must also include the `recurringProcessingModel` parameter.
    
    Parameters:
    
    storePaymentMethodMode -
  - telephoneNumber
```
public PaymentLinkRequest telephoneNumber(String telephoneNumber)
```
    The shopper's telephone number.
    
    Parameters:
    
    telephoneNumber -
    
    Returns:
    
    the current PaymentLinkRequest instance, allowing for method chaining
  - getTelephoneNumber
```
public String getTelephoneNumber()
```
    The shopper's telephone number.
    
    Returns:
    
    telephoneNumber
  - setTelephoneNumber
```
public void setTelephoneNumber(String telephoneNumber)
```
    The shopper's telephone number.
    
    Parameters:
    
    telephoneNumber -
  - themeId
```
public PaymentLinkRequest themeId(String themeId)
```
    A [theme](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#themes) to customize the appearance of the payment page. If not specified, the payment page is rendered according to the theme set as default in your Customer Area.
    
    Parameters:
    
    themeId -
    
    Returns:
    
    the current PaymentLinkRequest instance, allowing for method chaining
  - getThemeId
```
public String getThemeId()
```
    A [theme](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#themes) to customize the appearance of the payment page. If not specified, the payment page is rendered according to the theme set as default in your Customer Area.
    
    Returns:
    
    themeId
  - setThemeId
```
public void setThemeId(String themeId)
```
    A [theme](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#themes) to customize the appearance of the payment page. If not specified, the payment page is rendered according to the theme set as default in your Customer Area.
    
    Parameters:
    
    themeId -
  - threeDS2RequestData
```
public PaymentLinkRequest threeDS2RequestData(CheckoutSessionThreeDS2RequestData threeDS2RequestData)
```
    threeDS2RequestData
    
    Parameters:
    
    threeDS2RequestData -
    
    Returns:
    
    the current PaymentLinkRequest instance, allowing for method chaining
  - getThreeDS2RequestData
```
public CheckoutSessionThreeDS2RequestData getThreeDS2RequestData()
```
    threeDS2RequestData
    
    Returns:
    
    threeDS2RequestData
  - setThreeDS2RequestData
```
public void setThreeDS2RequestData(CheckoutSessionThreeDS2RequestData threeDS2RequestData)
```
    threeDS2RequestData
    
    Parameters:
    
    threeDS2RequestData -
  - equals
```
public boolean equals(Object o)
```
    Return true if this PaymentLinkRequest object is equal to o.
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - fromJson
```
public static PaymentLinkRequest fromJson(String jsonString)
                                   throws com.fasterxml.jackson.core.JsonProcessingException
```
    Create an instance of PaymentLinkRequest given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of PaymentLinkRequest
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to PaymentLinkRequest
  - toJson
```
public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
```
    Convert an instance of PaymentLinkRequest to an JSON string
    
    Returns:
    
    JSON string
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException

Class PaymentLinkRequest

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_ALLOWED_PAYMENT_METHODS

JSON_PROPERTY_AMOUNT

JSON_PROPERTY_APPLICATION_INFO

JSON_PROPERTY_BILLING_ADDRESS

JSON_PROPERTY_BLOCKED_PAYMENT_METHODS

JSON_PROPERTY_CAPTURE_DELAY_HOURS

JSON_PROPERTY_COUNTRY_CODE

JSON_PROPERTY_DATE_OF_BIRTH

JSON_PROPERTY_DELIVER_AT

JSON_PROPERTY_DELIVERY_ADDRESS

JSON_PROPERTY_DESCRIPTION

JSON_PROPERTY_EXPIRES_AT

JSON_PROPERTY_FUND_ORIGIN

JSON_PROPERTY_FUND_RECIPIENT

JSON_PROPERTY_INSTALLMENT_OPTIONS

JSON_PROPERTY_LINE_ITEMS

JSON_PROPERTY_MANUAL_CAPTURE

JSON_PROPERTY_MCC

JSON_PROPERTY_MERCHANT_ACCOUNT

JSON_PROPERTY_MERCHANT_ORDER_REFERENCE

JSON_PROPERTY_METADATA

JSON_PROPERTY_PLATFORM_CHARGEBACK_LOGIC

JSON_PROPERTY_RECURRING_PROCESSING_MODEL

JSON_PROPERTY_REFERENCE

JSON_PROPERTY_REQUIRED_SHOPPER_FIELDS

JSON_PROPERTY_RETURN_URL

JSON_PROPERTY_REUSABLE

JSON_PROPERTY_RISK_DATA

JSON_PROPERTY_SHOPPER_EMAIL

JSON_PROPERTY_SHOPPER_LOCALE

JSON_PROPERTY_SHOPPER_NAME

JSON_PROPERTY_SHOPPER_REFERENCE

JSON_PROPERTY_SHOPPER_STATEMENT

JSON_PROPERTY_SHOW_REMOVE_PAYMENT_METHOD_BUTTON

JSON_PROPERTY_SOCIAL_SECURITY_NUMBER

JSON_PROPERTY_SPLIT_CARD_FUNDING_SOURCES

JSON_PROPERTY_SPLITS

JSON_PROPERTY_STORE

JSON_PROPERTY_STORE_PAYMENT_METHOD_MODE

JSON_PROPERTY_TELEPHONE_NUMBER

JSON_PROPERTY_THEME_ID

JSON_PROPERTY_THREE_D_S2_REQUEST_DATA

Constructor Detail

PaymentLinkRequest

Method Detail

allowedPaymentMethods

addAllowedPaymentMethodsItem

getAllowedPaymentMethods

setAllowedPaymentMethods

amount

getAmount

setAmount

applicationInfo

getApplicationInfo

setApplicationInfo

billingAddress

getBillingAddress

setBillingAddress

blockedPaymentMethods

addBlockedPaymentMethodsItem

getBlockedPaymentMethods

setBlockedPaymentMethods

captureDelayHours

getCaptureDelayHours

setCaptureDelayHours

countryCode

getCountryCode

setCountryCode

dateOfBirth

getDateOfBirth

setDateOfBirth

deliverAt

getDeliverAt