Package com.adyen.model.checkout

Class CreateCheckoutSessionRequest

  • public class CreateCheckoutSessionRequest
extends Object
    CreateCheckoutSessionRequest

    • Constructor Detail

      • CreateCheckoutSessionRequest

        public CreateCheckoutSessionRequest()

    • Method Detail

      • getAccountInfo

        public AccountInfo getAccountInfo()
        Get accountInfo
        Returns:
        accountInfo

      • setAccountInfo

        public void setAccountInfo​(AccountInfo accountInfo)

      • getAdditionalAmount

        public Amount getAdditionalAmount()
        Get additionalAmount
        Returns:
        additionalAmount

      • setAdditionalAmount

        public void setAdditionalAmount​(Amount additionalAmount)

      • getAdditionalData

        public Map<String,​String> getAdditionalData()
        This field contains additional data, which may be required for a particular payment request. The `additionalData` object consists of entries, each of which includes the key and value.
        Returns:
        additionalData

      • setAdditionalData

        public void setAdditionalData​(Map<String,​String> additionalData)

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

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

      • getAuthenticationData

        public AuthenticationData getAuthenticationData()
        Get authenticationData
        Returns:
        authenticationData

      • setAuthenticationData

        public void setAuthenticationData​(AuthenticationData authenticationData)

      • getBillingAddress

        public BillingAddress getBillingAddress()
        Get billingAddress
        Returns:
        billingAddress

      • setBillingAddress

        public void setBillingAddress​(BillingAddress billingAddress)

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

      • getCaptureDelayHours

        public Integer getCaptureDelayHours()
        The delay between the authorisation and scheduled auto-capture, specified in hours.
        Returns:
        captureDelayHours

      • setCaptureDelayHours

        public void setCaptureDelayHours​(Integer captureDelayHours)

      • getChannel

        public CreateCheckoutSessionRequest.ChannelEnum getChannel()
        The platform where a payment transaction takes place. This field is optional for filtering out payment methods that are only available on specific platforms. If this value is not set, then we will try to infer it from the `sdkVersion` or `token`. Possible values: * **iOS** * **Android** * **Web**
        Returns:
        channel

      • getCompany

        public Company getCompany()
        Get company
        Returns:
        company

      • setCompany

        public void setCompany​(Company company)

      • getCountryCode

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

      • setCountryCode

        public void setCountryCode​(String 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)

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

      • getDeliveryAddress

        public DeliveryAddress getDeliveryAddress()
        Get deliveryAddress
        Returns:
        deliveryAddress

      • setDeliveryAddress

        public void setDeliveryAddress​(DeliveryAddress deliveryAddress)

      • getEnableOneClick

        public Boolean getEnableOneClick()
        When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.
        Returns:
        enableOneClick

      • setEnableOneClick

        public void setEnableOneClick​(Boolean enableOneClick)

      • getEnablePayOut

        public Boolean getEnablePayOut()
        When true and `shopperReference` is provided, the payment details will be tokenized for payouts.
        Returns:
        enablePayOut

      • setEnablePayOut

        public void setEnablePayOut​(Boolean enablePayOut)

      • getEnableRecurring

        public Boolean getEnableRecurring()
        When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.
        Returns:
        enableRecurring

      • setEnableRecurring

        public void setEnableRecurring​(Boolean enableRecurring)

      • getExpiresAt

        public OffsetDateTime getExpiresAt()
        The date the session expires in [ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. When not specified, the expiry date is set to 1 hour after session creation. You cannot set the session expiry to more than 24 hours after session creation.
        Returns:
        expiresAt

      • setExpiresAt

        public void setExpiresAt​(OffsetDateTime expiresAt)

      • getFundOrigin

        public FundOrigin getFundOrigin()
        Get fundOrigin
        Returns:
        fundOrigin

      • setFundOrigin

        public void setFundOrigin​(FundOrigin fundOrigin)

      • getFundRecipient

        public FundRecipient getFundRecipient()
        Get fundRecipient
        Returns:
        fundRecipient

      • setFundRecipient

        public void setFundRecipient​(FundRecipient fundRecipient)

      • getInstallmentOptions

        public Map<String,​CheckoutSessionInstallmentOption> 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 field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, and Zip.
        Returns:
        lineItems

      • setLineItems

        public void setLineItems​(List<LineItem> lineItems)

      • getMandate

        public Mandate getMandate()
        Get mandate
        Returns:
        mandate

      • setMandate

        public void setMandate​(Mandate mandate)

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

      • getMerchantAccount

        public String getMerchantAccount()
        The merchant account identifier, with which you want to process the transaction.
        Returns:
        merchantAccount

      • setMerchantAccount

        public void setMerchantAccount​(String merchantAccount)

      • getMerchantOrderReference

        public String getMerchantOrderReference()
        This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. The same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations. > We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.
        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. Limits: * Maximum 20 key-value pairs per request. * Maximum 20 characters per key. * Maximum 80 characters per value.
        Returns:
        metadata

      • setMetadata

        public void setMetadata​(Map<String,​String> metadata)

      • getMpiData

        public ThreeDSecureData getMpiData()
        Get mpiData
        Returns:
        mpiData

      • getPlatformChargebackLogic

        public PlatformChargebackLogic getPlatformChargebackLogic()
        Get platformChargebackLogic
        Returns:
        platformChargebackLogic

      • setPlatformChargebackLogic

        public void setPlatformChargebackLogic​(PlatformChargebackLogic platformChargebackLogic)

      • getRecurringExpiry

        public String getRecurringExpiry()
        Date after which no further authorisations shall be performed. Only for 3D Secure 2.
        Returns:
        recurringExpiry

      • setRecurringExpiry

        public void setRecurringExpiry​(String recurringExpiry)

      • getRecurringFrequency

        public String getRecurringFrequency()
        Minimum number of days between authorisations. Only for 3D Secure 2.
        Returns:
        recurringFrequency

      • setRecurringFrequency

        public void setRecurringFrequency​(String recurringFrequency)

      • getRecurringProcessingModel

        public CreateCheckoutSessionRequest.RecurringProcessingModelEnum getRecurringProcessingModel()
        Defines a recurring payment type. Required when creating a token to store payment details. 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 have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.
        Returns:
        recurringProcessingModel

      • getRedirectFromIssuerMethod

        public String getRedirectFromIssuerMethod()
        Specifies the redirect method (GET or POST) when redirecting back from the issuer.
        Returns:
        redirectFromIssuerMethod

      • setRedirectFromIssuerMethod

        public void setRedirectFromIssuerMethod​(String redirectFromIssuerMethod)

      • getRedirectToIssuerMethod

        public String getRedirectToIssuerMethod()
        Specifies the redirect method (GET or POST) when redirecting to the issuer.
        Returns:
        redirectToIssuerMethod

      • setRedirectToIssuerMethod

        public void setRedirectToIssuerMethod​(String redirectToIssuerMethod)

      • getReference

        public String getReference()
        The reference to uniquely identify a payment.
        Returns:
        reference

      • setReference

        public void setReference​(String reference)

      • getReturnUrl

        public String getReturnUrl()
        The URL to return to when a redirect payment is completed.
        Returns:
        returnUrl

      • setReturnUrl

        public void setReturnUrl​(String returnUrl)

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

      • getShopperIP

        public String getShopperIP()
        The shopper's IP address. In general, we recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks). > For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based implementations. This field is also mandatory for some merchants depending on your business model. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new).
        Returns:
        shopperIP

      • setShopperIP

        public void setShopperIP​(String shopperIP)

      • getShopperInteraction

        public CreateCheckoutSessionRequest.ShopperInteractionEnum getShopperInteraction()
        Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default. This field has the following possible values: * `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request. * `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment). * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.
        Returns:
        shopperInteraction

      • getShopperLocale

        public String getShopperLocale()
        The combination of a language code and a country code to specify the language to be used in the payment.
        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. > Your reference must not include personally identifiable information (PII), for example name or email address.
        Returns:
        shopperReference

      • setShopperReference

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

      • getSocialSecurityNumber

        public String getSocialSecurityNumber()
        The shopper's social security number.
        Returns:
        socialSecurityNumber

      • setSocialSecurityNumber

        public void setSocialSecurityNumber​(String 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)

      • getSplits

        public List<Split> getSplits()
        An array of objects specifying how to split a payment when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information), [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic/processing-payments#providing-split-information), or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).
        Returns:
        splits

      • setSplits

        public void setSplits​(List<Split> splits)

      • getStore

        public String getStore()
        The ecommerce or point-of-sale store that is processing the payment. Used in: * [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). * [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).
        Returns:
        store

      • setStore

        public void setStore​(String store)

      • getStorePaymentMethod

        public Boolean getStorePaymentMethod()
        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 CreateCheckoutSessionRequest.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

      • getTelephoneNumber

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

      • setTelephoneNumber

        public void setTelephoneNumber​(String telephoneNumber)

      • getThreeDSAuthenticationOnly

        @Deprecated
public Boolean getThreeDSAuthenticationOnly()
        Deprecated.
        If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation.
        Returns:
        threeDSAuthenticationOnly

      • setThreeDSAuthenticationOnly

        @Deprecated
public void setThreeDSAuthenticationOnly​(Boolean threeDSAuthenticationOnly)
        Deprecated.

      • getTrustedShopper

        public Boolean getTrustedShopper()
        Set to true if the payment should be routed to a trusted MID.
        Returns:
        trustedShopper

      • setTrustedShopper

        public void setTrustedShopper​(Boolean trustedShopper)

      • equals

        public boolean equals​(Object o)
        Return true if this CreateCheckoutSessionRequest object is equal to o.
        Overrides:
        equals in class Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • fromJson

        public static CreateCheckoutSessionRequest fromJson​(String jsonString)
                                             throws com.fasterxml.jackson.core.JsonProcessingException
        Create an instance of CreateCheckoutSessionRequest given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of CreateCheckoutSessionRequest
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to CreateCheckoutSessionRequest

      • toJson

        public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
        Convert an instance of CreateCheckoutSessionRequest to an JSON string
        Returns:
        JSON string
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException