CreatePaymentLinkRequest (Adyen Java API Library 11.0.1 API)

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

public class CreatePaymentLinkRequest
extends Object

CreatePaymentLinkRequest

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CreatePaymentLinkRequest.RecurringProcessingModelEnum
Defines a recurring payment type.

Nested Classes
Modifier and Type	Class and Description
`static class`	`CreatePaymentLinkRequest.RecurringProcessingModelEnum` Defines a recurring payment type.

Constructor Summary

Constructors
Constructor and Description

CreatePaymentLinkRequest()

Constructors
Constructor and Description
`CreatePaymentLinkRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreatePaymentLinkRequest`	`addAllowedPaymentMethodsItem(String allowedPaymentMethodsItem)`
`CreatePaymentLinkRequest`	`addBlockedPaymentMethodsItem(String blockedPaymentMethodsItem)`
`CreatePaymentLinkRequest`	`addLineItemsItem(LineItem lineItemsItem)`
`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`	`countryCode(String countryCode)`
`CreatePaymentLinkRequest`	`deliverAt(Date deliverAt)`
`CreatePaymentLinkRequest`	`deliveryAddress(Address deliveryAddress)`
`CreatePaymentLinkRequest`	`description(String description)`
`boolean`	`equals(Object o)`
`CreatePaymentLinkRequest`	`expiresAt(String expiresAt)`
`List<String>`	`getAllowedPaymentMethods()` List of payments methods to be presented to the shopper.
`Amount`	`getAmount()` Get amount
`ApplicationInfo`	`getApplicationInfo()` Get applicationInfo
`Address`	`getBillingAddress()` Get billingAddress
`List<String>`	`getBlockedPaymentMethods()` List of payments methods to be hidden from the shopper.
`String`	`getCountryCode()` The shopper's two-letter country code.
`Date`	`getDeliverAt()` The date and time the purchased goods should be delivered.
`Address`	`getDeliveryAddress()` Get deliveryAddress
`String`	`getDescription()` A short description visible on the payment page.
`String`	`getExpiresAt()` The date that the payment link expires, in ISO 8601 format.
`List<LineItem>`	`getLineItems()` Price and product information about the purchased items, to be included on the invoice sent to the shopper.
`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.
`String`	`getReturnUrl()` Website URL used for redirection after payment is completed.
`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()` A unique identifier for the shopper (for example, user ID or account ID).
`List<Split>`	`getSplits()` Information on how the payment should be split between accounts when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information).
`String`	`getStore()` The physical store, for which this payment is processed.
`int`	`hashCode()`
`Boolean`	`isReusable()` Indicates whether the payment link can be reused for multiple payments.
`Boolean`	`isStorePaymentMethod()` When this is set to true and the `shopperReference` is provided, the payment details will be stored.
`CreatePaymentLinkRequest`	`lineItems(List<LineItem> lineItems)`
`CreatePaymentLinkRequest`	`merchantAccount(String merchantAccount)`
`CreatePaymentLinkRequest`	`merchantOrderReference(String merchantOrderReference)`
`CreatePaymentLinkRequest`	`metadata(Map<String,String> metadata)`
`CreatePaymentLinkRequest`	`putMetadataItem(String key, String metadataItem)`
`CreatePaymentLinkRequest`	`recurringProcessingModel(CreatePaymentLinkRequest.RecurringProcessingModelEnum recurringProcessingModel)`
`CreatePaymentLinkRequest`	`reference(String reference)`
`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`	`setCountryCode(String countryCode)`
`void`	`setDeliverAt(Date deliverAt)`
`void`	`setDeliveryAddress(Address deliveryAddress)`
`void`	`setDescription(String description)`
`void`	`setExpiresAt(String expiresAt)`
`void`	`setLineItems(List<LineItem> lineItems)`
`void`	`setMerchantAccount(String merchantAccount)`
`void`	`setMerchantOrderReference(String merchantOrderReference)`
`void`	`setMetadata(Map<String,String> metadata)`
`void`	`setRecurringProcessingModel(CreatePaymentLinkRequest.RecurringProcessingModelEnum recurringProcessingModel)`
`void`	`setReference(String reference)`
`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`	`setSplits(List<Split> splits)`
`void`	`setStore(String store)`
`void`	`setStorePaymentMethod(Boolean storePaymentMethod)`
`CreatePaymentLinkRequest`	`shopperEmail(String shopperEmail)`
`CreatePaymentLinkRequest`	`shopperLocale(String shopperLocale)`
`CreatePaymentLinkRequest`	`shopperName(Name shopperName)`
`CreatePaymentLinkRequest`	`shopperReference(String shopperReference)`
`CreatePaymentLinkRequest`	`splits(List<Split> splits)`
`CreatePaymentLinkRequest`	`store(String store)`
`CreatePaymentLinkRequest`	`storePaymentMethod(Boolean storePaymentMethod)`
`String`	`toString()`

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

- 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 payments 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 payments 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)
```
  - 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)
