class CyberSource::Ptsv2paymentsConsumerAuthenticationInformation
Attributes
Unique transaction identifier assigned by the ACS to identify a single transaction. This field is supported for Cartes Bancaires Fast'R transactions on Credit Mutuel-CIC.
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
Data that documents and supports a specific authentication process.
Date and time in UTC of the cardholder authentication. Format: YYYYMMDDHHMM
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
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
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.
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.
Cardholder authentication verification value (CAVV).
Algorithm used to generate the CAVV for Visa Secure or the UCAF authentication data for Mastercard Identity Check.
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
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)
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.
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.
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
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.
Indicates that the card being used is the one designated as the primary payment card for purchase. Recommended for Discover ProtectBuy.
Determines the channel that the transaction came through. Possible Values: SDK/Browser/3RI. 3RI - 3DS request initiated.
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
Raw electronic commerce indicator (ECI). For details, see `eci_raw` request field description in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)
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).
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.
Indicates whether the customer has opted in for marketing offers. Recommended for Discover ProtectBuy.
Indicates origin of the marketing offer. Recommended for Discover ProtectBuy.
Merchant category code. Important Required only for Visa Secure transactions in Brazil. Do not use this request field for any other types of transactions.
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
Risk Score provided by merchants. This is specific for CB transactions.
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
The global score calculated by the CB scoring platform and returned to merchants. Possible values: - '00' - '99' When you request the payer authentication and authorization services separately, get the value for this field from the pa_network_score reply field. This field is supported only for Cartes Bancaires Fast'R transactions on Credit Mutuel-CIC.
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
Two-character [ISO Standard Country Codes](developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)..
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.
This field contains 3DS version that was used for Secured Consumer Authentication (SCA). For example 3DS secure version 1.0.2 or 2.0.0 is used for Secured Consumer Authentication. 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: 113 , Field: MC AVV Verification—Program Protocol It will contain one of the following values: - `1` (3D Secure Version 1.0 (3DS 1.0)) - `2` (EMV 3-D Secure (3DS 2.0))
Payer authentication response status. For details, see `pares_status` request field description in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)
This field carry data that the ACS can use to verify the authentication process.
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
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
Date and time in UTC of the prior cardholder authentication. Format – YYYYMMDDHHMM
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.
Reference ID that corresponds to the device fingerprinting data that was collected previously. Note Required for Hybrid integration.
Cardinal's directory server assigned 3DS Requestor ID value
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
Cardinal's directory server assigned 3DS Requestor Name value
JWT returned by the 3D Secure provider when the authentication is complete. Required for Hybrid integration if you use the Cybersource-generated access token. Note: Max. length of this field is 2048 characters.
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.
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
Indicates dedicated payment processes and procedures were used, potential secure corporate payment exemption applies. Possible Values : 0/1
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.
Provides additional information as to why the PAResStatus has a specific value.
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
Universal cardholder authentication field (UCAF) data. For details, see `ucaf_authentication_data` request field description in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)
Universal cardholder authentication field (UCAF) collection indicator. For details, see `ucaf_collection_indicator` request field description in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### CyberSource
through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR7 - Position: 5 - Field: Mastercard Electronic Commerce Indicators—UCAF Collection Indicator
Verification response enrollment status. For details, see `veres_enrolled` request field description in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)
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
Transaction identifier. For details, see `xid` request field description in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 185 def self.attribute_map { :'cavv' => :'cavv', :'cavv_algorithm' => :'cavvAlgorithm', :'eci_raw' => :'eciRaw', :'pares_status' => :'paresStatus', :'veres_enrolled' => :'veresEnrolled', :'xid' => :'xid', :'ucaf_collection_indicator' => :'ucafCollectionIndicator', :'ucaf_authentication_data' => :'ucafAuthenticationData', :'strong_authentication' => :'strongAuthentication', :'directory_server_transaction_id' => :'directoryServerTransactionId', :'pa_specification_version' => :'paSpecificationVersion', :'authentication_type' => :'authenticationType', :'response_access_token' => :'responseAccessToken', :'acs_transaction_id' => :'acsTransactionId', :'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', :'network_score' => :'networkScore', :'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', :'effective_authentication_type' => :'effectiveAuthenticationType', :'signed_pares_status_reason' => :'signedParesStatusReason', :'signed_pares' => :'signedPares' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 310 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?(:'cavv') self.cavv = attributes[:'cavv'] end if attributes.has_key?(:'cavvAlgorithm') self.cavv_algorithm = attributes[:'cavvAlgorithm'] end if attributes.has_key?(:'eciRaw') self.eci_raw = attributes[:'eciRaw'] end if attributes.has_key?(:'paresStatus') self.pares_status = attributes[:'paresStatus'] end if attributes.has_key?(:'veresEnrolled') self.veres_enrolled = attributes[:'veresEnrolled'] end if attributes.has_key?(:'xid') self.xid = attributes[:'xid'] end if attributes.has_key?(:'ucafCollectionIndicator') self.ucaf_collection_indicator = attributes[:'ucafCollectionIndicator'] end if attributes.has_key?(:'ucafAuthenticationData') self.ucaf_authentication_data = attributes[:'ucafAuthenticationData'] end if attributes.has_key?(:'strongAuthentication') self.strong_authentication = attributes[:'strongAuthentication'] end if attributes.has_key?(:'directoryServerTransactionId') self.directory_server_transaction_id = attributes[:'directoryServerTransactionId'] end if attributes.has_key?(:'paSpecificationVersion') self.pa_specification_version = attributes[:'paSpecificationVersion'] end if attributes.has_key?(:'authenticationType') self.authentication_type = attributes[:'authenticationType'] end if attributes.has_key?(:'responseAccessToken') self.response_access_token = attributes[:'responseAccessToken'] end if attributes.has_key?(:'acsTransactionId') self.acs_transaction_id = attributes[:'acsTransactionId'] 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.message_category = attributes[:'messageCategory'] end if attributes.has_key?(:'networkScore') self.network_score = attributes[:'networkScore'] 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 if attributes.has_key?(:'effectiveAuthenticationType') self.effective_authentication_type = attributes[:'effectiveAuthenticationType'] end if attributes.has_key?(:'signedParesStatusReason') self.signed_pares_status_reason = attributes[:'signedParesStatusReason'] end if attributes.has_key?(:'signedPares') self.signed_pares = attributes[:'signedPares'] end end
Attribute type mapping.
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 247 def self.swagger_types { :'cavv' => :'String', :'cavv_algorithm' => :'String', :'eci_raw' => :'String', :'pares_status' => :'String', :'veres_enrolled' => :'String', :'xid' => :'String', :'ucaf_collection_indicator' => :'String', :'ucaf_authentication_data' => :'String', :'strong_authentication' => :'Ptsv2paymentsConsumerAuthenticationInformationStrongAuthentication', :'directory_server_transaction_id' => :'String', :'pa_specification_version' => :'String', :'authentication_type' => :'String', :'response_access_token' => :'String', :'acs_transaction_id' => :'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', :'network_score' => :'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', :'effective_authentication_type' => :'String', :'signed_pares_status_reason' => :'String', :'signed_pares' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object
to be compared
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 820 def ==(o) return true if self.equal?(o) self.class == o.class && cavv == o.cavv && cavv_algorithm == o.cavv_algorithm && eci_raw == o.eci_raw && pares_status == o.pares_status && veres_enrolled == o.veres_enrolled && xid == o.xid && ucaf_collection_indicator == o.ucaf_collection_indicator && ucaf_authentication_data == o.ucaf_authentication_data && strong_authentication == o.strong_authentication && directory_server_transaction_id == o.directory_server_transaction_id && pa_specification_version == o.pa_specification_version && authentication_type == o.authentication_type && response_access_token == o.response_access_token && acs_transaction_id == o.acs_transaction_id && 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 && message_category == o.message_category && network_score == o.network_score && 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 && effective_authentication_type == o.effective_authentication_type && signed_pares_status_reason == o.signed_pares_status_reason && signed_pares == o.signed_pares end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 917 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
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 983 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
Custom attribute writer method with validation @param [Object] acs_transaction_id
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 622 def acs_transaction_id=(acs_transaction_id) @acs_transaction_id = acs_transaction_id end
Custom attribute writer method with validation @param [Object] acs_window_size
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 628 def acs_window_size=(acs_window_size) @acs_window_size = acs_window_size end
Custom attribute writer method with validation @param [Object] alternate_authentication_data
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 634 def alternate_authentication_data=(alternate_authentication_data) @alternate_authentication_data = alternate_authentication_data end
Custom attribute writer method with validation @param [Object] alternate_authentication_date
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 640 def alternate_authentication_date=(alternate_authentication_date) @alternate_authentication_date = alternate_authentication_date end
Custom attribute writer method with validation @param [Object] authentication_date
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 646 def authentication_date=(authentication_date) @authentication_date = authentication_date end
Custom attribute writer method with validation @param [Object] authentication_transaction_id
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 652 def authentication_transaction_id=(authentication_transaction_id) @authentication_transaction_id = authentication_transaction_id end
Custom attribute writer method with validation @param [Object] authentication_type
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 616 def authentication_type=(authentication_type) @authentication_type = authentication_type end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 896 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
Custom attribute writer method with validation @param [Object] cavv Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 556 def cavv=(cavv) @cavv = cavv end
Custom attribute writer method with validation @param [Object] cavv_algorithm
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 562 def cavv_algorithm=(cavv_algorithm) @cavv_algorithm = cavv_algorithm end
Custom attribute writer method with validation @param [Object] challenge_cancel_code
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 658 def challenge_cancel_code=(challenge_cancel_code) @challenge_cancel_code = challenge_cancel_code end
Custom attribute writer method with validation @param [Object] challenge_status
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 664 def challenge_status=(challenge_status) @challenge_status = challenge_status end
Custom attribute writer method with validation @param [Object] customer_card_alias
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 670 def customer_card_alias=(customer_card_alias) @customer_card_alias = customer_card_alias end
Custom attribute writer method with validation @param [Object] decoupled_authentication_indicator
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 676 def decoupled_authentication_indicator=(decoupled_authentication_indicator) @decoupled_authentication_indicator = decoupled_authentication_indicator end
Custom attribute writer method with validation @param [Object] decoupled_authentication_max_time
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 682 def decoupled_authentication_max_time=(decoupled_authentication_max_time) @decoupled_authentication_max_time = decoupled_authentication_max_time end
Custom attribute writer method with validation @param [Object] device_channel
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 688 def device_channel=(device_channel) @device_channel = device_channel end
Custom attribute writer method with validation @param [Object] directory_server_transaction_id
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 604 def directory_server_transaction_id=(directory_server_transaction_id) @directory_server_transaction_id = directory_server_transaction_id end
Custom attribute writer method with validation @param [Object] eci_raw
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 568 def eci_raw=(eci_raw) @eci_raw = eci_raw end
Custom attribute writer method with validation @param [Object] effective_authentication_type
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 808 def effective_authentication_type=(effective_authentication_type) @effective_authentication_type = effective_authentication_type end
@see the `==` method @param [Object] Object
to be compared
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 883 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 889 def hash [cavv, cavv_algorithm, eci_raw, pares_status, veres_enrolled, xid, ucaf_collection_indicator, ucaf_authentication_data, strong_authentication, directory_server_transaction_id, pa_specification_version, authentication_type, response_access_token, acs_transaction_id, 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, message_category, network_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, effective_authentication_type, signed_pares_status_reason, signed_pares].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 543 def list_invalid_properties invalid_properties = Array.new invalid_properties end
Custom attribute writer method with validation @param [Object] marketing_source
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 700 def marketing_source=(marketing_source) @marketing_source = marketing_source end
Custom attribute writer method with validation @param [Object] mcc Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 706 def mcc=(mcc) @mcc = mcc end
Custom attribute writer method with validation @param [Object] merchant_fraud_rate
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 694 def merchant_fraud_rate=(merchant_fraud_rate) @merchant_fraud_rate = merchant_fraud_rate end
Custom attribute writer method with validation @param [Object] network_score
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 712 def network_score=(network_score) @network_score = network_score end
Custom attribute writer method with validation @param [Object] npa_code
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 718 def npa_code=(npa_code) @npa_code = npa_code end
Custom attribute writer method with validation @param [Object] override_country_code
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 724 def override_country_code=(override_country_code) @override_country_code = override_country_code end
Custom attribute writer method with validation @param [Object] pa_specification_version
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 610 def pa_specification_version=(pa_specification_version) @pa_specification_version = pa_specification_version end
Custom attribute writer method with validation @param [Object] pares_status
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 574 def pares_status=(pares_status) @pares_status = pares_status end
Custom attribute writer method with validation @param [Object] prior_authentication_data
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 730 def prior_authentication_data=(prior_authentication_data) @prior_authentication_data = prior_authentication_data end
Custom attribute writer method with validation @param [Object] prior_authentication_method
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 736 def prior_authentication_method=(prior_authentication_method) @prior_authentication_method = prior_authentication_method end
Custom attribute writer method with validation @param [Object] prior_authentication_reference_id
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 742 def prior_authentication_reference_id=(prior_authentication_reference_id) @prior_authentication_reference_id = prior_authentication_reference_id end
Custom attribute writer method with validation @param [Object] prior_authentication_time
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 748 def prior_authentication_time=(prior_authentication_time) @prior_authentication_time = prior_authentication_time end
Custom attribute writer method with validation @param [Object] product_code
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 754 def product_code=(product_code) @product_code = product_code end
Custom attribute writer method with validation @param [Object] reference_id
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 784 def reference_id=(reference_id) @reference_id = reference_id end
Custom attribute writer method with validation @param [Object] requestor_id
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 766 def requestor_id=(requestor_id) @requestor_id = requestor_id end
Custom attribute writer method with validation @param [Object] requestor_initiated_authentication_indicator
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 772 def requestor_initiated_authentication_indicator=(requestor_initiated_authentication_indicator) @requestor_initiated_authentication_indicator = requestor_initiated_authentication_indicator end
Custom attribute writer method with validation @param [Object] requestor_name
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 778 def requestor_name=(requestor_name) @requestor_name = requestor_name end
Custom attribute writer method with validation @param [Object] return_url
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 760 def return_url=(return_url) @return_url = return_url end
Custom attribute writer method with validation @param [Object] sdk_max_timeout
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 790 def sdk_max_timeout=(sdk_max_timeout) @sdk_max_timeout = sdk_max_timeout end
Custom attribute writer method with validation @param [Object] secure_corporate_payment_indicator
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 796 def secure_corporate_payment_indicator=(secure_corporate_payment_indicator) @secure_corporate_payment_indicator = secure_corporate_payment_indicator end
Custom attribute writer method with validation @param [Object] signed_pares_status_reason
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 814 def signed_pares_status_reason=(signed_pares_status_reason) @signed_pares_status_reason = signed_pares_status_reason end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 969 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 957 def to_s to_hash.to_s end
Custom attribute writer method with validation @param [Object] ucaf_authentication_data
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 598 def ucaf_authentication_data=(ucaf_authentication_data) @ucaf_authentication_data = ucaf_authentication_data end
Custom attribute writer method with validation @param [Object] ucaf_collection_indicator
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 592 def ucaf_collection_indicator=(ucaf_collection_indicator) @ucaf_collection_indicator = ucaf_collection_indicator end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 550 def valid? true end
Custom attribute writer method with validation @param [Object] veres_enrolled
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 580 def veres_enrolled=(veres_enrolled) @veres_enrolled = veres_enrolled end
Custom attribute writer method with validation @param [Object] white_list_status
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 802 def white_list_status=(white_list_status) @white_list_status = white_list_status end
Custom attribute writer method with validation @param [Object] xid Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb, line 586 def xid=(xid) @xid = xid end