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

public class CreatePaymentLinkRequest
extends Object

CreatePaymentLinkRequest

Nested Class Summary

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

Field Summary

Fields
Modifier and Type	Field	Description
`static HashSet<String>`	`openapiFields`
`static HashSet<String>`	`openapiRequiredFields`
`static String`	`SERIALIZED_NAME_ALLOWED_PAYMENT_METHODS`
`static String`	`SERIALIZED_NAME_AMOUNT`
`static String`	`SERIALIZED_NAME_APPLICATION_INFO`
`static String`	`SERIALIZED_NAME_BILLING_ADDRESS`
`static String`	`SERIALIZED_NAME_BLOCKED_PAYMENT_METHODS`
`static String`	`SERIALIZED_NAME_CAPTURE_DELAY_HOURS`
`static String`	`SERIALIZED_NAME_COUNTRY_CODE`
`static String`	`SERIALIZED_NAME_DATE_OF_BIRTH`
`static String`	`SERIALIZED_NAME_DELIVER_AT`
`static String`	`SERIALIZED_NAME_DELIVERY_ADDRESS`
`static String`	`SERIALIZED_NAME_DESCRIPTION`
`static String`	`SERIALIZED_NAME_EXPIRES_AT`
`static String`	`SERIALIZED_NAME_INSTALLMENT_OPTIONS`
`static String`	`SERIALIZED_NAME_LINE_ITEMS`
`static String`	`SERIALIZED_NAME_MANUAL_CAPTURE`
`static String`	`SERIALIZED_NAME_MCC`
`static String`	`SERIALIZED_NAME_MERCHANT_ACCOUNT`
`static String`	`SERIALIZED_NAME_MERCHANT_ORDER_REFERENCE`
`static String`	`SERIALIZED_NAME_METADATA`
`static String`	`SERIALIZED_NAME_RECURRING_PROCESSING_MODEL`
`static String`	`SERIALIZED_NAME_REFERENCE`
`static String`	`SERIALIZED_NAME_REQUIRED_SHOPPER_FIELDS`
`static String`	`SERIALIZED_NAME_RETURN_URL`
`static String`	`SERIALIZED_NAME_REUSABLE`
`static String`	`SERIALIZED_NAME_RISK_DATA`
`static String`	`SERIALIZED_NAME_SHOPPER_EMAIL`
`static String`	`SERIALIZED_NAME_SHOPPER_LOCALE`
`static String`	`SERIALIZED_NAME_SHOPPER_NAME`
`static String`	`SERIALIZED_NAME_SHOPPER_REFERENCE`
`static String`	`SERIALIZED_NAME_SHOPPER_STATEMENT`
`static String`	`SERIALIZED_NAME_SHOW_REMOVE_PAYMENT_METHOD_BUTTON`
`static String`	`SERIALIZED_NAME_SOCIAL_SECURITY_NUMBER`
`static String`	`SERIALIZED_NAME_SPLIT_CARD_FUNDING_SOURCES`
`static String`	`SERIALIZED_NAME_SPLITS`
`static String`	`SERIALIZED_NAME_STORE`
`static String`	`SERIALIZED_NAME_STORE_PAYMENT_METHOD_MODE`
`static String`	`SERIALIZED_NAME_TELEPHONE_NUMBER`
`static String`	`SERIALIZED_NAME_THEME_ID`

Constructor Summary

Constructors
Constructor Description