```
  - deliverAt
```
public CreatePaymentLinkRequest deliverAt(Date deliverAt)
```
  - getDeliverAt
```
public Date getDeliverAt()
```
    The date and time the purchased goods should be delivered.
    
    Returns:
    
    deliverAt
  - setDeliverAt
```
public void setDeliverAt(Date 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 that the payment link expires, in ISO 8601 format. For example `2019-11-23T12:25:28Z`, or `2020-05-27T20:25:28+08:00`. Maximum expiry date should be 30 days from when the payment link is created. If not provided, the default expiry is set to 24 hours after the payment link is created.
    
    Returns:
    
    expiresAt
  - setExpiresAt
```
public void setExpiresAt(String expiresAt)
```
  - 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, Klarna, RatePay, and Zip.
    
    Returns:
    
    lineItems
  - setLineItems
```
public void setLineItems(List<LineItem> lineItems)
```
  - 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. When exceeding, the \"177\" error occurs: \"Metadata size exceeds limit\" * Maximum 20 characters per key. When exceeding, the \"178\" error occurs: \"Metadata key size exceeds limit\" * A key cannot have the name `checkout.linkId`. Whatever value is present under that key is going to be replaced by the real 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. Allowed 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)
```
  - 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)
```
  - isReusable
```
public Boolean isReusable()
```
    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/checkout/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()
```
    A unique identifier for the shopper (for example, user ID or account ID).
    
    Returns:
    
    shopperReference
  - setShopperReference
```
public void setShopperReference(String shopperReference)
```
  - splits
```
public CreatePaymentLinkRequest splits(List<Split> splits)
```
  - addSplitsItem
```
public CreatePaymentLinkRequest addSplitsItem(Split splitsItem)
```
  - getSplits
```
public List<Split> getSplits()
```
    Information on how the payment should be split between accounts when using [Adyen for Platforms](https://docs.adyen.com/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)
```
  - storePaymentMethod
```
public CreatePaymentLinkRequest storePaymentMethod(Boolean storePaymentMethod)
```
  - isStorePaymentMethod
```
public Boolean isStorePaymentMethod()
```
    When this is set to **true** and the `shopperReference` is provided, the payment details will be stored.
    
    Returns:
    
    storePaymentMethod
  - setStorePaymentMethod
```
public void setStorePaymentMethod(Boolean storePaymentMethod)
```
  - 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

Class CreatePaymentLinkRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CreatePaymentLinkRequest

Method Detail

allowedPaymentMethods

addAllowedPaymentMethodsItem

getAllowedPaymentMethods

setAllowedPaymentMethods

amount

getAmount

setAmount

applicationInfo

getApplicationInfo

setApplicationInfo

billingAddress

getBillingAddress

setBillingAddress

blockedPaymentMethods

addBlockedPaymentMethodsItem

getBlockedPaymentMethods

setBlockedPaymentMethods

countryCode

getCountryCode

setCountryCode

deliverAt

getDeliverAt

setDeliverAt

deliveryAddress

getDeliveryAddress

setDeliveryAddress

description

getDescription

setDescription

expiresAt

getExpiresAt

setExpiresAt

lineItems

addLineItemsItem

getLineItems

setLineItems

merchantAccount

getMerchantAccount

setMerchantAccount

merchantOrderReference

getMerchantOrderReference

setMerchantOrderReference

metadata

putMetadataItem

getMetadata

setMetadata

recurringProcessingModel

getRecurringProcessingModel

setRecurringProcessingModel

reference

getReference

setReference

returnUrl

getReturnUrl

setReturnUrl

reusable

isReusable

setReusable

riskData

getRiskData

setRiskData

shopperEmail

getShopperEmail

setShopperEmail

shopperLocale

getShopperLocale

setShopperLocale

shopperName

getShopperName

setShopperName

shopperReference

getShopperReference