Class: CyberSource::Ptsv2paymentsConsumerAuthenticationInformation

Inherits:
Object
  • Object
show all
Defined in:
lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv2paymentsConsumerAuthenticationInformation

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash



378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
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
481
482
483
484
485
486
487
488
489
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
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
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
604
605
606
607
608
609
610
611
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 378

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?(:'transactionFlowIndicator')
    self.transaction_flow_indicator = attributes[:'transactionFlowIndicator']
  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

Instance Attribute Details

#acs_transaction_idObject

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.



59
60
61
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 59

def acs_transaction_id
  @acs_transaction_id
end

#acs_window_sizeObject

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



62
63
64
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 62

def acs_window_size
  @acs_window_size
end

#alternate_authentication_dataObject

Data that documents and supports a specific authentication process.



65
66
67
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 65

def alternate_authentication_data
  @alternate_authentication_data
end

#alternate_authentication_dateObject

Date and time in UTC of the cardholder authentication. Format: YYYYMMDDHHMM



68
69
70
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 68

def alternate_authentication_date
  @alternate_authentication_date
end

#alternate_authentication_methodObject

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



71
72
73
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 71

def alternate_authentication_method
  @alternate_authentication_method
end

#authentication_dateObject

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



74
75
76
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 74

def authentication_date
  @authentication_date
end

#authentication_transaction_idObject

Payer authentication transaction identifier passed to link the check enrollment and validate authentication messages.For Rupay,this is passed only in Re-Send OTP usecase. Note: Required for Standard integration, Rupay Seamless server to server integration for enroll service. Required for Hybrid integration for validate service.



77
78
79
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 77

def authentication_transaction_id
  @authentication_transaction_id
end

#authentication_typeObject

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 20 - OTP hosted at merchant end. (Rupay S2S flow) 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.



53
54
55
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 53

def authentication_type
  @authentication_type
end

#cavvObject

Cardholder authentication verification value (CAVV).



18
19
20
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 18

def cavv
  @cavv
end

#cavv_algorithmObject

Algorithm used to generate the CAVV for Visa Secure or the UCAF authentication data for Mastercard Identity Check.



24
25
26
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 24

def cavv_algorithm
  @cavv_algorithm
end

#challenge_cancel_codeObject

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



80
81
82
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 80

def challenge_cancel_code
  @challenge_cancel_code
end

#challenge_codeObject

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)



83
84
85
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 83

def challenge_code
  @challenge_code
end

#challenge_statusObject

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.



86
87
88
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 86

def challenge_status
  @challenge_status
end

#customer_card_aliasObject

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.



89
90
91
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 89

def customer_card_alias
  @customer_card_alias
end

#decoupled_authentication_indicatorObject

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



92
93
94
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 92

def decoupled_authentication_indicator
  @decoupled_authentication_indicator
end

#decoupled_authentication_max_timeObject

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.



95
96
97
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 95

def decoupled_authentication_max_time
  @decoupled_authentication_max_time
end

#default_cardObject

Indicates that the card being used is the one designated as the primary payment card for purchase. Recommended for Discover ProtectBuy.



98
99
100
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 98

def default_card
  @default_card
end

#device_channelObject

Determines the channel that the transaction came through. Possible Values: SDK/Browser/3RI. 3RI - 3DS request initiated.



101
102
103
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 101

def device_channel
  @device_channel
end

#directory_server_transaction_idObject

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



47
48
49
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 47

def directory_server_transaction_id
  @directory_server_transaction_id
end

#eci_rawObject

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/)



27
28
29
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 27

def eci_raw
  @eci_raw
end

#effective_authentication_typeObject

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).



179
180
181
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 179

def effective_authentication_type
  @effective_authentication_type
end

#installment_total_countObject

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.



104
105
106
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 104

def installment_total_count
  @installment_total_count
end

#marketing_opt_inObject

Indicates whether the customer has opted in for marketing offers. Recommended for Discover ProtectBuy.



110
111
112
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 110

def marketing_opt_in
  @marketing_opt_in
end

#marketing_sourceObject

Indicates origin of the marketing offer. Recommended for Discover ProtectBuy.



113
114
115
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 113

def marketing_source
  @marketing_source
end

#mccObject

Merchant category code. Important Required only for Visa Secure transactions in Brazil. Do not use this request field for any other types of transactions.



116
117
118
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 116