CreatePaymentLinkRequest()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`CreatePaymentLinkRequest`	`addAllowedPaymentMethodsItem(String allowedPaymentMethodsItem)`
`CreatePaymentLinkRequest`	`addBlockedPaymentMethodsItem(String blockedPaymentMethodsItem)`
`CreatePaymentLinkRequest`	`addLineItemsItem(LineItem lineItemsItem)`
`CreatePaymentLinkRequest`	`addRequiredShopperFieldsItem(CreatePaymentLinkRequest.RequiredShopperFieldsEnum requiredShopperFieldsItem)`
`CreatePaymentLinkRequest`	`addSplitsItem(Split splitsItem)`
`CreatePaymentLinkRequest`	`allowedPaymentMethods(List<String> allowedPaymentMethods)`
`CreatePaymentLinkRequest`	`amount(Amount amount)`
`CreatePaymentLinkRequest`	`applicationInfo(ApplicationInfo applicationInfo)`
`CreatePaymentLinkRequest`	`billingAddress(Address billingAddress)`
`CreatePaymentLinkRequest`	`blockedPaymentMethods(List<String> blockedPaymentMethods)`
`CreatePaymentLinkRequest`	`captureDelayHours(Integer captureDelayHours)`
`CreatePaymentLinkRequest`	`countryCode(String countryCode)`
`CreatePaymentLinkRequest`	`dateOfBirth(OffsetDateTime dateOfBirth)`
`CreatePaymentLinkRequest`	`deliverAt(OffsetDateTime deliverAt)`
`CreatePaymentLinkRequest`	`deliveryAddress(Address deliveryAddress)`
`CreatePaymentLinkRequest`	`description(String description)`
`boolean`	`equals(Object o)`
`CreatePaymentLinkRequest`	`expiresAt(String expiresAt)`
`static CreatePaymentLinkRequest`	`fromJson(String jsonString)`	Create an instance of CreatePaymentLinkRequest given an JSON string
`List<String>`	`getAllowedPaymentMethods()`	List of payment methods to be presented to the shopper.
`Amount`	`getAmount()`	Get amount
`ApplicationInfo`	`getApplicationInfo()`	Get applicationInfo
`Address`	`getBillingAddress()`	Get 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.
`OffsetDateTime`	`getDateOfBirth()`	The shopper's date of birth.
`OffsetDateTime`	`getDeliverAt()`	The date and time when the purchased goods should be delivered.
`Address`	`getDeliveryAddress()`	Get deliveryAddress
`String`	`getDescription()`	A short description visible on the payment page.
`String`	`getExpiresAt()`	The date when the payment link expires.
`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.
`CreatePaymentLinkRequest.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<CreatePaymentLinkRequest.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()`	Get 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()`	Get 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 the payment should be split between accounts when using Adyen for Platforms.
`String`	`getStore()`	The physical store, for which this payment is processed.
`CreatePaymentLinkRequest.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.
`int`	`hashCode()`
`CreatePaymentLinkRequest`	`installmentOptions(Map<String,InstallmentOption> installmentOptions)`
`CreatePaymentLinkRequest`	`lineItems(List<LineItem> lineItems)`
`CreatePaymentLinkRequest`	`manualCapture(Boolean manualCapture)`
`CreatePaymentLinkRequest`	`mcc(String mcc)`
`CreatePaymentLinkRequest`	`merchantAccount(String merchantAccount)`
`CreatePaymentLinkRequest`	`merchantOrderReference(String merchantOrderReference)`
`CreatePaymentLinkRequest`	`metadata(Map<String,String> metadata)`
`CreatePaymentLinkRequest`	`putInstallmentOptionsItem(String key, InstallmentOption installmentOptionsItem)`
`CreatePaymentLinkRequest`	`putMetadataItem(String key, String metadataItem)`
`CreatePaymentLinkRequest`	`recurringProcessingModel(CreatePaymentLinkRequest.RecurringProcessingModelEnum recurringProcessingModel)`
`CreatePaymentLinkRequest`	`reference(String reference)`
`CreatePaymentLinkRequest`	`requiredShopperFields(List<CreatePaymentLinkRequest.RequiredShopperFieldsEnum> requiredShopperFields)`
`CreatePaymentLinkRequest`	`returnUrl(String returnUrl)`
`CreatePaymentLinkRequest`	`reusable(Boolean reusable)`
`CreatePaymentLinkRequest`	`riskData(RiskData riskData)`
`void`	`setAllowedPaymentMethods(List<String> allowedPaymentMethods)`
`void`	`setAmount(Amount amount)`
`void`	`setApplicationInfo(ApplicationInfo applicationInfo)`
`void`	`setBillingAddress(Address billingAddress)`
`void`	`setBlockedPaymentMethods(List<String> blockedPaymentMethods)`
`void`	`setCaptureDelayHours(Integer captureDelayHours)`
`void`	`setCountryCode(String countryCode)`
`void`	`setDateOfBirth(OffsetDateTime dateOfBirth)`
`void`	`setDeliverAt(OffsetDateTime deliverAt)`
`void`	`setDeliveryAddress(Address deliveryAddress)`
`void`	`setDescription(String description)`
`void`	`setExpiresAt(String expiresAt)`
`void`	`setInstallmentOptions(Map<String,InstallmentOption> installmentOptions)`
`void`	`setLineItems(List<LineItem> lineItems)`
`void`	`setManualCapture(Boolean manualCapture)`
`void`	`setMcc(String mcc)`
`void`	`setMerchantAccount(String merchantAccount)`
`void`	`setMerchantOrderReference(String merchantOrderReference)`
`void`	`setMetadata(Map<String,String> metadata)`
`void`	`setRecurringProcessingModel(CreatePaymentLinkRequest.RecurringProcessingModelEnum recurringProcessingModel)`
`void`	`setReference(String reference)`
`void`	`setRequiredShopperFields(List<CreatePaymentLinkRequest.RequiredShopperFieldsEnum> requiredShopperFields)`
`void`	`setReturnUrl(String returnUrl)`
`void`	`setReusable(Boolean reusable)`
`void`	`setRiskData(RiskData riskData)`
`void`	`setShopperEmail(String shopperEmail)`
`void`	`setShopperLocale(String shopperLocale)`
`void`	`setShopperName(Name shopperName)`
`void`	`setShopperReference(String shopperReference)`
`void`	`setShopperStatement(String shopperStatement)`
`void`	`setShowRemovePaymentMethodButton(Boolean showRemovePaymentMethodButton)`
`void`	`setSocialSecurityNumber(String socialSecurityNumber)`
`void`	`setSplitCardFundingSources(Boolean splitCardFundingSources)`
`void`	`setSplits(List<Split> splits)`
`void`	`setStore(String store)`
`void`	`setStorePaymentMethodMode(CreatePaymentLinkRequest.StorePaymentMethodModeEnum storePaymentMethodMode)`
`void`	`setTelephoneNumber(String telephoneNumber)`
`void`	`setThemeId(String themeId)`
`CreatePaymentLinkRequest`	`shopperEmail(String shopperEmail)`
`CreatePaymentLinkRequest`	`shopperLocale(String shopperLocale)`
`CreatePaymentLinkRequest`	`shopperName(Name shopperName)`
`CreatePaymentLinkRequest`	`shopperReference(String shopperReference)`
`CreatePaymentLinkRequest`	`shopperStatement(String shopperStatement)`
`CreatePaymentLinkRequest`	`showRemovePaymentMethodButton(Boolean showRemovePaymentMethodButton)`
`CreatePaymentLinkRequest`	`socialSecurityNumber(String socialSecurityNumber)`
`CreatePaymentLinkRequest`	`splitCardFundingSources(Boolean splitCardFundingSources)`
`CreatePaymentLinkRequest`	`splits(List<Split> splits)`
`CreatePaymentLinkRequest`	`store(String store)`
`CreatePaymentLinkRequest`	`storePaymentMethodMode(CreatePaymentLinkRequest.StorePaymentMethodModeEnum storePaymentMethodMode)`
`CreatePaymentLinkRequest`	`telephoneNumber(String telephoneNumber)`
`CreatePaymentLinkRequest`	`themeId(String themeId)`
`String`	`toJson()`	Convert an instance of CreatePaymentLinkRequest to an JSON string
`String`	`toString()`
`static void`	`validateJsonObject(com.google.gson.JsonObject jsonObj)`	Validates the JSON Object and throws an exception if issues found

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

- Field Detail
  - SERIALIZED_NAME_ALLOWED_PAYMENT_METHODS
```
public static final String SERIALIZED_NAME_ALLOWED_PAYMENT_METHODS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_AMOUNT
```
public static final String SERIALIZED_NAME_AMOUNT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_APPLICATION_INFO
```
public static final String SERIALIZED_NAME_APPLICATION_INFO
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_BILLING_ADDRESS
```
public static final String SERIALIZED_NAME_BILLING_ADDRESS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_BLOCKED_PAYMENT_METHODS
```
public static final String SERIALIZED_NAME_BLOCKED_PAYMENT_METHODS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CAPTURE_DELAY_HOURS
```
public static final String SERIALIZED_NAME_CAPTURE_DELAY_HOURS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_COUNTRY_CODE
```
public static final String SERIALIZED_NAME_COUNTRY_CODE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_DATE_OF_BIRTH
```
public static final String SERIALIZED_NAME_DATE_OF_BIRTH
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_DELIVER_AT
```
public static final String SERIALIZED_NAME_DELIVER_AT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_DELIVERY_ADDRESS
```
public static final String SERIALIZED_NAME_DELIVERY_ADDRESS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_DESCRIPTION
```
public static final String SERIALIZED_NAME_DESCRIPTION
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_EXPIRES_AT
```
public static final String SERIALIZED_NAME_EXPIRES_AT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_INSTALLMENT_OPTIONS
```
public static final String SERIALIZED_NAME_INSTALLMENT_OPTIONS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_LINE_ITEMS
```
public static final String SERIALIZED_NAME_LINE_ITEMS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_MANUAL_CAPTURE
```
public static final String SERIALIZED_NAME_MANUAL_CAPTURE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_MCC
```
public static final String SERIALIZED_NAME_MCC
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_MERCHANT_ACCOUNT
```
public static final String SERIALIZED_NAME_MERCHANT_ACCOUNT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_MERCHANT_ORDER_REFERENCE
```
public static final String SERIALIZED_NAME_MERCHANT_ORDER_REFERENCE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_METADATA
```
public static final String SERIALIZED_NAME_METADATA
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_RECURRING_PROCESSING_MODEL
```
public static final String SERIALIZED_NAME_RECURRING_PROCESSING_MODEL
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_REFERENCE
```
public static final String SERIALIZED_NAME_REFERENCE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_REQUIRED_SHOPPER_FIELDS
```
public static final String SERIALIZED_NAME_REQUIRED_SHOPPER_FIELDS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_RETURN_URL
```
public static final String SERIALIZED_NAME_RETURN_URL
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_REUSABLE
```
public static final String SERIALIZED_NAME_REUSABLE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_RISK_DATA
```
public static final String SERIALIZED_NAME_RISK_DATA
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SHOPPER_EMAIL
```
public static final String SERIALIZED_NAME_SHOPPER_EMAIL
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SHOPPER_LOCALE
```
public static final String SERIALIZED_NAME_SHOPPER_LOCALE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SHOPPER_NAME
```
public static final String SERIALIZED_NAME_SHOPPER_NAME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SHOPPER_REFERENCE
```
public static final String SERIALIZED_NAME_SHOPPER_REFERENCE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SHOPPER_STATEMENT
```
public static final String SERIALIZED_NAME_SHOPPER_STATEMENT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SHOW_REMOVE_PAYMENT_METHOD_BUTTON
```
public static final String SERIALIZED_NAME_SHOW_REMOVE_PAYMENT_METHOD_BUTTON
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SOCIAL_SECURITY_NUMBER
```
public static final String SERIALIZED_NAME_SOCIAL_SECURITY_NUMBER
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SPLIT_CARD_FUNDING_SOURCES
```
public static final String SERIALIZED_NAME_SPLIT_CARD_FUNDING_SOURCES
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SPLITS
```
public static final String SERIALIZED_NAME_SPLITS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_STORE
```
public static final String SERIALIZED_NAME_STORE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_STORE_PAYMENT_METHOD_MODE
```
public static final String SERIALIZED_NAME_STORE_PAYMENT_METHOD_MODE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TELEPHONE_NUMBER
```
public static final String SERIALIZED_NAME_TELEPHONE_NUMBER
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_THEME_ID
```
public static final String SERIALIZED_NAME_THEME_ID
```
    See Also:
    
    Constant Field Values
  - openapiFields
