Class: CyberSource::RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation
- Inherits:
-
Object
- Object
- CyberSource::RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation
- Defined in:
- lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb
Instance Attribute Summary collapse
-
#access_token ⇒ Object
JSON Web Token (JWT) used to authenticate the consumer with the authentication provider, such as, CardinalCommerce or Rupay.
-
#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.
-
#acs_url ⇒ Object
URL for the card-issuing bank’s authentication form that you receive when the card is enrolled.
-
#authentication_path ⇒ Object
Indicates what displays to the customer during the authentication process.
-
#authentication_transaction_id ⇒ Object
Payer authentication transaction identifier passed to link the check enrollment and validate authentication messages.
-
#authorization_payload ⇒ Object
The Base64 encoded JSON Payload of CB specific Authorization Values returned in the challenge Flow.
-
#cardholder_message ⇒ Object
Text provided by the ACS/Issuer to Cardholder during a Frictionless or Decoupled transaction.The Issuer can provide information to Cardholder.
-
#cavv ⇒ Object
Unique identifier generated by the card-issuing bank for Visa, American Express, JCB, Diners Club, and Discover transactions after the customer is authenticated.
-
#cavv_algorithm ⇒ Object
Field that is returned only when the CAVV is generated, which occurs when paresStatus contains the values Y (successful authentication) or A (attempted authentication).
-
#challenge_cancel_code ⇒ Object
An indicator as to why the transaction was canceled.
-
#challenge_required ⇒ Object
Indicates whether a challenge is required in order to complete authentication.
-
#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.
-
#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.
-
#directory_server_transaction_id ⇒ Object
The Directory Server Transaction ID is generated by the Mastercard Directory Server during the authentication transaction and passed back to the merchant with the authentication results.
-
#eci ⇒ Object
Note This field applies only to non-U.S-issued cards.
-
#eci_raw ⇒ Object
ECI value that can be returned for Visa, Mastercard, American Express, JCB, Diners Club, and Discover.
-
#ecommerce_indicator ⇒ Object
Commerce indicator for cards not enrolled.
-
#effective_authentication_type ⇒ Object
This field describes the type of 3DS transaction flow that took place.
-
#ivr ⇒ Object
Returns the value of attribute ivr.
-
#network_score ⇒ Object
The global score calculated by the CB scoring platform and returned to merchants.
-
#pareq ⇒ Object
Payer authentication request (PAReq) message that you need to forward to the ACS.
-
#pares_status ⇒ Object
Raw result of the authentication check.
-
#proof_xml ⇒ Object
Date and time of the enrollment check combined with the VEReq and VERes elements.
-
#proxy_pan ⇒ Object
Encrypted version of the card number used in the payer authentication request message.
-
#sdk_transaction_id ⇒ Object
SDK unique transaction identifier that is generated on each new transaction.
-
#signed_pares_status_reason ⇒ Object
Provides additional information as to why the PAResStatus has a specific value.
-
#specification_version ⇒ Object
This field contains the 3D Secure version that was used to process the transaction.
-
#step_up_url ⇒ Object
The fully qualified URL that the merchant uses to post a form to the cardholder in order to complete the Consumer Authentication transaction for the Cardinal Cruise API integration.
-
#three_ds_server_transaction_id ⇒ Object
Unique transaction identifier assigned by the 3DS Server to identify a single transaction.
-
#ucaf_authentication_data ⇒ Object
AAV is a unique identifier generated by the card-issuing bank for Mastercard Identity Check transactions after the customer is authenticated.
-
#ucaf_collection_indicator ⇒ Object
For enroll, Returned only for Mastercard transactions.
-
#veres_enrolled ⇒ Object
Result of the enrollment check.
-
#white_list_status_source ⇒ Object
This data element will be populated by the system setting Whitelist Status.
-
#xid ⇒ Object
Transaction identifier generated by CyberSource for successful enrollment or validation checks.
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 = {}) ⇒ RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation
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 = {}) ⇒ RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation
Initializes the object
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 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 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 210 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?(:'accessToken') self.access_token = attributes[:'accessToken'] end 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?(:'acsUrl') self.acs_url = attributes[:'acsUrl'] end if attributes.has_key?(:'authenticationPath') self.authentication_path = attributes[:'authenticationPath'] end if attributes.has_key?(:'authorizationPayload') self. = attributes[:'authorizationPayload'] end if attributes.has_key?(:'authenticationTransactionId') self.authentication_transaction_id = attributes[:'authenticationTransactionId'] end if attributes.has_key?(:'cardholderMessage') self. = attributes[:'cardholderMessage'] end if attributes.has_key?(:'cavv') self.cavv = attributes[:'cavv'] end if attributes.has_key?(:'cavvAlgorithm') self.cavv_algorithm = attributes[:'cavvAlgorithm'] end if attributes.has_key?(:'challengeCancelCode') self.challenge_cancel_code = attributes[:'challengeCancelCode'] end if attributes.has_key?(:'challengeRequired') self.challenge_required = attributes[:'challengeRequired'] end if attributes.has_key?(:'decoupledAuthenticationIndicator') self.decoupled_authentication_indicator = attributes[:'decoupledAuthenticationIndicator'] 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?(:'ecommerceIndicator') self.ecommerce_indicator = attributes[:'ecommerceIndicator'] end if attributes.has_key?(:'eci') self.eci = attributes[:'eci'] end if attributes.has_key?(:'eciRaw') self.eci_raw = attributes[:'eciRaw'] end if attributes.has_key?(:'effectiveAuthenticationType') self.effective_authentication_type = attributes[:'effectiveAuthenticationType'] end if attributes.has_key?(:'ivr') self.ivr = attributes[:'ivr'] end if attributes.has_key?(:'networkScore') self.network_score = attributes[:'networkScore'] end if attributes.has_key?(:'pareq') self.pareq = attributes[:'pareq'] end if attributes.has_key?(:'paresStatus') self.pares_status = attributes[:'paresStatus'] end if attributes.has_key?(:'proofXml') self.proof_xml = attributes[:'proofXml'] end if attributes.has_key?(:'proxyPan') self.proxy_pan = attributes[:'proxyPan'] end if attributes.has_key?(:'sdkTransactionId') self.sdk_transaction_id = attributes[:'sdkTransactionId'] end if attributes.has_key?(:'signedParesStatusReason') self.signed_pares_status_reason = attributes[:'signedParesStatusReason'] end if attributes.has_key?(:'specificationVersion') self.specification_version = attributes[:'specificationVersion'] end if attributes.has_key?(:'stepUpUrl') self.step_up_url = attributes[:'stepUpUrl'] end if attributes.has_key?(:'threeDSServerTransactionId') self.three_ds_server_transaction_id = attributes[:'threeDSServerTransactionId'] end if attributes.has_key?(:'ucafAuthenticationData') self.ucaf_authentication_data = attributes[:'ucafAuthenticationData'] end if attributes.has_key?(:'ucafCollectionIndicator') self.ucaf_collection_indicator = attributes[:'ucafCollectionIndicator'] end if attributes.has_key?(:'veresEnrolled') self.veres_enrolled = attributes[:'veresEnrolled'] end if attributes.has_key?(:'whiteListStatusSource') self.white_list_status_source = attributes[:'whiteListStatusSource'] end if attributes.has_key?(:'xid') self.xid = attributes[:'xid'] end if attributes.has_key?(:'directoryServerTransactionId') self.directory_server_transaction_id = attributes[:'directoryServerTransactionId'] end end |
Instance Attribute Details
#access_token ⇒ Object
JSON Web Token (JWT) used to authenticate the consumer with the authentication provider, such as, CardinalCommerce or Rupay. Note - Max Length of this field is 2048 characters.
18 19 20 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 18 def access_token @access_token end |
#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.
21 22 23 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 21 def acs_rendering_type @acs_rendering_type end |
#acs_transaction_id ⇒ Object
Unique transaction identifier assigned by the ACS to identify a single transaction.
24 25 26 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 24 def acs_transaction_id @acs_transaction_id end |
#acs_url ⇒ Object
URL for the card-issuing bank’s authentication form that you receive when the card is enrolled. The value can be very large.
27 28 29 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 27 def acs_url @acs_url end |
#authentication_path ⇒ Object
Indicates what displays to the customer during the authentication process. This field can contain one of these values: - ‘ADS`: (Card not enrolled) customer prompted to activate the card during the checkout process. - `ATTEMPTS`: (Attempts processing) Processing briefly displays before the checkout process is completed. - `ENROLLED`: (Card enrolled) the card issuer’s authentication window displays. - `UNKNOWN`: Card enrollment status cannot be determined. - `NOREDIRECT`: (Card not enrolled, authentication unavailable, or error occurred) nothing displays to the customer. The following values can be returned if you are using rules-based payer authentication. - `RIBA`: The card-issuing bank supports risk-based authentication, but whether the cardholder is likely to be challenged cannot be determined. - `RIBA_PASS`: The card-issuing bank supports risk-based authentication and it is likely that the cardholder will not be challenged to provide credentials, also known as _silent authentication_. For details about possible values, see `pa_enroll_authentication_path` field description and "Rules-Based Payer Authentication" in [CyberSource Payer Authentication Using the SCMP API.] (apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/)
30 31 32 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 30 def authentication_path @authentication_path end |
#authentication_transaction_id ⇒ Object
Payer authentication transaction identifier passed to link the check enrollment and validate authentication messages.
36 37 38 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 36 def authentication_transaction_id @authentication_transaction_id end |
#authorization_payload ⇒ Object
The Base64 encoded JSON Payload of CB specific Authorization Values returned in the challenge Flow
33 34 35 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 33 def @authorization_payload end |
#cardholder_message ⇒ Object
Text provided by the ACS/Issuer to Cardholder during a Frictionless or Decoupled transaction.The Issuer can provide information to Cardholder. For example, “Additional authentication is needed for this transaction, please contact (Issuer Name) at xxx-xxx-xxxx.”. The Issuing Bank can optionally support this value.
39 40 41 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 39 def @cardholder_message end |
#cavv ⇒ Object
Unique identifier generated by the card-issuing bank for Visa, American Express, JCB, Diners Club, and Discover transactions after the customer is authenticated. The value is in base64. When you request the card authorization service, CyberSource automatically converts the value, not the field name, to the format required by your payment processor.
42 43 44 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 42 def cavv @cavv end |
#cavv_algorithm ⇒ Object
Field that is returned only when the CAVV is generated, which occurs when paresStatus contains the values Y (successful authentication) or A (attempted authentication). If you use the ATOS processor, send the value of this field in the ‘cavv_algorithm` request field of the authorization service. This field contains one of these values: - `2`: Visa, American Express, JCB, Diners Club, and Discover - `3`: Mastercard
45 46 47 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 45 def cavv_algorithm @cavv_algorithm 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
48 49 50 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 48 def challenge_cancel_code @challenge_cancel_code end |
#challenge_required ⇒ Object
Indicates whether a challenge is required in order to complete authentication. Note Regional mandates might determine that a challenge is required. Possible values: - ‘Y`: Challenge required - `N`: Challenge not required Note Used by the Hybrid integration.
51 52 53 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 51 def challenge_required @challenge_required 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
54 55 56 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 54 def decoupled_authentication_indicator @decoupled_authentication_indicator end |
#directory_server_error_code ⇒ Object
The directory server error code indicating a problem with this transaction. Note - Max Length of this field is typically 3 characters.
57 58 59 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 57 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.
60 61 62 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 60 def directory_server_error_description @directory_server_error_description end |
#directory_server_transaction_id ⇒ Object
The Directory Server Transaction ID is generated by the Mastercard Directory Server during the authentication transaction and passed back to the merchant with the authentication results. For Cybersource Through Visanet Gateway: The value for this field corresponds to the following data in the TC 33 capture file3: Record: CP01 TCR7, Position: 114-149, Field: MC AVV Verification—Directory Server Transaction ID
122 123 124 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 122 def directory_server_transaction_id @directory_server_transaction_id end |
#eci ⇒ Object
Note This field applies only to non-U.S-issued cards. For enroll, Numeric electronic commerce indicator (ECI) returned only for Visa, American Express, JCB, Diners Club, and Discover transactions when the card is not enrolled. For more information, see "Interpreting the Reply," page 22. If you are not using the CyberSource payment services, you must send this value to your payment processor in the subsequent request for card authorization. This field contains one of these values: - ‘06`: The card can be enrolled. Liability shift. - `07`: The card cannot be enrolled. No liability shift. For validate, Numeric electronic commerce indicator (ECI) returned only for Visa, American Express, JCB, Diners Club, and Discover transactions. The field is absent when authentication fails. You must send this value to your payment processor in the subsequent request for card authorization. This field contains one of these values: - `05`: Successful authentication - `06`: Authentication attempted - `07`: Failed authentication (No response from the merchant because of a problem.)
66 67 68 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 66 def eci @eci end |
#eci_raw ⇒ Object
ECI value that can be returned for Visa, Mastercard, American Express, JCB, Diners Club, and Discover. The field is absent when authentication fails. If your payment processor is Streamline, you must pass the value of this field instead of the value of ‘eci` or `ucafCollectionIndicator`. This field can contain one of these values: - `01`: Authentication attempted (Mastercard) - `02`: Successful authentication (Mastercard) - `05`: Successful authentication (Visa, American Express, JCB, Diners Club, and Discover) - `06`: Authentication attempted (Visa, American Express, JCB, Diners Club, and Discover)
69 70 71 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 69 def eci_raw @eci_raw end |
#ecommerce_indicator ⇒ Object
Commerce indicator for cards not enrolled. This field contains one of these values: - ‘internet`: Card not enrolled, or card type not supported by payer authentication. No liability shift. - `js_attempted`: Card not enrolled, but attempt to authenticate is recorded. Liability shift. - `js_failure`: J/Secure directory service is not available. No liability shift. - `spa`: Mastercard card not enrolled in the SecureCode program. No liability shift. - `vbv_attempted`: Card not enrolled, but attempt to authenticate is recorded. Liability shift. - `vbv_failure`: For payment processor Barclays, Streamline, AIBMS, or FDC Germany, you receive this result if Visa’s directory service is not available. No liability shift.
63 64 65 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 63 def ecommerce_indicator @ecommerce_indicator 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).
72 73 74 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 72 def effective_authentication_type @effective_authentication_type end |
#ivr ⇒ Object
Returns the value of attribute ivr.
74 75 76 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 74 def ivr @ivr end |
#network_score ⇒ Object
The global score calculated by the CB scoring platform and returned to merchants.
77 78 79 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 77 def network_score @network_score end |
#pareq ⇒ Object
Payer authentication request (PAReq) message that you need to forward to the ACS. The value can be very large. The value is in base64.
80 81 82 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 80 def pareq @pareq end |
#pares_status ⇒ Object
Raw result of the authentication check. If you are configured for Asia, Middle East, and Africa Gateway Processing, you need to send the value of this field in your authorization request. This field can contain one of these values: - ‘A`: Proof of authentication attempt was generated. - `N`: Customer failed or canceled authentication. Transaction denied. - `U`: Authentication not completed regardless of the reason. - `Y`: Customer was successfully authenticated.
83 84 85 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 83 def pares_status @pares_status end |
#proof_xml ⇒ Object
Date and time of the enrollment check combined with the VEReq and VERes elements. If you ever need to show proof of enrollment checking, you may need to parse the string for the information required by the payment card company. The value can be very large. For details about possible values, see the ‘pa_enroll_proofxml` field description in [CyberSource Payer Authentication Using the SCMP API.] (apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/) - For cards issued in the U.S. or Canada, Visa may require this data for specific merchant category codes. - For cards not issued in the U.S. or Canada, your bank may require this data as proof of enrollment checking for any payer authentication transaction that you re-present because of a chargeback.
86 87 88 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 86 def proof_xml @proof_xml end |
#proxy_pan ⇒ Object
Encrypted version of the card number used in the payer authentication request message.
89 90 91 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 89 def proxy_pan @proxy_pan end |
#sdk_transaction_id ⇒ Object
SDK unique transaction identifier that is generated on each new transaction.
92 93 94 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 92 def sdk_transaction_id @sdk_transaction_id end |
#signed_pares_status_reason ⇒ Object
Provides additional information as to why the PAResStatus has a specific value.
95 96 97 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 95 def signed_pares_status_reason @signed_pares_status_reason end |
#specification_version ⇒ Object
This field contains the 3D Secure version that was used to process the transaction. For example, 1.0.2 or 2.0.0.
98 99 100 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 98 def specification_version @specification_version end |
#step_up_url ⇒ Object
The fully qualified URL that the merchant uses to post a form to the cardholder in order to complete the Consumer Authentication transaction for the Cardinal Cruise API integration.
101 102 103 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 101 def step_up_url @step_up_url end |
#three_ds_server_transaction_id ⇒ Object
Unique transaction identifier assigned by the 3DS Server to identify a single transaction.
104 105 106 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 104 def three_ds_server_transaction_id @three_ds_server_transaction_id end |
#ucaf_authentication_data ⇒ Object
AAV is a unique identifier generated by the card-issuing bank for Mastercard Identity Check transactions after the customer is authenticated. The value is in base64. Include the data in the card authorization request.
107 108 109 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 107 def ucaf_authentication_data @ucaf_authentication_data end |
#ucaf_collection_indicator ⇒ Object
For enroll, Returned only for Mastercard transactions. Indicates that authentication is not required because the customer is not enrolled. Add the value of this field to the authorization field ucaf_collection_indicator. This field can contain these values: 0, 1. For validate, Numeric electronic commerce indicator (ECI) returned only for Mastercard Identity Check transactions. The field is absent when authentication fails. You must send this value to your payment processor in the request for card authorization. This field contain one of these values: - ‘0`: Authentication data not collected, and customer authentication was not completed. - `1`: Authentication data not collected because customer authentication was not completed. - `2`: Authentication data collected because customer completed authentication.
110 111 112 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 110 def ucaf_collection_indicator @ucaf_collection_indicator end |
#veres_enrolled ⇒ Object
Result of the enrollment check. This field can contain one of these values: - ‘Y`: Card enrolled or can be enrolled; you must authenticate. Liability shift. - `N`: Card not enrolled; proceed with authorization. Liability shift. - `U`: Unable to authenticate regardless of the reason. No liability shift. Note This field only applies to the Asia, Middle East, and Africa Gateway. If you are configured for this processor, you must send the value of this field in your authorization request. The following value can be returned if you are using rules-based Payer Authentication: - `B`: Indicates that authentication was bypassed. For details, see `pa_enroll_veres_enrolled` field description in [CyberSource Payer Authentication Using the SCMP API.] (apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/)
113 114 115 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 113 def veres_enrolled @veres_enrolled 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
116 117 118 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 116 def white_list_status_source @white_list_status_source end |
#xid ⇒ Object
Transaction identifier generated by CyberSource for successful enrollment or validation checks. Use this value, which is in base64, to match an outgoing PAReq with an incoming PARes. CyberSource forwards the XID with the card authorization service to these payment processors in these cases: - Barclays - Streamline (when the ecommerceIndicator`=spa`)
119 120 121 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 119 def xid @xid end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
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 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 125 def self.attribute_map { :'access_token' => :'accessToken', :'acs_rendering_type' => :'acsRenderingType', :'acs_transaction_id' => :'acsTransactionId', :'acs_url' => :'acsUrl', :'authentication_path' => :'authenticationPath', :'authorization_payload' => :'authorizationPayload', :'authentication_transaction_id' => :'authenticationTransactionId', :'cardholder_message' => :'cardholderMessage', :'cavv' => :'cavv', :'cavv_algorithm' => :'cavvAlgorithm', :'challenge_cancel_code' => :'challengeCancelCode', :'challenge_required' => :'challengeRequired', :'decoupled_authentication_indicator' => :'decoupledAuthenticationIndicator', :'directory_server_error_code' => :'directoryServerErrorCode', :'directory_server_error_description' => :'directoryServerErrorDescription', :'ecommerce_indicator' => :'ecommerceIndicator', :'eci' => :'eci', :'eci_raw' => :'eciRaw', :'effective_authentication_type' => :'effectiveAuthenticationType', :'ivr' => :'ivr', :'network_score' => :'networkScore', :'pareq' => :'pareq', :'pares_status' => :'paresStatus', :'proof_xml' => :'proofXml', :'proxy_pan' => :'proxyPan', :'sdk_transaction_id' => :'sdkTransactionId', :'signed_pares_status_reason' => :'signedParesStatusReason', :'specification_version' => :'specificationVersion', :'step_up_url' => :'stepUpUrl', :'three_ds_server_transaction_id' => :'threeDSServerTransactionId', :'ucaf_authentication_data' => :'ucafAuthenticationData', :'ucaf_collection_indicator' => :'ucafCollectionIndicator', :'veres_enrolled' => :'veresEnrolled', :'white_list_status_source' => :'whiteListStatusSource', :'xid' => :'xid', :'directory_server_transaction_id' => :'directoryServerTransactionId' } end |
.swagger_types ⇒ Object
Attribute type mapping.
167 168 169 170 171 172 173 174 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 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 167 def self.swagger_types { :'access_token' => :'String', :'acs_rendering_type' => :'String', :'acs_transaction_id' => :'String', :'acs_url' => :'String', :'authentication_path' => :'String', :'authorization_payload' => :'String', :'authentication_transaction_id' => :'String', :'cardholder_message' => :'String', :'cavv' => :'String', :'cavv_algorithm' => :'String', :'challenge_cancel_code' => :'String', :'challenge_required' => :'String', :'decoupled_authentication_indicator' => :'String', :'directory_server_error_code' => :'String', :'directory_server_error_description' => :'String', :'ecommerce_indicator' => :'String', :'eci' => :'String', :'eci_raw' => :'String', :'effective_authentication_type' => :'String', :'ivr' => :'PtsV2PaymentsPost201ResponseConsumerAuthenticationInformationIvr', :'network_score' => :'String', :'pareq' => :'String', :'pares_status' => :'String', :'proof_xml' => :'String', :'proxy_pan' => :'String', :'sdk_transaction_id' => :'String', :'signed_pares_status_reason' => :'String', :'specification_version' => :'String', :'step_up_url' => :'String', :'three_ds_server_transaction_id' => :'String', :'ucaf_authentication_data' => :'String', :'ucaf_collection_indicator' => :'String', :'veres_enrolled' => :'String', :'white_list_status_source' => :'String', :'xid' => :'String', :'directory_server_transaction_id' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 490 def ==(o) return true if self.equal?(o) self.class == o.class && access_token == o.access_token && acs_rendering_type == o.acs_rendering_type && acs_transaction_id == o.acs_transaction_id && acs_url == o.acs_url && authentication_path == o.authentication_path && == o. && authentication_transaction_id == o.authentication_transaction_id && == o. && cavv == o.cavv && cavv_algorithm == o.cavv_algorithm && challenge_cancel_code == o.challenge_cancel_code && challenge_required == o.challenge_required && decoupled_authentication_indicator == o.decoupled_authentication_indicator && directory_server_error_code == o.directory_server_error_code && directory_server_error_description == o.directory_server_error_description && ecommerce_indicator == o.ecommerce_indicator && eci == o.eci && eci_raw == o.eci_raw && effective_authentication_type == o.effective_authentication_type && ivr == o.ivr && network_score == o.network_score && pareq == o.pareq && pares_status == o.pares_status && proof_xml == o.proof_xml && proxy_pan == o.proxy_pan && sdk_transaction_id == o.sdk_transaction_id && signed_pares_status_reason == o.signed_pares_status_reason && specification_version == o.specification_version && step_up_url == o.step_up_url && three_ds_server_transaction_id == o.three_ds_server_transaction_id && ucaf_authentication_data == o.ucaf_authentication_data && ucaf_collection_indicator == o.ucaf_collection_indicator && veres_enrolled == o.veres_enrolled && white_list_status_source == o.white_list_status_source && xid == o.xid && directory_server_transaction_id == o.directory_server_transaction_id end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 567 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
633 634 635 636 637 638 639 640 641 642 643 644 645 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 633 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
546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 546 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
533 534 535 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 533 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
539 540 541 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 539 def hash [access_token, acs_rendering_type, acs_transaction_id, acs_url, authentication_path, , authentication_transaction_id, , cavv, cavv_algorithm, challenge_cancel_code, challenge_required, decoupled_authentication_indicator, directory_server_error_code, directory_server_error_description, ecommerce_indicator, eci, eci_raw, effective_authentication_type, ivr, network_score, pareq, pares_status, proof_xml, proxy_pan, sdk_transaction_id, signed_pares_status_reason, specification_version, step_up_url, three_ds_server_transaction_id, ucaf_authentication_data, ucaf_collection_indicator, veres_enrolled, white_list_status_source, xid, directory_server_transaction_id].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
363 364 365 366 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 363 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
613 614 615 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 613 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
619 620 621 622 623 624 625 626 627 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 619 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
607 608 609 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 607 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
370 371 372 |
# File 'lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb', line 370 def valid? true end |