Class: CyberSource::Riskv1authenticationresultsConsumerAuthenticationInformation
- Inherits:
-
Object
- Object
- CyberSource::Riskv1authenticationresultsConsumerAuthenticationInformation
- Defined in:
- lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb
Instance Attribute Summary collapse
-
#acs_rendering_type ⇒ Object
Identifies the UI Type the ACS will use to complete the challenge.
-
#acs_transaction_id ⇒ Object
Unique transaction identifier assigned by the ACS to identify a single transaction.
-
#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.
-
#directory_server_error_code ⇒ Object
The directory server error code indicating a problem with this transaction.
-
#directory_server_error_description ⇒ Object
Directory server text and additional detail about the error for this transaction.
-
#effective_authentication_type ⇒ Object
This field describes the type of 3DS transaction flow that took place.
-
#interaction_counter ⇒ Object
Indicates the number of authentication cycles attempted by the cardholder and is tracked by the Issuing Banks ACS.Example: if customer gets the challenge window and enter in their one time password and hit submit then that interaction counter should just be 1.
-
#sdk_transaction_id ⇒ Object
SDK unique transaction identifier that is generated on each new transaction.
-
#signed_pares ⇒ Object
Payer authentication result (PARes) message returned by the card-issuing bank.
-
#signed_pares_status_reason ⇒ Object
Provides additional information as to why the PAResStatus has a specific value.
-
#three_ds_server_transaction_id ⇒ Object
Unique transaction identifier assigned by the 3DS Server to identify a single transaction.
-
#white_list_status ⇒ Object
Enables the communication of trusted beneficiary/whitelist status between the ACS, the DS and the 3DS Requestor.
-
#white_list_status_source ⇒ Object
This data element will be populated by the system setting Whitelist Status.
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 = {}) ⇒ Riskv1authenticationresultsConsumerAuthenticationInformation
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 = {}) ⇒ Riskv1authenticationresultsConsumerAuthenticationInformation
Initializes the object
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 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 |
# File 'lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb', line 106 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?(:'acsRenderingType') self.acs_rendering_type = attributes[:'acsRenderingType'] end if attributes.has_key?(:'acsTransactionId') self.acs_transaction_id = attributes[:'acsTransactionId'] end if attributes.has_key?(:'authenticationTransactionId') self.authentication_transaction_id = attributes[:'authenticationTransactionId'] end if attributes.has_key?(:'authenticationType') self.authentication_type = attributes[:'authenticationType'] end if attributes.has_key?(:'challengeCancelCode') self.challenge_cancel_code = attributes[:'challengeCancelCode'] end if attributes.has_key?(:'effectiveAuthenticationType') self.effective_authentication_type = attributes[:'effectiveAuthenticationType'] end if attributes.has_key?(:'directoryServerErrorCode') self.directory_server_error_code = attributes[:'directoryServerErrorCode'] end if attributes.has_key?(:'directoryServerErrorDescription') self.directory_server_error_description = attributes[:'directoryServerErrorDescription'] end if attributes.has_key?(:'interactionCounter') self.interaction_counter = attributes[:'interactionCounter'] end if attributes.has_key?(:'signedParesStatusReason') self.signed_pares_status_reason = attributes[:'signedParesStatusReason'] end if attributes.has_key?(:'sdkTransactionId') self.sdk_transaction_id = attributes[:'sdkTransactionId'] end if attributes.has_key?(:'signedPares') self.signed_pares = attributes[:'signedPares'] end if attributes.has_key?(:'threeDSServerTransactionId') self.three_ds_server_transaction_id = attributes[:'threeDSServerTransactionId'] end if attributes.has_key?(:'whiteListStatus') self.white_list_status = attributes[:'whiteListStatus'] end if attributes.has_key?(:'whiteListStatusSource') self.white_list_status_source = attributes[:'whiteListStatusSource'] end end |
Instance Attribute Details
#acs_rendering_type ⇒ Object
Identifies the UI Type the ACS will use to complete the challenge. NOTE: Only available for App transactions using the Cardinal Mobile SDK.
18 19 20 |
# File 'lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb', line 18 def acs_rendering_type @acs_rendering_type end |
#acs_transaction_id ⇒ Object
Unique transaction identifier assigned by the ACS to identify a single transaction.
21 22 23 |
# File 'lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb', line 21 def acs_transaction_id @acs_transaction_id 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.
24 25 26 |
# File 'lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb', line 24 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.
27 28 29 |
# File 'lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb', line 27 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
30 31 32 |
# File 'lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb', line 30 def challenge_cancel_code @challenge_cancel_code end |
#directory_server_error_code ⇒ Object
The directory server error code indicating a problem with this transaction.
36 37 38 |
# File 'lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb', line 36 def directory_server_error_code @directory_server_error_code end |
#directory_server_error_description ⇒ Object
Directory server text and additional detail about the error for this transaction.
39 40 41 |
# File 'lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb', line 39 def directory_server_error_description @directory_server_error_description end |
#effective_authentication_type ⇒ Object
This field describes the type of 3DS transaction flow that took place. It can be one of three possible flows; CH - Challenge FR - Frictionless FD - Frictionless with delegation, (challenge not generated by the issuer but by the scheme on behalf of the issuer).
33 34 35 |
# File 'lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb', line 33 def effective_authentication_type @effective_authentication_type end |
#interaction_counter ⇒ Object
Indicates the number of authentication cycles attempted by the cardholder and is tracked by the Issuing Banks ACS.Example: if customer gets the challenge window and enter in their one time password and hit submit then that interaction counter should just be 1. When customer gets the challenge window and the bank asks if they want to have the one time password sent to their phone or their email and they have to choose before going to the next screen to enter in their one time password then this interaction count would be 2. One for the selection of how they want the one time password delivered and another with them actually entering in the one time password and hitting the submit button.
42 43 44 |
# File 'lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb', line 42 def interaction_counter @interaction_counter end |
#sdk_transaction_id ⇒ Object
SDK unique transaction identifier that is generated on each new transaction.
48 49 50 |
# File 'lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb', line 48 def sdk_transaction_id @sdk_transaction_id end |
#signed_pares ⇒ Object
Payer authentication result (PARes) message returned by the card-issuing bank. If you need to show proof of enrollment checking, you may need to decrypt and parse the string for the information required by the payment card company. For more information, see "Storing Payer Authentication Data," page 160. Important The value is in base64. You must remove all carriage returns and line feeds before adding the PARes to the request.
51 52 53 |
# File 'lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb', line 51 def signed_pares @signed_pares end |
#signed_pares_status_reason ⇒ Object
Provides additional information as to why the PAResStatus has a specific value.
45 46 47 |
# File 'lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb', line 45 def signed_pares_status_reason @signed_pares_status_reason end |
#three_ds_server_transaction_id ⇒ Object
Unique transaction identifier assigned by the 3DS Server to identify a single transaction.
54 55 56 |
# File 'lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb', line 54 def three_ds_server_transaction_id @three_ds_server_transaction_id 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
57 58 59 |
# File 'lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb', line 57 def white_list_status @white_list_status end |
#white_list_status_source ⇒ Object
This data element will be populated by the system setting Whitelist Status. Possible Values: 01 - 3DS/ Server/ 02 – DS/03 - ACS
60 61 62 |
# File 'lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb', line 60 def white_list_status_source @white_list_status_source end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 |
# File 'lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb', line 63 def self.attribute_map { :'acs_rendering_type' => :'acsRenderingType', :'acs_transaction_id' => :'acsTransactionId', :'authentication_transaction_id' => :'authenticationTransactionId', :'authentication_type' => :'authenticationType', :'challenge_cancel_code' => :'challengeCancelCode', :'effective_authentication_type' => :'effectiveAuthenticationType', :'directory_server_error_code' => :'directoryServerErrorCode', :'directory_server_error_description' => :'directoryServerErrorDescription', :'interaction_counter' => :'interactionCounter', :'signed_pares_status_reason' => :'signedParesStatusReason', :'sdk_transaction_id' => :'sdkTransactionId', :'signed_pares' => :'signedPares', :'three_ds_server_transaction_id' => :'threeDSServerTransactionId', :'white_list_status' => :'whiteListStatus', :'white_list_status_source' => :'whiteListStatusSource' } end |
.swagger_types ⇒ Object
Attribute type mapping.
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 |
# File 'lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb', line 84 def self.swagger_types { :'acs_rendering_type' => :'String', :'acs_transaction_id' => :'String', :'authentication_transaction_id' => :'String', :'authentication_type' => :'String', :'challenge_cancel_code' => :'String', :'effective_authentication_type' => :'String', :'directory_server_error_code' => :'String', :'directory_server_error_description' => :'String', :'interaction_counter' => :'String', :'signed_pares_status_reason' => :'String', :'sdk_transaction_id' => :'String', :'signed_pares' => :'String', :'three_ds_server_transaction_id' => :'String', :'white_list_status' => :'String', :'white_list_status_source' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 |
# File 'lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb', line 388 def ==(o) return true if self.equal?(o) self.class == o.class && acs_rendering_type == o.acs_rendering_type && acs_transaction_id == o.acs_transaction_id && authentication_transaction_id == o.authentication_transaction_id && authentication_type == o.authentication_type && challenge_cancel_code == o.challenge_cancel_code && effective_authentication_type == o.effective_authentication_type && directory_server_error_code == o.directory_server_error_code && directory_server_error_description == o.directory_server_error_description && interaction_counter == o.interaction_counter && signed_pares_status_reason == o.signed_pares_status_reason && sdk_transaction_id == o.sdk_transaction_id && signed_pares == o.signed_pares && three_ds_server_transaction_id == o.three_ds_server_transaction_id && white_list_status == o.white_list_status && white_list_status_source == o.white_list_status_source end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 |
# File 'lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb', line 444 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
510 511 512 513 514 515 516 517 518 519 520 521 522 |
# File 'lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb', line 510 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
423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 |
# File 'lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb', line 423 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
410 411 412 |
# File 'lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb', line 410 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
416 417 418 |
# File 'lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb', line 416 def hash [acs_rendering_type, acs_transaction_id, authentication_transaction_id, authentication_type, challenge_cancel_code, effective_authentication_type, directory_server_error_code, directory_server_error_description, interaction_counter, signed_pares_status_reason, sdk_transaction_id, signed_pares, three_ds_server_transaction_id, white_list_status, white_list_status_source].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
175 176 177 178 179 180 181 182 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 227 228 229 230 231 232 233 234 |
# File 'lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb', line 175 def list_invalid_properties invalid_properties = Array.new if !@acs_transaction_id.nil? && @acs_transaction_id.to_s.length > 36 invalid_properties.push('invalid value for "acs_transaction_id", the character length must be smaller than or equal to 36.') end if !@authentication_transaction_id.nil? && @authentication_transaction_id.to_s.length > 20 invalid_properties.push('invalid value for "authentication_transaction_id", the character length must be smaller than or equal to 20.') end if !@authentication_type.nil? && @authentication_type.to_s.length > 2 invalid_properties.push('invalid value for "authentication_type", the character length must be smaller than or equal to 2.') end if !@challenge_cancel_code.nil? && @challenge_cancel_code.to_s.length > 2 invalid_properties.push('invalid value for "challenge_cancel_code", the character length must be smaller than or equal to 2.') end if !@effective_authentication_type.nil? && @effective_authentication_type.to_s.length > 2 invalid_properties.push('invalid value for "effective_authentication_type", the character length must be smaller than or equal to 2.') end if !@directory_server_error_code.nil? && @directory_server_error_code.to_s.length > 3 invalid_properties.push('invalid value for "directory_server_error_code", the character length must be smaller than or equal to 3.') end if !@directory_server_error_description.nil? && @directory_server_error_description.to_s.length > 4096 invalid_properties.push('invalid value for "directory_server_error_description", the character length must be smaller than or equal to 4096.') end if !@interaction_counter.nil? && @interaction_counter.to_s.length > 2 invalid_properties.push('invalid value for "interaction_counter", the character length must be smaller than or equal to 2.') end if !@signed_pares_status_reason.nil? && @signed_pares_status_reason.to_s.length > 2 invalid_properties.push('invalid value for "signed_pares_status_reason", the character length must be smaller than or equal to 2.') end if !@sdk_transaction_id.nil? && @sdk_transaction_id.to_s.length > 36 invalid_properties.push('invalid value for "sdk_transaction_id", the character length must be smaller than or equal to 36.') end if @signed_pares.nil? invalid_properties.push('invalid value for "signed_pares", signed_pares cannot be nil.') end if !@three_ds_server_transaction_id.nil? && @three_ds_server_transaction_id.to_s.length > 36 invalid_properties.push('invalid value for "three_ds_server_transaction_id", the character length must be smaller than or equal to 36.') end if !@white_list_status.nil? && @white_list_status.to_s.length > 1 invalid_properties.push('invalid value for "white_list_status", the character length must be smaller than or equal to 1.') end if !@white_list_status_source.nil? && @white_list_status_source.to_s.length > 2 invalid_properties.push('invalid value for "white_list_status_source", the character length must be smaller than or equal to 2.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
490 491 492 |
# File 'lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb', line 490 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
496 497 498 499 500 501 502 503 504 |
# File 'lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb', line 496 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
484 485 486 |
# File 'lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb', line 484 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 |
# File 'lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb', line 238 def valid? return false if !@acs_transaction_id.nil? && @acs_transaction_id.to_s.length > 36 return false if !@authentication_transaction_id.nil? && @authentication_transaction_id.to_s.length > 20 return false if !@authentication_type.nil? && @authentication_type.to_s.length > 2 return false if !@challenge_cancel_code.nil? && @challenge_cancel_code.to_s.length > 2 return false if !@effective_authentication_type.nil? && @effective_authentication_type.to_s.length > 2 return false if !@directory_server_error_code.nil? && @directory_server_error_code.to_s.length > 3 return false if !@directory_server_error_description.nil? && @directory_server_error_description.to_s.length > 4096 return false if !@interaction_counter.nil? && @interaction_counter.to_s.length > 2 return false if !@signed_pares_status_reason.nil? && @signed_pares_status_reason.to_s.length > 2 return false if !@sdk_transaction_id.nil? && @sdk_transaction_id.to_s.length > 36 return false if @signed_pares.nil? return false if !@three_ds_server_transaction_id.nil? && @three_ds_server_transaction_id.to_s.length > 36 return false if !@white_list_status.nil? && @white_list_status.to_s.length > 1 return false if !@white_list_status_source.nil? && @white_list_status_source.to_s.length > 2 true end |