```
public static HashSet<String> openapiFields
```
  - openapiRequiredFields
```
public static HashSet<String> openapiRequiredFields
```
- Constructor Detail
  - CreatePaymentLinkRequest
```
public CreatePaymentLinkRequest()
```
- Method Detail
  - allowedPaymentMethods
```
public CreatePaymentLinkRequest allowedPaymentMethods(List<String> allowedPaymentMethods)
```
  - addAllowedPaymentMethodsItem
```
public CreatePaymentLinkRequest 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 `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods). Example: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`
    
    Returns:
    
    allowedPaymentMethods
  - setAllowedPaymentMethods
```
public void setAllowedPaymentMethods(List<String> allowedPaymentMethods)
```
  - amount
```
public CreatePaymentLinkRequest amount(Amount amount)
```
  - getAmount
```
public Amount getAmount()
```
    Get amount
    
    Returns:
    
    amount
  - setAmount
```
public void setAmount(Amount amount)
```
  - applicationInfo
```
public CreatePaymentLinkRequest applicationInfo(ApplicationInfo applicationInfo)
```
  - getApplicationInfo
```
public ApplicationInfo getApplicationInfo()
```
    Get applicationInfo
    
    Returns:
    
    applicationInfo
  - setApplicationInfo
```
public void setApplicationInfo(ApplicationInfo applicationInfo)
```
  - billingAddress
```
public CreatePaymentLinkRequest billingAddress(Address billingAddress)
```
  - getBillingAddress
```
public Address getBillingAddress()
```
    Get billingAddress
    
    Returns:
    
    billingAddress
  - setBillingAddress
```
public void setBillingAddress(Address billingAddress)
```
  - blockedPaymentMethods
```
public CreatePaymentLinkRequest blockedPaymentMethods(List<String> blockedPaymentMethods)
```
  - addBlockedPaymentMethodsItem
```
public CreatePaymentLinkRequest 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 `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods). Example: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`
    
    Returns:
    
    blockedPaymentMethods
  - setBlockedPaymentMethods
