Package com.adyen.model.checkout

Class ThreeDS2RequestFields

  • public class ThreeDS2RequestFields
extends Object
    ThreeDS2RequestFields

    • Constructor Detail

      • ThreeDS2RequestFields

        public ThreeDS2RequestFields()

    • Method Detail

      • getAcctInfo

        public AcctInfo getAcctInfo()
        Get acctInfo
        Returns:
        acctInfo

      • setAcctInfo

        public void setAcctInfo​(AcctInfo acctInfo)
        acctInfo
        Parameters:
        acctInfo -

      • getAcctType

        public ThreeDS2RequestFields.AcctTypeEnum getAcctType()
        Indicates the type of account. For example, for a multi-account card product. Length: 2 characters. Allowed values: * **01** — Not applicable * **02** — Credit * **03** — Debit
        Returns:
        acctType

      • setAcctType

        public void setAcctType​(ThreeDS2RequestFields.AcctTypeEnum acctType)
        Indicates the type of account. For example, for a multi-account card product. Length: 2 characters. Allowed values: * **01** — Not applicable * **02** — Credit * **03** — Debit
        Parameters:
        acctType -

      • getAcquirerBIN

        public String getAcquirerBIN()
        Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.
        Returns:
        acquirerBIN

      • setAcquirerBIN

        public void setAcquirerBIN​(String acquirerBIN)
        Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.
        Parameters:
        acquirerBIN -

      • getAcquirerMerchantID

        public String getAcquirerMerchantID()
        Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.
        Returns:
        acquirerMerchantID

      • setAcquirerMerchantID

        public void setAcquirerMerchantID​(String acquirerMerchantID)
        Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.
        Parameters:
        acquirerMerchantID -

      • getAddrMatch

        public ThreeDS2RequestFields.AddrMatchEnum getAddrMatch()
        Indicates whether the Cardholder Shipping Address and Cardholder Billing Address are the same. Allowed values: * **Y** — Shipping Address matches Billing Address. * **N** — Shipping Address does not match Billing Address.
        Returns:
        addrMatch

      • setAddrMatch

        public void setAddrMatch​(ThreeDS2RequestFields.AddrMatchEnum addrMatch)
        Indicates whether the Cardholder Shipping Address and Cardholder Billing Address are the same. Allowed values: * **Y** — Shipping Address matches Billing Address. * **N** — Shipping Address does not match Billing Address.
        Parameters:
        addrMatch -

      • getAuthenticationOnly

        @Deprecated
public Boolean getAuthenticationOnly()
        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:
        authenticationOnly

      • setAuthenticationOnly

        @Deprecated
public void setAuthenticationOnly​(Boolean authenticationOnly)
        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.
        Parameters:
        authenticationOnly -

      • getChallengeIndicator

        @Deprecated
public ThreeDS2RequestFields.ChallengeIndicatorEnum getChallengeIndicator()
        Deprecated.
        Possibility to specify a preference for receiving a challenge from the issuer. Allowed values: * `noPreference` * `requestNoChallenge` * `requestChallenge` * `requestChallengeAsMandate`
        Returns:
        challengeIndicator

      • setChallengeIndicator

        @Deprecated
