Class CreatePaymentLinkRequest


  • public class CreatePaymentLinkRequest
    extends Object
    CreatePaymentLinkRequest
    • Constructor Detail

      • CreatePaymentLinkRequest

        public CreatePaymentLinkRequest()
    • Method Detail

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

        public Amount getAmount()
        Get amount
        Returns:
        amount
      • setAmount

        public void setAmount​(Amount amount)
      • getApplicationInfo

        public ApplicationInfo getApplicationInfo()
        Get applicationInfo
        Returns:
        applicationInfo
      • setApplicationInfo

        public void setApplicationInfo​(ApplicationInfo applicationInfo)
      • getBillingAddress

        public Address getBillingAddress()
        Get billingAddress
        Returns:
        billingAddress
      • setBillingAddress

        public void setBillingAddress​(Address billingAddress)
      • 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)
      • getCountryCode

        public String getCountryCode()
        The shopper's two-letter country code.
        Returns:
        countryCode
      • setCountryCode

        public void setCountryCode​(String countryCode)
      • getDeliverAt

        public Date getDeliverAt()
        The date and time the purchased goods should be delivered.
        Returns:
        deliverAt
      • setDeliverAt

        public void setDeliverAt​(Date deliverAt)
      • getDeliveryAddress

        public Address getDeliveryAddress()
        Get deliveryAddress
        Returns:
        deliveryAddress
      • setDeliveryAddress

        public void setDeliveryAddress​(Address 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)
      • 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)
      • 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
      • 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)
      • getMerchantAccount

        public String getMerchantAccount()
        The merchant account identifier for which the payment link is created.
        Returns:
        merchantAccount
      • setMerchantAccount

        public void setMerchantAccount​(String 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)
      • 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)
      • 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
      • 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)
      • 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/online-payments/pay-by-link/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
      • 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)
      • 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)
      • getRiskData

        public RiskData getRiskData()
        Get riskData
        Returns:
        riskData
      • setRiskData

        public void setRiskData​(RiskData riskData)
      • getShopperEmail

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

        public void setShopperEmail​(String 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/online-payments/pay-by-link#language-and-localization).
        Returns:
        shopperLocale
      • setShopperLocale

        public void setShopperLocale​(String shopperLocale)
      • getShopperName

        public Name getShopperName()
        Get shopperName
        Returns:
        shopperName
      • setShopperName

        public void setShopperName​(Name shopperName)
      • getShopperReference

        public String getShopperReference()
        Your reference to uniquely identify this shopper (for example, user ID or account ID). Minimum length: 3 characters.
        Returns:
        shopperReference
      • setShopperReference

        public void setShopperReference​(String shopperReference)
      • 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)
      • getStore

        public String getStore()
        The physical store, for which this payment is processed.
        Returns:
        store
      • setStore

        public void setStore​(String store)
      • 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)
      • 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.* **askForConsent** – If the `shopperReference` is provided the shopper can decide whether or not the details will be stored.* **enabled** – If the `shopperReference` is provided the details will be stored without asking consent to the shopper.
        Returns:
        storePaymentMethodMode
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object