ThreeDS2RequestData class abstract

ThreeDS2RequestData

Properties:

  • acctInfo - Additional information about the cardholder’s account provided by the 3DS Requestor.
  • 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
  • acquirerBIN - Required for authentication-only integration. 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.
  • acquirerMerchantID - Required for authentication-only integration. 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.
  • 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.
  • authenticationOnly - If set to true, you will only perform the 3D Secure 2 authentication, and not the payment authorisation.
  • challengeIndicator - Possibility to specify a preference for receiving a challenge from the issuer. Allowed values: * noPreference * requestNoChallenge * requestChallenge * requestChallengeAsMandate
  • deviceChannel - The environment of the shopper. Allowed values: * app * browser
  • deviceRenderOptions - Display options for the 3D Secure 2 SDK. Optional and only for deviceChannel app.
  • homePhone - The home phone number provided by the cardholder. The phone number must consist of a country code, followed by the number. If the value you provide does not follow the guidelines, we do not submit it for authentication. > Required for Visa and JCB transactions that require 3D Secure 2 authentication, if you did not include the shopperEmail, and did not send the shopper's phone number in telephoneNumber.
  • mcc - Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly authentication-only integrations. The mcc is a four-digit code with which the previously given acquirerMerchantID is registered at the scheme.
  • merchantName - Required for authentication-only integration. 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. 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.
  • messageVersion - The messageVersion value indicating the 3D Secure 2 protocol version.
  • mobilePhone - The mobile phone number provided by the cardholder. The phone number must consist of a country code, followed by the number. If the value you provide does not follow the guidelines, we do not submit it for authentication. > Required for Visa and JCB transactions that require 3D Secure 2 authentication, if you did not include the shopperEmail, and did not send the shopper's phone number in telephoneNumber.
  • 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.
  • payTokenInd - Value true indicates that the transaction was de-tokenised prior to being received by the ACS.
  • paymentAuthenticationUseCase - Indicates the type of payment for which an authentication is requested (message extension)
  • purchaseInstalData - Indicates the maximum number of authorisations permitted for instalment payments. Length: 1–3 characters.
  • recurringExpiry - Date after which no further authorisations shall be performed. Format: YYYYMMDD
  • recurringFrequency - Indicates the minimum number of days between authorisations. Maximum length: 4 characters.
  • sdkAppID - The sdkAppID value as received from the 3D Secure 2 SDK. Required for deviceChannel set to app.
  • sdkEncData - The sdkEncData value as received from the 3D Secure 2 SDK. Required for deviceChannel set to app.
  • sdkEphemPubKey - The sdkEphemPubKey value as received from the 3D Secure 2 SDK. Required for deviceChannel set to app.
  • 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.
  • sdkReferenceNumber - The sdkReferenceNumber value as received from the 3D Secure 2 SDK. Only for deviceChannel set to app.
  • sdkTransID - The sdkTransID value as received from the 3D Secure 2 SDK. Only for deviceChannel set to app.
  • sdkVersion - Version of the 3D Secure 2 mobile SDK. Only for deviceChannel set to app.
  • threeDSCompInd - Completion indicator for the device fingerprinting.
  • threeDSRequestorAuthenticationInd - Indicates the type of Authentication request.
  • threeDSRequestorAuthenticationInfo - Information about how the 3DS Requestor authenticated the cardholder before or during the transaction
  • 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
  • threeDSRequestorID - Required for authentication-only integration for Visa. Unique 3D Secure requestor identifier assigned by the Directory Server when you enrol for 3D Secure 2.
  • threeDSRequestorName - Required for authentication-only integration for Visa. Unique 3D Secure requestor name assigned by the Directory Server when you enrol for 3D Secure 2.
  • threeDSRequestorPriorAuthenticationInfo - Information about how the 3DS Requestor authenticated the cardholder as part of a previous 3DS transaction.
  • 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.
  • 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
  • transactionType - Identify the type of the transaction being authenticated.
  • whiteListStatus - The whiteListStatus value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0.
  • workPhone - The work phone number provided by the cardholder. The phone number must consist of a country code, followed by the number. If the value you provide does not follow the guidelines, we do not submit it for authentication. > Required for Visa and JCB transactions that require 3D Secure 2 authentication, if you did not include the shopperEmail, and did not send the shopper's phone number in telephoneNumber.
Annotations
  • @BuiltValue.new()

Constructors

ThreeDS2RequestData([void updates(ThreeDS2RequestDataBuilder b)])
factory

Properties