```
public void setBlockedPaymentMethods(List<String> blockedPaymentMethods)
```
  - captureDelayHours
```
public CreatePaymentLinkRequest captureDelayHours(Integer captureDelayHours)
```
  - getCaptureDelayHours
```
public Integer getCaptureDelayHours()
```
    The delay between the authorisation and scheduled auto-capture, specified in hours.
    
    Returns:
    
    captureDelayHours
  - setCaptureDelayHours
```
public void setCaptureDelayHours(Integer captureDelayHours)
```
  - countryCode
```
public CreatePaymentLinkRequest countryCode(String countryCode)
```
  - getCountryCode
```
public String getCountryCode()
```
    The shopper's two-letter country code.
    
    Returns:
    
    countryCode
  - setCountryCode
```
public void setCountryCode(String countryCode)
```
  - dateOfBirth
```
public CreatePaymentLinkRequest dateOfBirth(OffsetDateTime dateOfBirth)
```
  - getDateOfBirth
```
public OffsetDateTime 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(OffsetDateTime dateOfBirth)
```
  - deliverAt
```
public CreatePaymentLinkRequest deliverAt(OffsetDateTime deliverAt)
```
  - 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)
```
  - deliveryAddress
```
public CreatePaymentLinkRequest deliveryAddress(Address deliveryAddress)
```
  - getDeliveryAddress
```
public Address getDeliveryAddress()
```
    Get deliveryAddress
    
    Returns:
    
    deliveryAddress
  - setDeliveryAddress
```
public void setDeliveryAddress(Address deliveryAddress)
```
  - description
```
public CreatePaymentLinkRequest description(String description)
```
  - getDescription
```
public String getDescription()
```
    A short description visible on the payment page. Maximum length: 280 characters.
    
    Returns:
    
    description
  - setDescription
```
public void setDescription(String description)
```
  - expiresAt
```
public CreatePaymentLinkRequest expiresAt(String expiresAt)
```
  - getExpiresAt
```
public String getExpiresAt()
```
    The date when the payment link expires. [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**. 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(String expiresAt)
```
  - installmentOptions
