Class: CyberSource::Riskv1decisionsConsumerAuthenticationInformation
- Inherits:
-
Object
- Object
- CyberSource::Riskv1decisionsConsumerAuthenticationInformation
- Defined in:
- lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb
Instance Attribute Summary collapse
-
#acs_window_size ⇒ Object
An override field that a merchant can pass in to set the challenge window size to display to the end cardholder.
-
#alternate_authentication_data ⇒ Object
Data that documents and supports a specific authentication process.
-
#alternate_authentication_date ⇒ Object
Date and time in UTC of the cardholder authentication.
-
#alternate_authentication_method ⇒ Object
Mechanism used by the cardholder to authenticate to the 3D Secure requestor.
-
#authentication_date ⇒ Object
The date/time of the authentication at the 3DS servers.
-
#authentication_transaction_id ⇒ Object
Payer authentication transaction identifier passed to link the check enrollment and validate authentication messages.
-
#authentication_type ⇒ Object
Indicates the type of authentication that will be used to challenge the card holder.
-
#challenge_cancel_code ⇒ Object
An indicator as to why the transaction was canceled.
-
#challenge_code ⇒ Object
Possible values: - ‘01`: No preference - `02`: No challenge request - `03`: Challenge requested (3D Secure requestor preference) - `04`: Challenge requested (mandate) - `05`: No challenge requested (transactional risk analysis is already performed) - `06`: No challenge requested (Data share only) - `07`: No challenge requested (strong consumer authentication is already performed) - `08`: No challenge requested (utilize whitelist exemption if no challenge required) - `09`: Challenge requested (whitelist prompt requested if challenge required) Note This field will default to `01` on merchant configuration and can be overridden by the merchant.
-
#challenge_status ⇒ Object
The ‘consumerAuthenticationInformation.challengeCode` indicates the authentication type/level, or challenge, that was presented to the cardholder at checkout by the merchant when calling the Carte Bancaire 3DS servers via CYBS RISK services.
-
#customer_card_alias ⇒ Object
An alias that uniquely identifies the customer’s account and credit card on file.
-
#decoupled_authentication_indicator ⇒ Object
Indicates whether the 3DS Requestor requests the ACS to utilize Decoupled Authentication and agrees to utilize Decoupled Authentication if the ACS confirms its use.
-
#decoupled_authentication_max_time ⇒ Object
Indicates the maximum amount of time that the 3DS Requestor will wait for an ACS (Active control server) to provide the results of a Decoupled Authentication transaction (in minutes).
-
#default_card ⇒ Object
Indicates that the card being used is the one designated as the primary payment card for purchase.
-
#device_channel ⇒ Object
Determines the channel that the transaction came through.
-
#installment_total_count ⇒ Object
An integer value greater than 1 indicating the max number of permitted authorizations for installment payments.
-
#marketing_opt_in ⇒ Object
Indicates whether the customer has opted in for marketing offers.
-
#marketing_source ⇒ Object
Indicates origin of the marketing offer.
-
#mcc ⇒ Object
Merchant category code.
-
#merchant_fraud_rate ⇒ Object
Calculated by merchants as per PSD2** RTS** (EEA** card fraud divided by all EEA card volumes).
-
#merchant_score ⇒ Object
Risk Score provided by merchants.
-
#message_category ⇒ Object
Category of the message for a specific use case.
-
#npa_code ⇒ Object
Non-Payer Authentication Indicator.
-
#override_country_code ⇒ Object
Two-character [ISO Standard Country Codes](developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)..
-
#override_payment_method ⇒ Object
Specifies the Brazilian payment account type used for the transaction.
-
#prior_authentication_data ⇒ Object
This field carry data that the ACS can use to verify the authentication process.
-
#prior_authentication_method ⇒ Object
Mechanism used by the Cardholder to previously authenticate to the 3DS Requestor.
-
#prior_authentication_reference_id ⇒ Object
This data element contains a ACS Transaction ID for a prior authenticated transaction.
-
#prior_authentication_time ⇒ Object
Date and time in UTC of the prior cardholder authentication.
-
#product_code ⇒ Object
Specifies the product code, which designates the type of transaction.
-
#reference_id ⇒ Object
Reference ID that corresponds to the device fingerprinting data that was collected previously.
-
#requestor_id ⇒ Object
Cardinal’s directory server assigned 3DS Requestor ID value.
-
#requestor_initiated_authentication_indicator ⇒ Object
Indicates the type of 3RI request.
-
#requestor_name ⇒ Object
Cardinal’s directory server assigned 3DS Requestor Name value.
-
#return_url ⇒ Object
The URL of the merchant’s return page.
-
#sdk_max_timeout ⇒ Object
This field indicates the maximum amount of time for all 3DS 2.0 messages to be communicated between all components (in minutes).
-
#secure_corporate_payment_indicator ⇒ Object
Indicates dedicated payment processes and procedures were used, potential secure corporate payment exemption applies.
-
#strong_authentication ⇒ Object
Returns the value of attribute strong_authentication.
-
#transaction_mode ⇒ Object
Transaction mode identifier.
-
#white_list_status ⇒ Object
Enables the communication of trusted beneficiary/whitelist status between the ACS, the DS and the 3DS Requestor.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Riskv1decisionsConsumerAuthenticationInformation
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ Riskv1decisionsConsumerAuthenticationInformation
Initializes the object
230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 230 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } if attributes.has_key?(:'strongAuthentication') self.strong_authentication = attributes[:'strongAuthentication'] end if attributes.has_key?(:'authenticationType') self.authentication_type = attributes[:'authenticationType'] end if attributes.has_key?(:'acsWindowSize') self.acs_window_size = attributes[:'acsWindowSize'] end if attributes.has_key?(:'alternateAuthenticationData') self.alternate_authentication_data = attributes[:'alternateAuthenticationData'] end if attributes.has_key?(:'alternateAuthenticationDate') self.alternate_authentication_date = attributes[:'alternateAuthenticationDate'] end if attributes.has_key?(:'alternateAuthenticationMethod') self.alternate_authentication_method = attributes[:'alternateAuthenticationMethod'] end if attributes.has_key?(:'authenticationDate') self.authentication_date = attributes[:'authenticationDate'] end if attributes.has_key?(:'authenticationTransactionId') self.authentication_transaction_id = attributes[:'authenticationTransactionId'] end if attributes.has_key?(:'challengeCancelCode') self.challenge_cancel_code = attributes[:'challengeCancelCode'] end if attributes.has_key?(:'challengeCode') self.challenge_code = attributes[:'challengeCode'] end if attributes.has_key?(:'challengeStatus') self.challenge_status = attributes[:'challengeStatus'] end if attributes.has_key?(:'customerCardAlias') self.customer_card_alias = attributes[:'customerCardAlias'] end if attributes.has_key?(:'decoupledAuthenticationIndicator') self.decoupled_authentication_indicator = attributes[:'decoupledAuthenticationIndicator'] end if attributes.has_key?(:'decoupledAuthenticationMaxTime') self.decoupled_authentication_max_time = attributes[:'decoupledAuthenticationMaxTime'] end if attributes.has_key?(:'defaultCard') self.default_card = attributes[:'defaultCard'] end if attributes.has_key?(:'deviceChannel') self.device_channel = attributes[:'deviceChannel'] end if attributes.has_key?(:'installmentTotalCount') self.installment_total_count = attributes[:'installmentTotalCount'] end if attributes.has_key?(:'merchantFraudRate') self.merchant_fraud_rate = attributes[:'merchantFraudRate'] end if attributes.has_key?(:'marketingOptIn') self.marketing_opt_in = attributes[:'marketingOptIn'] end if attributes.has_key?(:'marketingSource') self.marketing_source = attributes[:'marketingSource'] end if attributes.has_key?(:'mcc') self.mcc = attributes[:'mcc'] end if attributes.has_key?(:'merchantScore') self.merchant_score = attributes[:'merchantScore'] end if attributes.has_key?(:'messageCategory') self. = attributes[:'messageCategory'] end if attributes.has_key?(:'npaCode') self.npa_code = attributes[:'npaCode'] end if attributes.has_key?(:'overridePaymentMethod') self.override_payment_method = attributes[:'overridePaymentMethod'] end if attributes.has_key?(:'overrideCountryCode') self.override_country_code = attributes[:'overrideCountryCode'] end if attributes.has_key?(:'priorAuthenticationData') self.prior_authentication_data = attributes[:'priorAuthenticationData'] end if attributes.has_key?(:'priorAuthenticationMethod') self.prior_authentication_method = attributes[:'priorAuthenticationMethod'] end if attributes.has_key?(:'priorAuthenticationReferenceId') self.prior_authentication_reference_id = attributes[:'priorAuthenticationReferenceId'] end if attributes.has_key?(:'priorAuthenticationTime') self.prior_authentication_time = attributes[:'priorAuthenticationTime'] end if attributes.has_key?(:'productCode') self.product_code = attributes[:'productCode'] end if attributes.has_key?(:'returnUrl') self.return_url = attributes[:'returnUrl'] end if attributes.has_key?(:'requestorId') self.requestor_id = attributes[:'requestorId'] end if attributes.has_key?(:'requestorInitiatedAuthenticationIndicator') self.requestor_initiated_authentication_indicator = attributes[:'requestorInitiatedAuthenticationIndicator'] end if attributes.has_key?(:'requestorName') self.requestor_name = attributes[:'requestorName'] end if attributes.has_key?(:'referenceId') self.reference_id = attributes[:'referenceId'] end if attributes.has_key?(:'sdkMaxTimeout') self.sdk_max_timeout = attributes[:'sdkMaxTimeout'] end if attributes.has_key?(:'secureCorporatePaymentIndicator') self.secure_corporate_payment_indicator = attributes[:'secureCorporatePaymentIndicator'] end if attributes.has_key?(:'transactionMode') self.transaction_mode = attributes[:'transactionMode'] end if attributes.has_key?(:'whiteListStatus') self.white_list_status = attributes[:'whiteListStatus'] end end |
Instance Attribute Details
#acs_window_size ⇒ Object
An override field that a merchant can pass in to set the challenge window size to display to the end cardholder. The ACS (Active Control Server) will reply with content that is formatted appropriately to this window size to allow for the best user experience. The sizes are width x height in pixels of the window displayed in the cardholder browser window. 01 - 250x400 02 - 390x400 03 - 500x600 04 - 600x400 05 - Full page
23 24 25 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 23 def acs_window_size @acs_window_size end |
#alternate_authentication_data ⇒ Object
Data that documents and supports a specific authentication process.
26 27 28 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 26 def alternate_authentication_data @alternate_authentication_data end |
#alternate_authentication_date ⇒ Object
Date and time in UTC of the cardholder authentication. Format: YYYYMMDDHHMM
29 30 31 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 29 def alternate_authentication_date @alternate_authentication_date end |
#alternate_authentication_method ⇒ Object
Mechanism used by the cardholder to authenticate to the 3D Secure requestor. Possible values: - ‘01`: No authentication occurred - `02`: Login using merchant system credentials - `03`: Login using Federated ID - `04`: Login using issuer credentials - `05`: Login using third-party authenticator - `06`: Login using FIDO Authenticator
32 33 34 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 32 def alternate_authentication_method @alternate_authentication_method end |
#authentication_date ⇒ Object
The date/time of the authentication at the 3DS servers. RISK update authorization service in auth request payload with value returned in ‘consumerAuthenticationInformation.alternateAuthenticationData` if merchant calls via CYBS or field can be provided by merchant in authorization request if calling an external 3DS provider. This field is supported for Cartes Bancaires Fast’R transactions on Credit Mutuel-CIC. Format: YYYYMMDDHHMMSS
35 36 37 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 35 def authentication_date @authentication_date end |
#authentication_transaction_id ⇒ Object
Payer authentication transaction identifier passed to link the check enrollment and validate authentication messages. Note: Required for Standard integration for enroll service. Required for Hybrid integration for validate service.
38 39 40 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 38 def authentication_transaction_id @authentication_transaction_id end |
#authentication_type ⇒ Object
Indicates the type of authentication that will be used to challenge the card holder. Possible Values: 01 - Static 02 - Dynamic 03 - OOB (Out of Band) 04 - Decoupled NOTE: EMV 3-D Secure version 2.1.0 supports values 01-03. Version 2.2.0 supports values 01-04. Decoupled authentication is not supported at this time.
20 21 22 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 20 def authentication_type @authentication_type end |
#challenge_cancel_code ⇒ Object
An indicator as to why the transaction was canceled. Possible Values: - ‘01`: Cardholder selected Cancel. - `02`: Reserved for future EMVCo use (values invalid until defined by EMVCo). - `03`: Transaction Timed Out—Decoupled Authentication - `04`: Transaction timed out at ACS—other timeouts - `05`: Transaction Timed out at ACS - First CReq not received by ACS - `06`: Transaction Error - `07`: Unknown - `08`: Transaction Timed Out at SDK
41 42 43 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 41 def challenge_cancel_code @challenge_cancel_code end |
#challenge_code ⇒ Object
Possible values: - ‘01`: No preference - `02`: No challenge request - `03`: Challenge requested (3D Secure requestor preference) - `04`: Challenge requested (mandate) - `05`: No challenge requested (transactional risk analysis is already performed) - `06`: No challenge requested (Data share only) - `07`: No challenge requested (strong consumer authentication is already performed) - `08`: No challenge requested (utilize whitelist exemption if no challenge required) - `09`: Challenge requested (whitelist prompt requested if challenge required) Note This field will default to `01` on merchant configuration and can be overridden by the merchant. EMV 3D Secure version 2.1.0 supports values `01-04`. Version 2.2.0 supports values `01-09`. For details, see `pa_challenge_code` field description in [CyberSource Payer Authentication Using the SCMP API.] (apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html)
44 45 46 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 44 def challenge_code @challenge_code end |
#challenge_status ⇒ Object
The ‘consumerAuthenticationInformation.challengeCode` indicates the authentication type/level, or challenge, that was presented to the cardholder at checkout by the merchant when calling the Carte Bancaire 3DS servers via CYBS RISK services. It conveys to the issuer the alternative authentication methods that the consumer used.
47 48 49 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 47 def challenge_status @challenge_status end |
#customer_card_alias ⇒ Object
An alias that uniquely identifies the customer’s account and credit card on file. Note This field is required if Tokenization is enabled in the merchant profile settings.
50 51 52 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 50 def customer_card_alias @customer_card_alias end |
#decoupled_authentication_indicator ⇒ Object
Indicates whether the 3DS Requestor requests the ACS to utilize Decoupled Authentication and agrees to utilize Decoupled Authentication if the ACS confirms its use. Possible Values: Y - Decoupled Authentication is supported and preferred if challenge is necessary N - Do not use Decoupled Authentication **Default Value**: N
53 54 55 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 53 def decoupled_authentication_indicator @decoupled_authentication_indicator end |
#decoupled_authentication_max_time ⇒ Object
Indicates the maximum amount of time that the 3DS Requestor will wait for an ACS (Active control server) to provide the results of a Decoupled Authentication transaction (in minutes). Possible Values: Numeric values between 1 and 10080 accepted.
56 57 58 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 56 def decoupled_authentication_max_time @decoupled_authentication_max_time end |
#default_card ⇒ Object
Indicates that the card being used is the one designated as the primary payment card for purchase. Recommended for Discover ProtectBuy.
59 60 61 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 59 def default_card @default_card end |
#device_channel ⇒ Object
Determines the channel that the transaction came through. Possible Values: SDK/Browser/3RI. 3RI - 3DS request initiated.
62 63 64 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 62 def device_channel @device_channel end |
#installment_total_count ⇒ Object
An integer value greater than 1 indicating the max number of permitted authorizations for installment payments. Note This is required if the merchant and cardholder have agreed to installment payments.
65 66 67 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 65 def installment_total_count @installment_total_count end |
#marketing_opt_in ⇒ Object
Indicates whether the customer has opted in for marketing offers. Recommended for Discover ProtectBuy.
71 72 73 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 71 def marketing_opt_in @marketing_opt_in end |
#marketing_source ⇒ Object
Indicates origin of the marketing offer. Recommended for Discover ProtectBuy.
74 75 76 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 74 def marketing_source @marketing_source end |
#mcc ⇒ Object
Merchant category code. Important Required only for Visa Secure transactions in Brazil. Do not use this request field for any other types of transactions.
77 78 79 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 77 def mcc @mcc end |
#merchant_fraud_rate ⇒ Object
Calculated by merchants as per PSD2** RTS** (EEA** card fraud divided by all EEA card volumes). Possible Values: 1 = Represents fraud rate <=1 2 = Represents fraud rate >1 and <=6 3 = Represents fraud rate >6 and <=13 4 = Represents fraud rate >13 and <=25 5 = Represents fraud rate >25 EEA** = European Economic Area RTS** = Regulatory Technical Standards PSD2** = Payment Services Directive
68 69 70 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 68 def merchant_fraud_rate @merchant_fraud_rate end |
#merchant_score ⇒ Object
Risk Score provided by merchants. This is specific for CB transactions.
80 81 82 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 80 def merchant_score @merchant_score end |
#message_category ⇒ Object
Category of the message for a specific use case. Possible values: - ‘01`: PA- payment authentication - `02`: NPA- non-payment authentication - `03-79`: Reserved for EMVCo future use (values invalid until defined by EMVCo) - `80-99`: Reserved for DS use
83 84 85 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 83 def @message_category end |
#npa_code ⇒ Object
Non-Payer Authentication Indicator. Possible values: - ‘01`: Add card - `02`: Maintain card information - `03`: Cardholder verification for EMV token - `04-80` Reserved for EMVCo - `80-90` Reserved DS
86 87 88 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 86 def npa_code @npa_code end |
#override_country_code ⇒ Object
Two-character [ISO Standard Country Codes](developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)..
92 93 94 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 92 def override_country_code @override_country_code end |
#override_payment_method ⇒ Object
Specifies the Brazilian payment account type used for the transaction. This field overrides other payment types that might be specified in the request. Use one of the following values for this field: - ‘NA`: Not applicable. Do not override other payment types that are specified in the request. - `CR`: Credit card. - `DB`: Debit card. - `VSAVR`: Visa Vale Refeicao - `VSAVA`: Visa Vale Alimentacao Important Required only for Visa Secure transactions in Brazil. Do not use this request field for any other types of transactions.
89 90 91 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 89 def override_payment_method @override_payment_method end |
#prior_authentication_data ⇒ Object
This field carry data that the ACS can use to verify the authentication process.
95 96 97 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 95 def prior_authentication_data @prior_authentication_data end |
#prior_authentication_method ⇒ Object
Mechanism used by the Cardholder to previously authenticate to the 3DS Requestor. 01 - Frictionless authentication occurred by ACS 02 - Cardholder challenge occurred by ACS 03 - AVS verified 04 - Other issuer methods 05-79 - Reserved for EMVCo future use (values invalid until defined by EMVCo) 80-99 - Reserved for DS use
98 99 100 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 98 def prior_authentication_method @prior_authentication_method end |
#prior_authentication_reference_id ⇒ Object
This data element contains a ACS Transaction ID for a prior authenticated transaction. For example, the first recurring transaction that was authenticated with the cardholder
101 102 103 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 101 def prior_authentication_reference_id @prior_authentication_reference_id end |
#prior_authentication_time ⇒ Object
Date and time in UTC of the prior cardholder authentication. Format – YYYYMMDDHHMM
104 105 106 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 104 def prior_authentication_time @prior_authentication_time end |
#product_code ⇒ Object
Specifies the product code, which designates the type of transaction. Specify one of the following values for this field: - AIR: Airline purchase Important Required for American Express SafeKey (U.S.). - ‘ACC`: Accommodation Rental - `ACF`: Account funding - `CHA`: Check acceptance - `DIG`: Digital Goods - `DSP`: Cash Dispensing - `GAS`: Fuel - `GEN`: General Retail - `LUX`: Luxury Retail - `PAL`: Prepaid activation and load - `PHY`: Goods or services purchase - `QCT`: Quasi-cash transaction - `REN`: Car Rental - `RES`: Restaurant - `SVC`: Services - `TBD`: Other - `TRA`: Travel Important Required for Visa Secure transactions in Brazil. Do not use this request field for any other types of transactions.
107 108 109 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 107 def product_code @product_code end |
#reference_id ⇒ Object
Reference ID that corresponds to the device fingerprinting data that was collected previously. Note Required for Hybrid integration.
122 123 124 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 122 def reference_id @reference_id end |
#requestor_id ⇒ Object
Cardinal’s directory server assigned 3DS Requestor ID value
113 114 115 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 113 def requestor_id @requestor_id end |
#requestor_initiated_authentication_indicator ⇒ Object
Indicates the type of 3RI request. Possible Values: 01 - Recurring transaction 02 - Installment transaction 03 - Add card 04 - Maintain card 05 - Account verification 06 - Split/delayed shipment 07 - Top-up 08 - Mail Order 09 - Telephone Order 10 - Whitelist status check 11 - Other payment
116 117 118 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 116 def requestor_initiated_authentication_indicator @requestor_initiated_authentication_indicator end |
#requestor_name ⇒ Object
Cardinal’s directory server assigned 3DS Requestor Name value
119 120 121 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 119 def requestor_name @requestor_name end |
#return_url ⇒ Object
The URL of the merchant’s return page. CyberSource adds this return URL to the step-up JWT and returns it in the response of the Payer Authentication enrollment call. The merchant’s return URL page serves as a listening URL. Once the bank session completes, the merchant receives a POST to their URL. This response contains the completed bank session’s transactionId. The merchant’s return page should capture the transaction ID and send it in the Payer Authentication validation call.
110 111 112 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 110 def return_url @return_url end |
#sdk_max_timeout ⇒ Object
This field indicates the maximum amount of time for all 3DS 2.0 messages to be communicated between all components (in minutes). Possible Values: Greater than or equal to 05 (05 is the minimum timeout to set) Cardinal Default is set to 15 NOTE: This field is a required 3DS 2.0 field and Cardinal sends in a default of 15 if nothing is passed
125 126 127 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 125 def sdk_max_timeout @sdk_max_timeout end |
#secure_corporate_payment_indicator ⇒ Object
Indicates dedicated payment processes and procedures were used, potential secure corporate payment exemption applies. Possible Values : 0/1
128 129 130 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 128 def secure_corporate_payment_indicator @secure_corporate_payment_indicator end |
#strong_authentication ⇒ Object
Returns the value of attribute strong_authentication.
17 18 19 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 17 def strong_authentication @strong_authentication end |
#transaction_mode ⇒ Object
Transaction mode identifier. Identifies the channel from which the transaction originates. Possible values: - ‘M`: MOTO (Mail Order Telephone Order) - `R`: Retail - `S`: eCommerce - `P`: Mobile Device - `T`: Tablet
131 132 133 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 131 def transaction_mode @transaction_mode end |
#white_list_status ⇒ Object
Enables the communication of trusted beneficiary/whitelist status between the ACS, the DS and the 3DS Requestor. Possible Values: Y - 3DS Requestor is whitelisted by cardholder N - 3DS Requestor is not whitelisted by cardholder
134 135 136 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 134 def white_list_status @white_list_status end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 137 def self.attribute_map { :'strong_authentication' => :'strongAuthentication', :'authentication_type' => :'authenticationType', :'acs_window_size' => :'acsWindowSize', :'alternate_authentication_data' => :'alternateAuthenticationData', :'alternate_authentication_date' => :'alternateAuthenticationDate', :'alternate_authentication_method' => :'alternateAuthenticationMethod', :'authentication_date' => :'authenticationDate', :'authentication_transaction_id' => :'authenticationTransactionId', :'challenge_cancel_code' => :'challengeCancelCode', :'challenge_code' => :'challengeCode', :'challenge_status' => :'challengeStatus', :'customer_card_alias' => :'customerCardAlias', :'decoupled_authentication_indicator' => :'decoupledAuthenticationIndicator', :'decoupled_authentication_max_time' => :'decoupledAuthenticationMaxTime', :'default_card' => :'defaultCard', :'device_channel' => :'deviceChannel', :'installment_total_count' => :'installmentTotalCount', :'merchant_fraud_rate' => :'merchantFraudRate', :'marketing_opt_in' => :'marketingOptIn', :'marketing_source' => :'marketingSource', :'mcc' => :'mcc', :'merchant_score' => :'merchantScore', :'message_category' => :'messageCategory', :'npa_code' => :'npaCode', :'override_payment_method' => :'overridePaymentMethod', :'override_country_code' => :'overrideCountryCode', :'prior_authentication_data' => :'priorAuthenticationData', :'prior_authentication_method' => :'priorAuthenticationMethod', :'prior_authentication_reference_id' => :'priorAuthenticationReferenceId', :'prior_authentication_time' => :'priorAuthenticationTime', :'product_code' => :'productCode', :'return_url' => :'returnUrl', :'requestor_id' => :'requestorId', :'requestor_initiated_authentication_indicator' => :'requestorInitiatedAuthenticationIndicator', :'requestor_name' => :'requestorName', :'reference_id' => :'referenceId', :'sdk_max_timeout' => :'sdkMaxTimeout', :'secure_corporate_payment_indicator' => :'secureCorporatePaymentIndicator', :'transaction_mode' => :'transactionMode', :'white_list_status' => :'whiteListStatus' } end |
.swagger_types ⇒ Object
Attribute type mapping.
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 183 def self.swagger_types { :'strong_authentication' => :'Riskv1decisionsConsumerAuthenticationInformationStrongAuthentication', :'authentication_type' => :'String', :'acs_window_size' => :'String', :'alternate_authentication_data' => :'String', :'alternate_authentication_date' => :'String', :'alternate_authentication_method' => :'String', :'authentication_date' => :'String', :'authentication_transaction_id' => :'String', :'challenge_cancel_code' => :'String', :'challenge_code' => :'String', :'challenge_status' => :'String', :'customer_card_alias' => :'String', :'decoupled_authentication_indicator' => :'String', :'decoupled_authentication_max_time' => :'String', :'default_card' => :'BOOLEAN', :'device_channel' => :'String', :'installment_total_count' => :'Integer', :'merchant_fraud_rate' => :'String', :'marketing_opt_in' => :'BOOLEAN', :'marketing_source' => :'String', :'mcc' => :'String', :'merchant_score' => :'Integer', :'message_category' => :'String', :'npa_code' => :'String', :'override_payment_method' => :'String', :'override_country_code' => :'String', :'prior_authentication_data' => :'String', :'prior_authentication_method' => :'String', :'prior_authentication_reference_id' => :'String', :'prior_authentication_time' => :'String', :'product_code' => :'String', :'return_url' => :'String', :'requestor_id' => :'String', :'requestor_initiated_authentication_indicator' => :'String', :'requestor_name' => :'String', :'reference_id' => :'String', :'sdk_max_timeout' => :'String', :'secure_corporate_payment_indicator' => :'String', :'transaction_mode' => :'String', :'white_list_status' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 592 def ==(o) return true if self.equal?(o) self.class == o.class && strong_authentication == o.strong_authentication && authentication_type == o.authentication_type && acs_window_size == o.acs_window_size && alternate_authentication_data == o.alternate_authentication_data && alternate_authentication_date == o.alternate_authentication_date && alternate_authentication_method == o.alternate_authentication_method && authentication_date == o.authentication_date && authentication_transaction_id == o.authentication_transaction_id && challenge_cancel_code == o.challenge_cancel_code && challenge_code == o.challenge_code && challenge_status == o.challenge_status && customer_card_alias == o.customer_card_alias && decoupled_authentication_indicator == o.decoupled_authentication_indicator && decoupled_authentication_max_time == o.decoupled_authentication_max_time && default_card == o.default_card && device_channel == o.device_channel && installment_total_count == o.installment_total_count && merchant_fraud_rate == o.merchant_fraud_rate && marketing_opt_in == o.marketing_opt_in && marketing_source == o.marketing_source && mcc == o.mcc && merchant_score == o.merchant_score && == o. && npa_code == o.npa_code && override_payment_method == o.override_payment_method && override_country_code == o.override_country_code && prior_authentication_data == o.prior_authentication_data && prior_authentication_method == o.prior_authentication_method && prior_authentication_reference_id == o.prior_authentication_reference_id && prior_authentication_time == o.prior_authentication_time && product_code == o.product_code && return_url == o.return_url && requestor_id == o.requestor_id && requestor_initiated_authentication_indicator == o.requestor_initiated_authentication_indicator && requestor_name == o.requestor_name && reference_id == o.reference_id && sdk_max_timeout == o.sdk_max_timeout && secure_corporate_payment_indicator == o.secure_corporate_payment_indicator && transaction_mode == o.transaction_mode && white_list_status == o.white_list_status end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 673 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.parse(value) when :Date Date.parse(value) when :String value.to_s when :Integer value.to_i when :Float value.to_f when :BOOLEAN if value.to_s =~ /\A(true|t|yes|y|1)\z/i true else false end when :Object # generic object (usually a Hash), return directly value when /\AArray<(?<inner_type>.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/ k_type = Regexp.last_match[:k_type] v_type = Regexp.last_match[:v_type] {}.tap do |hash| value.each do |k, v| hash[_deserialize(k_type, k)] = _deserialize(v_type, v) end end else # model temp_model = CyberSource.const_get(type).new temp_model.build_from_hash(value) end end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
739 740 741 742 743 744 745 746 747 748 749 750 751 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 739 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 652 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end |
#eql?(o) ⇒ Boolean
639 640 641 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 639 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
645 646 647 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 645 def hash [strong_authentication, authentication_type, acs_window_size, alternate_authentication_data, alternate_authentication_date, alternate_authentication_method, authentication_date, authentication_transaction_id, challenge_cancel_code, challenge_code, challenge_status, customer_card_alias, decoupled_authentication_indicator, decoupled_authentication_max_time, default_card, device_channel, installment_total_count, merchant_fraud_rate, marketing_opt_in, marketing_source, mcc, merchant_score, , npa_code, override_payment_method, override_country_code, prior_authentication_data, prior_authentication_method, prior_authentication_reference_id, prior_authentication_time, product_code, return_url, requestor_id, requestor_initiated_authentication_indicator, requestor_name, reference_id, sdk_max_timeout, secure_corporate_payment_indicator, transaction_mode, white_list_status].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
399 400 401 402 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 399 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
719 720 721 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 719 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
725 726 727 728 729 730 731 732 733 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 725 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
713 714 715 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 713 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
406 407 408 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb', line 406 def valid? true end |