public void setChallengeIndicator​(ThreeDS2RequestFields.ChallengeIndicatorEnum challengeIndicator)
        Deprecated.
        Possibility to specify a preference for receiving a challenge from the issuer. Allowed values: * `noPreference` * `requestNoChallenge` * `requestChallenge` * `requestChallengeAsMandate`
        Parameters:
        challengeIndicator -

      • getDeviceRenderOptions

        public DeviceRenderOptions getDeviceRenderOptions()
        Get deviceRenderOptions
        Returns:
        deviceRenderOptions

      • setDeviceRenderOptions

        public void setDeviceRenderOptions​(DeviceRenderOptions deviceRenderOptions)
        deviceRenderOptions
        Parameters:
        deviceRenderOptions -

      • getHomePhone

        public Phone getHomePhone()
        Get homePhone
        Returns:
        homePhone

      • setHomePhone

        public void setHomePhone​(Phone homePhone)
        homePhone
        Parameters:
        homePhone -

      • getMcc

        public String getMcc()
        Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme.
        Returns:
        mcc

      • setMcc

        public void setMcc​(String mcc)
        Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme.
        Parameters:
        mcc -

      • getMerchantName

        public String getMerchantName()
        Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the authorization. Maximum length is 40 characters. > Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-integration). Use this field if you are enrolled for 3D Secure 2 with us and want to override the merchant name already configured on your account.
        Returns:
        merchantName

      • setMerchantName

        public void setMerchantName​(String merchantName)
        Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the authorization. Maximum length is 40 characters. > Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-integration). Use this field if you are enrolled for 3D Secure 2 with us and want to override the merchant name already configured on your account.
        Parameters:
        merchantName -

      • getMessageVersion

        public String getMessageVersion()
        The `messageVersion` value indicating the 3D Secure 2 protocol version.
        Returns:
        messageVersion

      • setMessageVersion

        public void setMessageVersion​(String messageVersion)
        The `messageVersion` value indicating the 3D Secure 2 protocol version.
        Parameters:
        messageVersion -

      • getMobilePhone

        public Phone getMobilePhone()
        Get mobilePhone
        Returns:
        mobilePhone

      • setMobilePhone

        public void setMobilePhone​(Phone mobilePhone)
        mobilePhone
        Parameters:
        mobilePhone -

      • getNotificationURL

        public String getNotificationURL()
        URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**.
        Returns:
        notificationURL

      • setNotificationURL

        public void setNotificationURL​(String notificationURL)
        URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**.
        Parameters:
        notificationURL -

      • getPayTokenInd

        public Boolean getPayTokenInd()
        Value **true** indicates that the transaction was de-tokenised prior to being received by the ACS.
        Returns:
        payTokenInd

      • setPayTokenInd

        public void setPayTokenInd​(Boolean payTokenInd)
        Value **true** indicates that the transaction was de-tokenised prior to being received by the ACS.
        Parameters:
        payTokenInd -

      • getPaymentAuthenticationUseCase

        public String getPaymentAuthenticationUseCase()
        Indicates the type of payment for which an authentication is requested (message extension)
        Returns:
        paymentAuthenticationUseCase

      • setPaymentAuthenticationUseCase

        public void setPaymentAuthenticationUseCase​(String paymentAuthenticationUseCase)
        Indicates the type of payment for which an authentication is requested (message extension)
        Parameters:
        paymentAuthenticationUseCase -

      • getPurchaseInstalData

        public String getPurchaseInstalData()
        Indicates the maximum number of authorisations permitted for instalment payments. Length: 1–3 characters.
        Returns:
        purchaseInstalData

      • setPurchaseInstalData

        public void setPurchaseInstalData​(String purchaseInstalData)
        Indicates the maximum number of authorisations permitted for instalment payments. Length: 1–3 characters.
        Parameters:
        purchaseInstalData -

      • getRecurringExpiry

        public String getRecurringExpiry()
        Date after which no further authorisations shall be performed. Format: YYYYMMDD
        Returns:
        recurringExpiry

      • setRecurringExpiry

        public void setRecurringExpiry​(String recurringExpiry)
        Date after which no further authorisations shall be performed. Format: YYYYMMDD
        Parameters:
        recurringExpiry -

      • getRecurringFrequency

        public String getRecurringFrequency()
        Indicates the minimum number of days between authorisations. Maximum length: 4 characters.
        Returns:
        recurringFrequency

      • setRecurringFrequency

        public void setRecurringFrequency​(String recurringFrequency)
        Indicates the minimum number of days between authorisations. Maximum length: 4 characters.
        Parameters:
        recurringFrequency -

      • getSdkAppID

        public String getSdkAppID()
        The `sdkAppID` value as received from the 3D Secure 2 SDK.
        Returns:
        sdkAppID

      • setSdkAppID

        public void setSdkAppID​(String sdkAppID)
        The `sdkAppID` value as received from the 3D Secure 2 SDK.
        Parameters:
        sdkAppID -

      • getSdkEphemPubKey

        public SDKEphemPubKey getSdkEphemPubKey()
        Get sdkEphemPubKey
        Returns:
        sdkEphemPubKey

      • setSdkEphemPubKey

        public void setSdkEphemPubKey​(SDKEphemPubKey sdkEphemPubKey)
        sdkEphemPubKey
        Parameters:
        sdkEphemPubKey -

      • getSdkMaxTimeout

        public Integer getSdkMaxTimeout()
        The maximum amount of time in minutes for the 3D Secure 2 authentication process. Optional and only for `deviceChannel` set to **app**. Defaults to **60** minutes.
        Returns:
        sdkMaxTimeout

      • setSdkMaxTimeout

        public void setSdkMaxTimeout​(Integer sdkMaxTimeout)
        The maximum amount of time in minutes for the 3D Secure 2 authentication process. Optional and only for `deviceChannel` set to **app**. Defaults to **60** minutes.
        Parameters:
        sdkMaxTimeout -

      • getSdkReferenceNumber

        public String getSdkReferenceNumber()
        The `sdkReferenceNumber` value as received from the 3D Secure 2 SDK.
        Returns:
        sdkReferenceNumber

      • setSdkReferenceNumber

        public void setSdkReferenceNumber​(String sdkReferenceNumber)
        The `sdkReferenceNumber` value as received from the 3D Secure 2 SDK.
        Parameters:
        sdkReferenceNumber -

      • getSdkTransID

        public String getSdkTransID()
        The `sdkTransID` value as received from the 3D Secure 2 SDK.
        Returns:
        sdkTransID

      • setSdkTransID

        public void setSdkTransID​(String sdkTransID)
        The `sdkTransID` value as received from the 3D Secure 2 SDK.
        Parameters:
        sdkTransID -

      • getThreeDSCompInd

        public String getThreeDSCompInd()
        Completion indicator for the device fingerprinting.
        Returns:
        threeDSCompInd

      • setThreeDSCompInd

        public void setThreeDSCompInd​(String threeDSCompInd)
        Completion indicator for the device fingerprinting.
        Parameters:
        threeDSCompInd -

      • threeDSRequestorAuthenticationInd

        public ThreeDS2RequestFields threeDSRequestorAuthenticationInd​(String threeDSRequestorAuthenticationInd)

      • getThreeDSRequestorAuthenticationInd

        public String getThreeDSRequestorAuthenticationInd()
        Indicates the type of Authentication request.
        Returns:
        threeDSRequestorAuthenticationInd

      • setThreeDSRequestorAuthenticationInd

        public void setThreeDSRequestorAuthenticationInd​(String threeDSRequestorAuthenticationInd)
        Indicates the type of Authentication request.
        Parameters:
        threeDSRequestorAuthenticationInd -

      • getThreeDSRequestorAuthenticationInfo

        public ThreeDSRequestorAuthenticationInfo getThreeDSRequestorAuthenticationInfo()
        Get threeDSRequestorAuthenticationInfo
        Returns:
        threeDSRequestorAuthenticationInfo

      • setThreeDSRequestorAuthenticationInfo

        public void setThreeDSRequestorAuthenticationInfo​(ThreeDSRequestorAuthenticationInfo threeDSRequestorAuthenticationInfo)
        threeDSRequestorAuthenticationInfo
        Parameters:
        threeDSRequestorAuthenticationInfo -

      • getThreeDSRequestorChallengeInd

        public ThreeDS2RequestFields.ThreeDSRequestorChallengeIndEnum getThreeDSRequestorChallengeInd()
        Indicates whether a challenge is requested for this transaction. Possible values: * **01** — No preference * **02** — No challenge requested * **03** — Challenge requested (3DS Requestor preference) * **04** — Challenge requested (Mandate) * **05** — No challenge (transactional risk analysis is already performed) * **06** — Data Only
        Returns:
        threeDSRequestorChallengeInd

      • setThreeDSRequestorChallengeInd

        public void setThreeDSRequestorChallengeInd​(ThreeDS2RequestFields.ThreeDSRequestorChallengeIndEnum threeDSRequestorChallengeInd)
        Indicates whether a challenge is requested for this transaction. Possible values: * **01** — No preference * **02** — No challenge requested * **03** — Challenge requested (3DS Requestor preference) * **04** — Challenge requested (Mandate) * **05** — No challenge (transactional risk analysis is already performed) * **06** — Data Only
        Parameters:
        threeDSRequestorChallengeInd -

      • getThreeDSRequestorID

        public String getThreeDSRequestorID()
        Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) for Visa. Unique 3D Secure requestor identifier assigned by the Directory Server when you enrol for 3D Secure 2.
        Returns:
        threeDSRequestorID

      • setThreeDSRequestorID

        public void setThreeDSRequestorID​(String threeDSRequestorID)
        Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) for Visa. Unique 3D Secure requestor identifier assigned by the Directory Server when you enrol for 3D Secure 2.
        Parameters:
        threeDSRequestorID -

      • getThreeDSRequestorName

        public String getThreeDSRequestorName()
        Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) for Visa. Unique 3D Secure requestor name assigned by the Directory Server when you enrol for 3D Secure 2.
        Returns:
        threeDSRequestorName

      • setThreeDSRequestorName

        public void setThreeDSRequestorName​(String threeDSRequestorName)
        Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) for Visa. Unique 3D Secure requestor name assigned by the Directory Server when you enrol for 3D Secure 2.
        Parameters:
        threeDSRequestorName -

      • getThreeDSRequestorPriorAuthenticationInfo

        public ThreeDSRequestorPriorAuthenticationInfo getThreeDSRequestorPriorAuthenticationInfo()
        Get threeDSRequestorPriorAuthenticationInfo
        Returns:
        threeDSRequestorPriorAuthenticationInfo

      • setThreeDSRequestorPriorAuthenticationInfo

        public void setThreeDSRequestorPriorAuthenticationInfo​(ThreeDSRequestorPriorAuthenticationInfo threeDSRequestorPriorAuthenticationInfo)
        threeDSRequestorPriorAuthenticationInfo
        Parameters:
        threeDSRequestorPriorAuthenticationInfo -

      • getThreeDSRequestorURL

        public String getThreeDSRequestorURL()
        URL of the (customer service) website that will be shown to the shopper in case of technical errors during the 3D Secure 2 process.
        Returns:
        threeDSRequestorURL

      • setThreeDSRequestorURL

        public void setThreeDSRequestorURL​(String threeDSRequestorURL)
        URL of the (customer service) website that will be shown to the shopper in case of technical errors during the 3D Secure 2 process.
        Parameters:
        threeDSRequestorURL -

      • getTransType

        public ThreeDS2RequestFields.TransTypeEnum getTransType()
        Identifies the type of transaction being authenticated. Length: 2 characters. Allowed values: * **01** — Goods/Service Purchase * **03** — Check Acceptance * **10** — Account Funding * **11** — Quasi-Cash Transaction * **28** — Prepaid Activation and Load
        Returns:
        transType

      • setTransType

        public void setTransType​(ThreeDS2RequestFields.TransTypeEnum transType)
        Identifies the type of transaction being authenticated. Length: 2 characters. Allowed values: * **01** — Goods/Service Purchase * **03** — Check Acceptance * **10** — Account Funding * **11** — Quasi-Cash Transaction * **28** — Prepaid Activation and Load
        Parameters:
        transType -

      • getWhiteListStatus

        public String getWhiteListStatus()
        The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0.
        Returns:
        whiteListStatus

      • setWhiteListStatus

        public void setWhiteListStatus​(String whiteListStatus)
        The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0.
        Parameters:
        whiteListStatus -

      • getWorkPhone

        public Phone getWorkPhone()
        Get workPhone
        Returns:
        workPhone

      • setWorkPhone

        public void setWorkPhone​(Phone workPhone)
        workPhone
        Parameters:
        workPhone -

      • equals

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

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • fromJson

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

      • toJson

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