Package com.adyen.model.checkout

Class PaymentsRequest

  • public class PaymentsRequest
extends Object
    PaymentsRequest

    • Constructor Detail

      • PaymentsRequest

        public PaymentsRequest()

    • Method Detail

      • setMerchantRiskIndicator

        public void setMerchantRiskIndicator​(MerchantRiskIndicator merchantRiskIndicator)

      • setAccountInfo

        public void setAccountInfo​(AccountInfo accountInfo)

      • getEnableOneClick

        public Boolean getEnableOneClick()

      • getEnablePayOut

        public Boolean getEnablePayOut()

      • getEnableRecurring

        public Boolean getEnableRecurring()

      • setSplits

        public void setSplits​(List<Split> splits)

      • getTrustedShopper

        public Boolean getTrustedShopper()

      • setTrustedShopper

        public void setTrustedShopper​(Boolean trustedShopper)

      • setThreeDS2RequestData

        public void setThreeDS2RequestData​(ThreeDS2RequestData threeDS2RequestData)

      • 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. For more information on possible key-value pairs, refer to the [additionalData section](https://docs.adyen.com/developers/api-reference/payments-api#paymentrequestadditionaldata).
        Returns:
        additionalData

      • setAdditionalData

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

      • getAmount

        public Amount getAmount()
        Get amount
        Returns:
        amount

      • setAmount

        public void setAmount​(Amount amount)

      • getBillingAddress

        public Address getBillingAddress()
        Get billingAddress
        Returns:
        billingAddress

      • setBillingAddress

        public void setBillingAddress​(Address billingAddress)

      • 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 PaymentsRequest.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 country. Format: [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) Example: NL or DE
        Returns:
        countryCode

      • setCountryCode

        public void setCountryCode​(String countryCode)

      • getDateOfBirth

        public Date 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​(Date dateOfBirth)

      • getDccQuote

        public ForexQuote getDccQuote()
        Get dccQuote
        Returns:
        dccQuote

      • setDccQuote

        public void setDccQuote​(ForexQuote dccQuote)

      • getDeliveryAddress

        public Address getDeliveryAddress()
        Get deliveryAddress
        Returns:
        deliveryAddress

      • setDeliveryAddress

        public void setDeliveryAddress​(Address deliveryAddress)

      • getDeliveryDate

        public Date getDeliveryDate()
        The date and time the purchased goods should be delivered. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD Example: 2017-07-17T13:42:40.428+01:00
        Returns:
        deliveryDate

      • setDeliveryDate

        public void setDeliveryDate​(Date deliveryDate)

      • isEnableOneClick

        public Boolean isEnableOneClick()
        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)

      • isEnablePayOut

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

      • setEnablePayOut

        public void setEnablePayOut​(Boolean enablePayOut)

      • isEnableRecurring

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

      • setEnableRecurring

        public void setEnableRecurring​(Boolean enableRecurring)

      • getFraudOffset

        public Integer getFraudOffset()
        An integer value that is added to the normal fraud score. The value can be either positive or negative.
        Returns:
        fraudOffset

      • setFraudOffset

        public void setFraudOffset​(Integer fraudOffset)

      • getInstallments

        public Installments getInstallments()
        Get installments
        Returns:
        installments

      • setInstallments

        public void setInstallments​(Installments installments)

      • getLineItems

        public List<LineItem> getLineItems()
        Line items regarding the payment.
        Returns:
        lineItems

      • setLineItems

        public void setLineItems​(List<LineItem> lineItems)

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

      • merchantOrderReference

        public PaymentsRequest merchantOrderReference​(String merchantOrderReference)

      • getMerchantOrderReference

        public String getMerchantOrderReference()
        This reference allows linking multiple transactions to each other. > When providing the `merchantOrderReference` value, we also recommend you submit `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values.
        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: Error \"177\", \"Metadata size exceeds limit\"
        Returns:
        metadata

      • setMetadata

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

      • getOrderReference

        public String getOrderReference()
        The order reference to link multiple partial payments.
        Returns:
        orderReference

      • setOrderReference

        public void setOrderReference​(String orderReference)

      • getStore

        public String getStore()

      • setStore

        public void setStore​(String store)

      • getMandate

        public Mandate getMandate()
        Get mandate
        Returns:
        mandate

      • setMandate

        public void setMandate​(Mandate mandate)

      • addCardData

        public PaymentsRequest addCardData​(String cardNumber,
                                   String expiryMonth,
                                   String expiryYear,
                                   String securityCode,
                                   String holderName)
        Add raw card data into the payment request. You need to be PCI compliant!
        Parameters:
        cardNumber - card number
        expiryMonth - expiry month
        expiryYear - expiry year
        holderName - holder name
        securityCode - security code
        Returns:
        paymentMethod payment method

      • getReference

        public String getReference()
        The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens (\"-\"). Maximum length: 80 characters.
        Returns:
        reference

      • setReference

        public void setReference​(String reference)

      • getReturnUrl

        public String getReturnUrl()
        The URL to return to.
        Returns:
        returnUrl

      • setReturnUrl

        public void setReturnUrl​(String returnUrl)

      • getSessionValidity

        public String getSessionValidity()
        The maximum validity of the session.
        Returns:
        sessionValidity

      • setSessionValidity

        public void setSessionValidity​(String sessionValidity)

      • getShopperEmail

        public String getShopperEmail()
        The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks.
        Returns:
        shopperEmail

      • setShopperEmail

        public void setShopperEmail​(String shopperEmail)

      • getShopperIP

        public String getShopperIP()
        The shopper's IP address. 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). > This field is mandatory for some merchants depending on your business model. For more information, [contact Support](https://support.adyen.com/hc/en-us/requests/new).
        Returns:
        shopperIP

      • setShopperIP

        public void setShopperIP​(String shopperIP)

      • getShopperInteraction

        public PaymentsRequest.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()
        The shopper's reference to uniquely identify this shopper (e.g. user ID or account ID). > This field is required for recurring payments.
        Returns:
        shopperReference

      • setShopperReference

        public void setShopperReference​(String shopperReference)

      • getShopperStatement

        public String getShopperStatement()
        The text to appear on the shopper's bank statement.
        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)

      • getTelephoneNumber

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

      • setTelephoneNumber

        public void setTelephoneNumber​(String telephoneNumber)

      • setBrowserInfo

        public void setBrowserInfo​(BrowserInfo browserInfo)

      • getDeviceFingerprint

        public String getDeviceFingerprint()

      • setDeviceFingerprint

        public void setDeviceFingerprint​(String deviceFingerprint)

      • setApplicationInfo

        public void setApplicationInfo​(ApplicationInfo applicationInfo)

      • getOrigin

        public String getOrigin()

      • setOrigin

        public void setOrigin​(String origin)

      • getMpiData

        public ThreeDSecureData getMpiData()
        Authentication data produced by an MPI (Mastercard SecureCode or Verified By Visa).
        Returns:
        the mpi data

      • getRedirectFromIssuerMethod

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

      • setRedirectFromIssuerMethod

        public void setRedirectFromIssuerMethod​(String redirectFromIssuerMethod)

      • redirectFromIssuerMethod

        public PaymentsRequest redirectFromIssuerMethod​(String redirectFromIssuerMethod)

      • getRedirectToIssuerMethod

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

      • setRedirectToIssuerMethod

        public void setRedirectToIssuerMethod​(String redirectToIssuerMethod)

      • redirectToIssuerMethod

        public PaymentsRequest redirectToIssuerMethod​(String redirectToIssuerMethod)

      • getOrder

        public CheckoutOrder getOrder()
        Contains the order information which is required for partial payments.
        Returns:
        order

      • getStorePaymentMethod

        public Boolean getStorePaymentMethod()
        When true and shopperReference is provided, the payment details will be stored.
        Returns:
        storePaymentMethod

      • setStorePaymentMethod

        public void setStorePaymentMethod​(Boolean storePaymentMethod)

      • threeDSAuthenticationOnly

        public PaymentsRequest threeDSAuthenticationOnly​(Boolean threeDSAuthenticationOnly)

      • isThreeDSAuthenticationOnly

        public Boolean isThreeDSAuthenticationOnly()
        If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/checkout/3d-secure/native-3ds2/authentication-only), and not the payment authorisation.
        Returns:
        threeDSAuthenticationOnly

      • setThreeDSAuthenticationOnly

        public void setThreeDSAuthenticationOnly​(Boolean threeDSAuthenticationOnly)

      • getRiskData

        public RiskData getRiskData()
        Get riskData
        Returns:
        riskData

      • setRiskData

        public void setRiskData​(RiskData riskData)

      • getConversionId

        public String getConversionId()
        Conversion ID that corresponds to the Id generated for tracking user payment journey.
        Returns:
        conversionId

      • setConversionId

        public void setConversionId​(String conversionId)

      • getCheckoutAttemptId

        public String getCheckoutAttemptId()
        Checkout attempt ID that corresponds to the Id generated for tracking user payment journey.
        Returns:
        checkoutAttemptId

      • setCheckoutAttemptId

        public void setCheckoutAttemptId​(String checkoutAttemptId)

      • getRecurringExpiry

        public String getRecurringExpiry()

      • setRecurringExpiry

        public void setRecurringExpiry​(String recurringExpiry)

      • getRecurringFrequency

        public String getRecurringFrequency()

      • setRecurringFrequency

        public void setRecurringFrequency​(String recurringFrequency)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object