PaymentLinkResource (Adyen Java API Library 17.3.0 API)

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

public class PaymentLinkResource
extends Object

PaymentLinkResource

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`PaymentLinkResource.RecurringProcessingModelEnum` Defines a recurring payment type.
`static class`	`PaymentLinkResource.StatusEnum` Status of the payment link.

Constructor Summary

Constructors
Constructor and Description

PaymentLinkResource()

Constructors
Constructor and Description
`PaymentLinkResource()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PaymentLinkResource`	`addAllowedPaymentMethodsItem(String allowedPaymentMethodsItem)`
`PaymentLinkResource`	`addBlockedPaymentMethodsItem(String blockedPaymentMethodsItem)`
`PaymentLinkResource`	`addLineItemsItem(LineItem lineItemsItem)`
`PaymentLinkResource`	`addSplitsItem(Split splitsItem)`
`PaymentLinkResource`	`allowedPaymentMethods(List<String> allowedPaymentMethods)`
`PaymentLinkResource`	`amount(Amount amount)`
`PaymentLinkResource`	`applicationInfo(ApplicationInfo applicationInfo)`
`PaymentLinkResource`	`billingAddress(Address billingAddress)`
`PaymentLinkResource`	`blockedPaymentMethods(List<String> blockedPaymentMethods)`
`PaymentLinkResource`	`countryCode(String countryCode)`
`PaymentLinkResource`	`deliverAt(String deliverAt)`
`PaymentLinkResource`	`deliveryAddress(Address deliveryAddress)`
`PaymentLinkResource`	`description(String description)`
`boolean`	`equals(Object o)`
`PaymentLinkResource`	`expiresAt(String expiresAt)`
`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.
`String`	`getCountryCode()` The shopper's two-letter country code.
`String`	`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.
`String`	`getId()` A unique identifier of the payment link.
`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).
`PaymentLinkResource.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()` An array of objects specifying how the payment should be split between accounts when using Adyen for Platforms.
`PaymentLinkResource.StatusEnum`	`getStatus()` Status of the payment link.
`String`	`getStore()` The physical store, for which this payment is processed.
`String`	`getUrl()` The URL at which the shopper can complete the payment.
`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.
`PaymentLinkResource`	`lineItems(List<LineItem> lineItems)`
`PaymentLinkResource`	`merchantAccount(String merchantAccount)`
`PaymentLinkResource`	`merchantOrderReference(String merchantOrderReference)`
`PaymentLinkResource`	`recurringProcessingModel(PaymentLinkResource.RecurringProcessingModelEnum recurringProcessingModel)`
`PaymentLinkResource`	`reference(String reference)`
`PaymentLinkResource`	`returnUrl(String returnUrl)`
`PaymentLinkResource`	`reusable(Boolean reusable)`
`PaymentLinkResource`	`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(String 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`	`setRecurringProcessingModel(PaymentLinkResource.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`	`setStatus(PaymentLinkResource.StatusEnum status)`
`void`	`setStore(String store)`
`void`	`setStorePaymentMethod(Boolean storePaymentMethod)`
`PaymentLinkResource`	`shopperEmail(String shopperEmail)`
`PaymentLinkResource`	`shopperLocale(String shopperLocale)`
`PaymentLinkResource`	`shopperName(Name shopperName)`
`PaymentLinkResource`	`shopperReference(String shopperReference)`
`PaymentLinkResource`	`splits(List<Split> splits)`
`PaymentLinkResource`	`status(PaymentLinkResource.StatusEnum status)`
`PaymentLinkResource`	`store(String store)`
`PaymentLinkResource`	`storePaymentMethod(Boolean storePaymentMethod)`
`String`	`toString()`

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

- Constructor Detail
  - PaymentLinkResource
```
public PaymentLinkResource()
```
- Method Detail
  - allowedPaymentMethods
```
public PaymentLinkResource allowedPaymentMethods(List<String> allowedPaymentMethods)
```
  - addAllowedPaymentMethodsItem
```
public PaymentLinkResource 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 PaymentLinkResource amount(Amount amount)
```
  - getAmount
```
public Amount getAmount()
```
    Get amount
    
    Returns:
    
    amount
  - setAmount
```
public void setAmount(Amount amount)
```
  - applicationInfo
```
public PaymentLinkResource applicationInfo(ApplicationInfo applicationInfo)
```
  - getApplicationInfo
```
public ApplicationInfo getApplicationInfo()
```
    Get applicationInfo
    
    Returns:
    
    applicationInfo
  - setApplicationInfo
```
public void setApplicationInfo(ApplicationInfo applicationInfo)
```
  - billingAddress