```
public CreatePaymentLinkRequest installmentOptions(Map<String,InstallmentOption> installmentOptions)
```
  - putInstallmentOptionsItem
```
public CreatePaymentLinkRequest 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)
```
  - lineItems
```
public CreatePaymentLinkRequest lineItems(List<LineItem> lineItems)
```
  - addLineItemsItem
```
public CreatePaymentLinkRequest 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, and Zip.
    
    Returns:
    
    lineItems
  - setLineItems
```
public void setLineItems(List<LineItem> lineItems)
```
  - manualCapture
```
public CreatePaymentLinkRequest manualCapture(Boolean manualCapture)
```
  - 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)
```
  - mcc
```
public CreatePaymentLinkRequest mcc(String mcc)
```
  - 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)
```
  - merchantAccount
```
public CreatePaymentLinkRequest merchantAccount(String merchantAccount)
```
  - getMerchantAccount
```
public String getMerchantAccount()
```
    The merchant account identifier for which the payment link is created.
    
    Returns:
    
    merchantAccount
  - setMerchantAccount
```
public void setMerchantAccount(String merchantAccount)
```
  - merchantOrderReference
```
public CreatePaymentLinkRequest merchantOrderReference(String merchantOrderReference)
```
  - 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)
```
  - metadata
```
public CreatePaymentLinkRequest metadata(Map<String,String> metadata)
```
  - putMetadataItem