def mcc
  @mcc
end

#merchant_fraud_rateObject

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



107
108
109
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 107

def merchant_fraud_rate
  @merchant_fraud_rate
end

#merchant_scoreObject

Risk Score provided by merchants. This is specific for CB transactions.



119
120
121
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 119

def merchant_score
  @merchant_score
end

#message_categoryObject

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



122
123
124
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 122

def message_category
  @message_category
end

#network_scoreObject

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.



125
126
127
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 125

def network_score
  @network_score
end

#npa_codeObject

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



128
129
130
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 128

def npa_code
  @npa_code
end

#override_country_codeObject



134
135
136
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 134

def override_country_code
  @override_country_code
end

#override_payment_methodObject

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.



131
132
133
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 131

def override_payment_method
  @override_payment_method
end

#pa_specification_versionObject

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))



50
51
52
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 50

def pa_specification_version
  @pa_specification_version
end

#pares_statusObject

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/)



30
31
32
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 30

def pares_status
  @pares_status
end

#prior_authentication_dataObject

This field carry data that the ACS can use to verify the authentication process.



137
138
139
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 137

def prior_authentication_data
  @prior_authentication_data
end

#prior_authentication_methodObject

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



140
141
142
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 140

def prior_authentication_method
  @prior_authentication_method
end

#prior_authentication_reference_idObject

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



143
144
145
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 143

def prior_authentication_reference_id
  @prior_authentication_reference_id
end

#prior_authentication_timeObject

Date and time in UTC of the prior cardholder authentication. Format – YYYYMMDDHHMM



146
147
148
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 146

def prior_authentication_time
  @prior_authentication_time
end

#product_codeObject

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.



149
150
151
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 149

def product_code
  @product_code
end

#reference_idObject

Reference ID that corresponds to the device fingerprinting data that was collected previously. Note Required for Hybrid integration.



164
165
166
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 164

def reference_id
  @reference_id
end

#requestor_idObject

Cardinal’s directory server assigned 3DS Requestor ID value



155
156
157
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 155

def requestor_id
  @requestor_id
end

#requestor_initiated_authentication_indicatorObject

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



158
159
160
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 158

def requestor_initiated_authentication_indicator
  @requestor_initiated_authentication_indicator
end

#requestor_nameObject

Cardinal’s directory server assigned 3DS Requestor Name value



161
162
163
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 161

def requestor_name
  @requestor_name
end

#response_access_tokenObject

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.



56
57
58
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 56

def response_access_token
  @response_access_token
end

#return_urlObject

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.



152
153
154
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 152

def return_url
  @return_url
end

#sdk_max_timeoutObject

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



167
168
169
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 167

def sdk_max_timeout
  @sdk_max_timeout
end

#secure_corporate_payment_indicatorObject

Indicates dedicated payment processes and procedures were used, potential secure corporate payment exemption applies. Possible Values : 0/1



170
171
172
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 170

def secure_corporate_payment_indicator
  @secure_corporate_payment_indicator
end

#signed_paresObject

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.



185
186
187
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 185

def signed_pares
  @signed_pares
end

#signed_pares_status_reasonObject

Provides additional information as to why the PAResStatus has a specific value.



182
183
184
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 182

def signed_pares_status_reason
  @signed_pares_status_reason
end

#strong_authenticationObject

Returns the value of attribute strong_authentication.



44
45
46
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 44

def strong_authentication
  @strong_authentication
end

#transaction_flow_indicatorObject

This field details out the type of transaction. Below are the possible values. 08:GC- Guest Checkout.



21
22
23
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 21

def transaction_flow_indicator
  @transaction_flow_indicator
end

#transaction_modeObject

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



173
174
175
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 173

def transaction_mode
  @transaction_mode
end

#ucaf_authentication_dataObject

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/)



42
43
44
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 42

def ucaf_authentication_data
  @ucaf_authentication_data
end

#ucaf_collection_indicatorObject

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



39
40
41
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 39

def ucaf_collection_indicator
  @ucaf_collection_indicator
end

#veres_enrolledObject

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/)



33
34
35
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 33

def veres_enrolled
  @veres_enrolled
end

#white_list_statusObject

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



176
177
178
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 176

def white_list_status
  @white_list_status
end

#xidObject

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/)



36
37
38
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 36

def xid
  @xid
end

Class Method Details

.attribute_mapObject