```
public PaymentLinkResource billingAddress(Address billingAddress)
```
  - getBillingAddress
```
public Address getBillingAddress()
```
    Get billingAddress
    
    Returns:
    
    billingAddress
  - setBillingAddress
```
public void setBillingAddress(Address billingAddress)
```
  - blockedPaymentMethods
```
public PaymentLinkResource blockedPaymentMethods(List<String> blockedPaymentMethods)
```
  - addBlockedPaymentMethodsItem
```
public PaymentLinkResource 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)
```
  - countryCode
```
public PaymentLinkResource countryCode(String countryCode)
```
  - getCountryCode
```
public String getCountryCode()
```
    The shopper's two-letter country code.
    
    Returns:
    
    countryCode
  - setCountryCode
```
public void setCountryCode(String countryCode)
```
  - deliverAt
```
public PaymentLinkResource deliverAt(String deliverAt)
```
  - getDeliverAt
```
public String getDeliverAt()
```
    The date and time the purchased goods should be delivered. In ISO 8601 format. For example `2019-11-23T12:25:28Z`, or `2020-05-27T20:25:28+08:00`.
    
    Returns:
    
    deliverAt
  - setDeliverAt
```
public void setDeliverAt(String deliverAt)
```
  - deliveryAddress
```
public PaymentLinkResource deliveryAddress(Address deliveryAddress)
```
  - getDeliveryAddress
```
public Address getDeliveryAddress()
```
    Get deliveryAddress
    
    Returns:
    
    deliveryAddress
  - setDeliveryAddress
```
public void setDeliveryAddress(Address deliveryAddress)
```
  - description
```
public PaymentLinkResource 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 PaymentLinkResource 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 70 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)
```
  - getId
```
public String getId()
```
    A unique identifier of the payment link.
    
    Returns:
    
    id
  - lineItems
```
public PaymentLinkResource lineItems(List<LineItem> lineItems)
```
  - addLineItemsItem
```
public PaymentLinkResource 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 PaymentLinkResource 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 PaymentLinkResource 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)
```
  - recurringProcessingModel
```
public PaymentLinkResource recurringProcessingModel(PaymentLinkResource.RecurringProcessingModelEnum recurringProcessingModel)
```
  - getRecurringProcessingModel
```
public PaymentLinkResource.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(PaymentLinkResource.RecurringProcessingModelEnum recurringProcessingModel)
```
  - reference
```
public PaymentLinkResource 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 PaymentLinkResource 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 PaymentLinkResource 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 PaymentLinkResource riskData(RiskData riskData)
```
  - getRiskData
```
public RiskData getRiskData()
```
    Get riskData
    
    Returns:
    
    riskData
  - setRiskData
```
public void setRiskData(RiskData riskData)
```
  - shopperEmail
```
public PaymentLinkResource shopperEmail(String shopperEmail)
```
  - getShopperEmail
```
public String getShopperEmail()
```
    The shopper's email address.
    
    Returns:
    
    shopperEmail
  - setShopperEmail
```
public void setShopperEmail(String shopperEmail)
```
  - shopperLocale
```
public PaymentLinkResource 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 PaymentLinkResource shopperName(Name shopperName)
```
  - getShopperName
```
public Name getShopperName()
```
    Get shopperName
    
    Returns:
    
    shopperName
  - setShopperName
```
public void setShopperName(Name shopperName)
```
  - shopperReference
```
public PaymentLinkResource 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 PaymentLinkResource splits(List<Split> splits)
```
  - addSplitsItem
```
public PaymentLinkResource 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/platforms/processing-payments#providing-split-information).
    
    Returns:
    
    splits
  - setSplits
```
public void setSplits(List<Split> splits)
```
  - status
```
public PaymentLinkResource status(PaymentLinkResource.StatusEnum status)
```
  - getStatus
```
public PaymentLinkResource.StatusEnum getStatus()
```
    Status of the payment link. Possible values: * **active** * **expired** * **completed** (v66 and above) * **paid** (v65 and below)
    
    Returns:
    
    status
  - setStatus
```
public void setStatus(PaymentLinkResource.StatusEnum status)
```
  - store
```
public PaymentLinkResource 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 PaymentLinkResource 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)
```
  - getUrl
```
public String getUrl()
```
    The URL at which the shopper can complete the payment.
    
    Returns:
    
    url
  - 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 PaymentLinkResource

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PaymentLinkResource

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

getId

lineItems

addLineItemsItem

getLineItems

setLineItems

merchantAccount

getMerchantAccount

setMerchantAccount

merchantOrderReference

getMerchantOrderReference

setMerchantOrderReference

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

setShopperReference

splits

addSplitsItem