Package com.adyen.model.checkout

Class PaymentLinkRequest

  • public class PaymentLinkRequest
extends Object
    PaymentLinkRequest

    • Constructor Detail

      • PaymentLinkRequest

        public PaymentLinkRequest()

    • Method Detail

      • 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 -

      • getAmount

        public Amount getAmount()
        Get amount
        Returns:
        amount

      • setAmount

        public void setAmount​(Amount amount)
        amount
        Parameters:
        amount -

      • getApplicationInfo

        public ApplicationInfo getApplicationInfo()
        Get applicationInfo
        Returns:
        applicationInfo

      • setApplicationInfo

        public void setApplicationInfo​(ApplicationInfo applicationInfo)
        applicationInfo
        Parameters:
        applicationInfo -

      • getBillingAddress

        public Address getBillingAddress()
        Get billingAddress
        Returns:
        billingAddress

      • setBillingAddress

        public void setBillingAddress​(Address billingAddress)
        billingAddress
        Parameters:
        billingAddress -

      • 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 -

      • 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 -

      • 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 -

      • 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 -

      • 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 -

      • getDeliveryAddress

        public Address getDeliveryAddress()
        Get deliveryAddress
        Returns:
        deliveryAddress

      • setDeliveryAddress

        public void setDeliveryAddress​(Address deliveryAddress)
        deliveryAddress
        Parameters:
        deliveryAddress -

      • 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 -

      • 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 -

      • 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 -

      • 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)
        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.
        Parameters:
        lineItems -

      • 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 -

      • 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 -

      • 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 -

      • 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 -

      • 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 -

      • getPlatformChargebackLogic

        public PlatformChargebackLogic getPlatformChargebackLogic()
        Get platformChargebackLogic
        Returns:
        platformChargebackLogic

      • setPlatformChargebackLogic

        public void setPlatformChargebackLogic​(PlatformChargebackLogic platformChargebackLogic)
        platformChargebackLogic
        Parameters:
        platformChargebackLogic -

      • 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 -

      • 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 -

      • 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 -

      • 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 -

      • 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 -

      • getRiskData

        public RiskData getRiskData()
        Get riskData
        Returns:
        riskData

      • setRiskData

        public void setRiskData​(RiskData riskData)
        riskData
        Parameters:
        riskData -

      • getShopperEmail

        public String getShopperEmail()
        The shopper's email address.
        Returns:
        shopperEmail

      • setShopperEmail

        public void setShopperEmail​(String shopperEmail)
        The shopper's email address.
        Parameters:
        shopperEmail -

      • 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 -

      • getShopperName

        public Name getShopperName()
        Get shopperName
        Returns:
        shopperName

      • setShopperName

        public void setShopperName​(Name shopperName)
        shopperName
        Parameters:
        shopperName -

      • 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 -

      • 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)

      • 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 -

      • 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 -

      • 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 -

      • 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 -

      • 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 -

      • 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 -

      • getTelephoneNumber

        public String getTelephoneNumber()
        The shopper's telephone number.
        Returns:
        telephoneNumber

      • setTelephoneNumber

        public void setTelephoneNumber​(String telephoneNumber)
        The shopper's telephone number.
        Parameters:
        telephoneNumber -

      • 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 -

      • 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

      • 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