Attribute mapping from ruby-style variable name to JSON key.



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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 188

def self.attribute_map
  {
    :'cavv' => :'cavv',
    :'transaction_flow_indicator' => :'transactionFlowIndicator',
    :'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

.json_mapObject

Attribute mapping from JSON key to ruby-style variable name.



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
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 251

def self.json_map
  {
    :'cavv' => :'cavv',
    :'transaction_flow_indicator' => :'transaction_flow_indicator',
    :'cavv_algorithm' => :'cavv_algorithm',
    :'eci_raw' => :'eci_raw',
    :'pares_status' => :'pares_status',
    :'veres_enrolled' => :'veres_enrolled',
    :'xid' => :'xid',
    :'ucaf_collection_indicator' => :'ucaf_collection_indicator',
    :'ucaf_authentication_data' => :'ucaf_authentication_data',
    :'strong_authentication' => :'strong_authentication',
    :'directory_server_transaction_id' => :'directory_server_transaction_id',
    :'pa_specification_version' => :'pa_specification_version',
    :'authentication_type' => :'authentication_type',
    :'response_access_token' => :'response_access_token',
    :'acs_transaction_id' => :'acs_transaction_id',
    :'acs_window_size' => :'acs_window_size',
    :'alternate_authentication_data' => :'alternate_authentication_data',
    :'alternate_authentication_date' => :'alternate_authentication_date',
    :'alternate_authentication_method' => :'alternate_authentication_method',
    :'authentication_date' => :'authentication_date',
    :'authentication_transaction_id' => :'authentication_transaction_id',
    :'challenge_cancel_code' => :'challenge_cancel_code',
    :'challenge_code' => :'challenge_code',
    :'challenge_status' => :'challenge_status',
    :'customer_card_alias' => :'customer_card_alias',
    :'decoupled_authentication_indicator' => :'decoupled_authentication_indicator',
    :'decoupled_authentication_max_time' => :'decoupled_authentication_max_time',
    :'default_card' => :'default_card',
    :'device_channel' => :'device_channel',
    :'installment_total_count' => :'installment_total_count',
    :'merchant_fraud_rate' => :'merchant_fraud_rate',
    :'marketing_opt_in' => :'marketing_opt_in',
    :'marketing_source' => :'marketing_source',
    :'mcc' => :'mcc',
    :'merchant_score' => :'merchant_score',
    :'message_category' => :'message_category',
    :'network_score' => :'network_score',
    :'npa_code' => :'npa_code',
    :'override_payment_method' => :'override_payment_method',
    :'override_country_code' => :'override_country_code',
    :'prior_authentication_data' => :'prior_authentication_data',
    :'prior_authentication_method' => :'prior_authentication_method',
    :'prior_authentication_reference_id' => :'prior_authentication_reference_id',
    :'prior_authentication_time' => :'prior_authentication_time',
    :'product_code' => :'product_code',
    :'return_url' => :'return_url',
    :'requestor_id' => :'requestor_id',
    :'requestor_initiated_authentication_indicator' => :'requestor_initiated_authentication_indicator',
    :'requestor_name' => :'requestor_name',
    :'reference_id' => :'reference_id',
    :'sdk_max_timeout' => :'sdk_max_timeout',
    :'secure_corporate_payment_indicator' => :'secure_corporate_payment_indicator',
    :'transaction_mode' => :'transaction_mode',
    :'white_list_status' => :'white_list_status',
    :'effective_authentication_type' => :'effective_authentication_type',
    :'signed_pares_status_reason' => :'signed_pares_status_reason',
    :'signed_pares' => :'signed_pares'
  }
end

.swagger_typesObject

Attribute type mapping.



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 314

def self.swagger_types
  {
    :'cavv' => :'String',
    :'transaction_flow_indicator' => :'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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 898

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      cavv == o.cavv &&
      transaction_flow_indicator == o.transaction_flow_indicator &&
      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

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data



996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 996

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

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash



1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 1062

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

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 975

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("#{self.class.json_map[key]}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{self.class.json_map[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

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


962
963
964
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 962

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



968
969
970
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 968

def hash
  [cavv, transaction_flow_indicator, 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

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



615
616
617
618
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 615

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



1042
1043
1044
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 1042

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 1048

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



1036
1037
1038
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 1036

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid



622
623
624
# File 'lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb', line 622

def valid?
  true
end