```
public CreatePaymentLinkRequest 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)
```
  - recurringProcessingModel
```
public CreatePaymentLinkRequest recurringProcessingModel(CreatePaymentLinkRequest.RecurringProcessingModelEnum recurringProcessingModel)
```
  - getRecurringProcessingModel
```
public CreatePaymentLinkRequest.RecurringProcessingModelEnum getRecurringProcessingModel()
```
    Defines a recurring payment type. 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(CreatePaymentLinkRequest.RecurringProcessingModelEnum recurringProcessingModel)
```
  - reference
```
public CreatePaymentLinkRequest reference(String reference)
```
  - 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)
```
  - requiredShopperFields
```
public CreatePaymentLinkRequest requiredShopperFields(List<CreatePaymentLinkRequest.RequiredShopperFieldsEnum> requiredShopperFields)
```
  - addRequiredShopperFieldsItem
```
public CreatePaymentLinkRequest addRequiredShopperFieldsItem(CreatePaymentLinkRequest.RequiredShopperFieldsEnum requiredShopperFieldsItem)
```
  - getRequiredShopperFields
```
public List<CreatePaymentLinkRequest.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<CreatePaymentLinkRequest.RequiredShopperFieldsEnum> requiredShopperFields)
```
  - returnUrl
```
public CreatePaymentLinkRequest returnUrl(String returnUrl)
```
  - 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)
```
  - reusable
```
public CreatePaymentLinkRequest reusable(Boolean reusable)
```
  - 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)
```
  - riskData
```
public CreatePaymentLinkRequest riskData(RiskData riskData)
```
  - getRiskData
```
public RiskData getRiskData()
```
    Get riskData
    
    Returns:
    
    riskData
  - setRiskData
```
public void setRiskData(RiskData riskData)
```
  - shopperEmail
```
public CreatePaymentLinkRequest shopperEmail(String shopperEmail)
```
  - getShopperEmail
```
public String getShopperEmail()
```
    The shopper's email address.
    
    Returns:
    
    shopperEmail
  - setShopperEmail
```
public void setShopperEmail(String shopperEmail)
```
  - shopperLocale
```
public CreatePaymentLinkRequest shopperLocale(String shopperLocale)
```
  - 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/online-payments/pay-by-link#language-and-localization).
    
    Returns:
    
    shopperLocale
  - setShopperLocale
```
public void setShopperLocale(String shopperLocale)
```
  - shopperName
```
public CreatePaymentLinkRequest shopperName(Name shopperName)
```
  - getShopperName
```
public Name getShopperName()
```
    Get shopperName
    
    Returns:
    
    shopperName
  - setShopperName
```
public void setShopperName(Name shopperName)
```
  - shopperReference
```
public CreatePaymentLinkRequest shopperReference(String shopperReference)
```
  - 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)
```
  - shopperStatement
```
public CreatePaymentLinkRequest shopperStatement(String shopperStatement)
```
  - 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)
```
  - showRemovePaymentMethodButton
```
public CreatePaymentLinkRequest showRemovePaymentMethodButton(Boolean showRemovePaymentMethodButton)
```
  - 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)
```
  - socialSecurityNumber
```
public CreatePaymentLinkRequest socialSecurityNumber(String socialSecurityNumber)
```
  - getSocialSecurityNumber
```
public String getSocialSecurityNumber()
```
    The shopper's social security number.
    
    Returns:
    
    socialSecurityNumber
  - setSocialSecurityNumber
```
public void setSocialSecurityNumber(String socialSecurityNumber)
```
  - splitCardFundingSources
```
public CreatePaymentLinkRequest splitCardFundingSources(Boolean splitCardFundingSources)
```
  - 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)
```
  - splits
```
public CreatePaymentLinkRequest splits(List<Split> splits)
```
  - addSplitsItem
```
public CreatePaymentLinkRequest addSplitsItem(Split splitsItem)
```
  - getSplits
```
public List<Split> getSplits()
```
    An array of objects specifying how the payment should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).
    
    Returns:
    
    splits
  - setSplits
```
public void setSplits(List<Split> splits)
```
  - store
```
public CreatePaymentLinkRequest store(String store)
```
  - getStore
```
public String getStore()
```
    The physical store, for which this payment is processed.
    
    Returns:
    
    store
  - setStore