acctInfo → AcctInfo?
Additional information about the cardholder’s account provided by the 3DS Requestor.
no setter
acctType → ThreeDS2RequestDataAcctTypeEnum?
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
no setter
acquirerBIN → String?
Required for authentication-only integration. 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.
no setter
acquirerMerchantID → String?
Required for authentication-only integration. 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.
no setter
addrMatch → ThreeDS2RequestDataAddrMatchEnum?
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.
no setter
authenticationOnly → bool?
If set to true, you will only perform the 3D Secure 2 authentication, and not the payment authorisation.
no setter
challengeIndicator → ThreeDS2RequestDataChallengeIndicatorEnum?
Possibility to specify a preference for receiving a challenge from the issuer. Allowed values: * noPreference * requestNoChallenge * requestChallenge * requestChallengeAsMandate
no setter
deviceChannel → String
The environment of the shopper. Allowed values: * app * browser
no setter
deviceRenderOptions → DeviceRenderOptions?
Display options for the 3D Secure 2 SDK. Optional and only for deviceChannel app.
no setter
hashCode → int
The hash code for this object.
no setterinherited
homePhone → Phone?
The home phone number provided by the cardholder. The phone number must consist of a country code, followed by the number. If the value you provide does not follow the guidelines, we do not submit it for authentication. > Required for Visa and JCB transactions that require 3D Secure 2 authentication, if you did not include the shopperEmail, and did not send the shopper's phone number in telephoneNumber.
no setter
mcc → String?
Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly authentication-only integrations. The mcc is a four-digit code with which the previously given acquirerMerchantID is registered at the scheme.
no setter
merchantName → String?
Required for authentication-only integration. 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. 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.
no setter
messageVersion → String?
The messageVersion value indicating the 3D Secure 2 protocol version.
no setter
mobilePhone → Phone?
The mobile phone number provided by the cardholder. The phone number must consist of a country code, followed by the number. If the value you provide does not follow the guidelines, we do not submit it for authentication. > Required for Visa and JCB transactions that require 3D Secure 2 authentication, if you did not include the shopperEmail, and did not send the shopper's phone number in telephoneNumber.
no setter
notificationURL → String?
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.
no setter
paymentAuthenticationUseCase → String?
Indicates the type of payment for which an authentication is requested (message extension)
no setter
payTokenInd → bool?
Value true indicates that the transaction was de-tokenised prior to being received by the ACS.
no setter
purchaseInstalData → String?
Indicates the maximum number of authorisations permitted for instalment payments. Length: 1–3 characters.
no setter
recurringExpiry → String?
Date after which no further authorisations shall be performed. Format: YYYYMMDD
no setter
recurringFrequency → String?
Indicates the minimum number of days between authorisations. Maximum length: 4 characters.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sdkAppID → String?
The sdkAppID value as received from the 3D Secure 2 SDK. Required for deviceChannel set to app.
no setter
sdkEncData → String?
The sdkEncData value as received from the 3D Secure 2 SDK. Required for deviceChannel set to app.
no setter
sdkEphemPubKey → SDKEphemPubKey?
The sdkEphemPubKey value as received from the 3D Secure 2 SDK. Required for deviceChannel set to app.
no setter
sdkMaxTimeout → int?
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.
no setter
sdkReferenceNumber → String?
The sdkReferenceNumber value as received from the 3D Secure 2 SDK. Only for deviceChannel set to app.
no setter
sdkTransID → String?
The sdkTransID value as received from the 3D Secure 2 SDK. Only for deviceChannel set to app.
no setter
sdkVersion → String?
Version of the 3D Secure 2 mobile SDK. Only for deviceChannel set to app.
no setter
threeDSCompInd → String?
Completion indicator for the device fingerprinting.
no setter
threeDSRequestorAuthenticationInd → String?
Indicates the type of Authentication request.
no setter
threeDSRequestorAuthenticationInfo → ThreeDSRequestorAuthenticationInfo?
Information about how the 3DS Requestor authenticated the cardholder before or during the transaction
no setter
threeDSRequestorChallengeInd → ThreeDS2RequestDataThreeDSRequestorChallengeIndEnum?
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
no setter
threeDSRequestorID → String?
Required for authentication-only integration for Visa. Unique 3D Secure requestor identifier assigned by the Directory Server when you enrol for 3D Secure 2.
no setter
threeDSRequestorName → String?
Required for authentication-only integration for Visa. Unique 3D Secure requestor name assigned by the Directory Server when you enrol for 3D Secure 2.
no setter
threeDSRequestorPriorAuthenticationInfo → ThreeDSRequestorPriorAuthenticationInfo?
Information about how the 3DS Requestor authenticated the cardholder as part of a previous 3DS transaction.
no setter
threeDSRequestorURL → String?
URL of the (customer service) website that will be shown to the shopper in case of technical errors during the 3D Secure 2 process.
no setter
transactionType → ThreeDS2RequestDataTransactionTypeEnum?
Identify the type of the transaction being authenticated.
no setter
transType → ThreeDS2RequestDataTransTypeEnum?
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
no setter
whiteListStatus → String?
The whiteListStatus value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0.
no setter
workPhone → Phone?
The work phone number provided by the cardholder. The phone number must consist of a country code, followed by the number. If the value you provide does not follow the guidelines, we do not submit it for authentication. > Required for Visa and JCB transactions that require 3D Secure 2 authentication, if you did not include the shopperEmail, and did not send the shopper's phone number in telephoneNumber.
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(dynamic updates(ThreeDS2RequestDataBuilder)) → ThreeDS2RequestData
Rebuilds the instance.
inherited
toBuilder() → ThreeDS2RequestDataBuilder
Converts the instance to a builder B.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

serializer → Serializer<ThreeDS2RequestData>
no setter