```
public void setStore(String store)
```
  - storePaymentMethodMode
```
public CreatePaymentLinkRequest storePaymentMethodMode(CreatePaymentLinkRequest.StorePaymentMethodModeEnum storePaymentMethodMode)
```
  - getStorePaymentMethodMode
```
public CreatePaymentLinkRequest.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.
    
    Returns:
    
    storePaymentMethodMode
  - setStorePaymentMethodMode
```
public void setStorePaymentMethodMode(CreatePaymentLinkRequest.StorePaymentMethodModeEnum storePaymentMethodMode)
```
  - telephoneNumber
```
public CreatePaymentLinkRequest telephoneNumber(String telephoneNumber)
```
  - getTelephoneNumber
```
public String getTelephoneNumber()
```
    The shopper's telephone number.
    
    Returns:
    
    telephoneNumber
  - setTelephoneNumber
```
public void setTelephoneNumber(String telephoneNumber)
```
  - themeId
```
public CreatePaymentLinkRequest themeId(String themeId)
```
  - 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)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - validateJsonObject
```
public static void validateJsonObject(com.google.gson.JsonObject jsonObj)
                               throws IOException
```
    Validates the JSON Object and throws an exception if issues found
    
    Parameters:
    
    jsonObj - JSON Object
    
    Throws:
    
    IOException - if the JSON Object is invalid with respect to CreatePaymentLinkRequest
  - fromJson
```
public static CreatePaymentLinkRequest fromJson(String jsonString)
                                         throws IOException
```
    Create an instance of CreatePaymentLinkRequest given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of CreatePaymentLinkRequest
    
    Throws:
    
    IOException - if the JSON string is invalid with respect to CreatePaymentLinkRequest
  - toJson
```
public String toJson()
```
    Convert an instance of CreatePaymentLinkRequest to an JSON string
    
    Returns:
    
    JSON string

Class CreatePaymentLinkRequest

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_ALLOWED_PAYMENT_METHODS

SERIALIZED_NAME_AMOUNT

SERIALIZED_NAME_APPLICATION_INFO

SERIALIZED_NAME_BILLING_ADDRESS

SERIALIZED_NAME_BLOCKED_PAYMENT_METHODS

SERIALIZED_NAME_CAPTURE_DELAY_HOURS

SERIALIZED_NAME_COUNTRY_CODE

SERIALIZED_NAME_DATE_OF_BIRTH

SERIALIZED_NAME_DELIVER_AT

SERIALIZED_NAME_DELIVERY_ADDRESS

SERIALIZED_NAME_DESCRIPTION

SERIALIZED_NAME_EXPIRES_AT

SERIALIZED_NAME_INSTALLMENT_OPTIONS

SERIALIZED_NAME_LINE_ITEMS

SERIALIZED_NAME_MANUAL_CAPTURE

SERIALIZED_NAME_MCC

SERIALIZED_NAME_MERCHANT_ACCOUNT

SERIALIZED_NAME_MERCHANT_ORDER_REFERENCE

SERIALIZED_NAME_METADATA

SERIALIZED_NAME_RECURRING_PROCESSING_MODEL

SERIALIZED_NAME_REFERENCE

SERIALIZED_NAME_REQUIRED_SHOPPER_FIELDS

SERIALIZED_NAME_RETURN_URL

SERIALIZED_NAME_REUSABLE

SERIALIZED_NAME_RISK_DATA

SERIALIZED_NAME_SHOPPER_EMAIL

SERIALIZED_NAME_SHOPPER_LOCALE

SERIALIZED_NAME_SHOPPER_NAME

SERIALIZED_NAME_SHOPPER_REFERENCE

SERIALIZED_NAME_SHOPPER_STATEMENT

SERIALIZED_NAME_SHOW_REMOVE_PAYMENT_METHOD_BUTTON

SERIALIZED_NAME_SOCIAL_SECURITY_NUMBER

SERIALIZED_NAME_SPLIT_CARD_FUNDING_SOURCES

SERIALIZED_NAME_SPLITS

SERIALIZED_NAME_STORE

SERIALIZED_NAME_STORE_PAYMENT_METHOD_MODE

SERIALIZED_NAME_TELEPHONE_NUMBER

SERIALIZED_NAME_THEME_ID

openapiFields

openapiRequiredFields

Constructor Detail

CreatePaymentLinkRequest

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

setDeliverAt

deliveryAddress