Class: CyberSource::RiskV1AuthenticationsPost201ResponseConsumerAuthenticationInformation

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RiskV1AuthenticationsPost201ResponseConsumerAuthenticationInformation

Initializes the object



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
# File 'lib/cybersource_rest_client/models/risk_v1_authentications_post201_response_consumer_authentication_information.rb', line 121

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?(:'acsUrl')
    self.acs_url = attributes[:'acsUrl']
  end

  if attributes.has_key?(:'authenticationPath')
    self.authentication_path = attributes[:'authenticationPath']
  end

  if attributes.has_key?(:'authenticationTransactionId')
    self.authentication_transaction_id = attributes[:'authenticationTransactionId']
  end

  if attributes.has_key?(:'cavv')
    self.cavv = attributes[:'cavv']
  end

  if attributes.has_key?(:'cavvAlgorithm')
    self.cavv_algorithm = attributes[:'cavvAlgorithm']
  end

  if attributes.has_key?(:'challengeRequired')
    self.challenge_required = attributes[:'challengeRequired']
  end

  if attributes.has_key?(:'ecommerceIndicator')
    self.ecommerce_indicator = attributes[:'ecommerceIndicator']
  end

  if attributes.has_key?(:'eci')
    self.eci = attributes[:'eci']
  end

  if attributes.has_key?(:'eciRaw')
    self.eci_raw = attributes[:'eciRaw']
  end

  if attributes.has_key?(:'pareq')
    self.pareq = attributes[:'pareq']
  end

  if attributes.has_key?(:'paresStatus')
    self.pares_status = attributes[:'paresStatus']
  end

  if attributes.has_key?(:'proofXml')
    self.proof_xml = attributes[:'proofXml']
  end

  if attributes.has_key?(:'proxyPan')
    self.proxy_pan = attributes[:'proxyPan']
  end

  if attributes.has_key?(:'specificationVersion')
    self.specification_version = attributes[:'specificationVersion']
  end

  if attributes.has_key?(:'ucafAuthenticationData')
    self.ucaf_authentication_data = attributes[:'ucafAuthenticationData']
  end

  if attributes.has_key?(:'ucafCollectionIndicator')
    self.ucaf_collection_indicator = attributes[:'ucafCollectionIndicator']
  end

  if attributes.has_key?(:'veresEnrolled')
    self.veres_enrolled = attributes[:'veresEnrolled']
  end

  if attributes.has_key?(:'xid')
    self.xid = attributes[:'xid']
  end
end

Instance Attribute Details

#acs_urlObject

URL for the card-issuing bank’s authentication form that you receive when the card is enrolled. The value can be very large.



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

def acs_url
  @acs_url
end

#authentication_pathObject

Indicates what displays to the customer during the authentication process. This field can contain one of these values: - ‘ADS`: (Card not enrolled) customer prompted to activate the card during the checkout process. - `ATTEMPTS`: (Attempts processing) Processing briefly displays before the checkout process is completed. - `ENROLLED`: (Card enrolled) the card issuer’s authentication window displays. - `UNKNOWN`: Card enrollment status cannot be determined. - `NOREDIRECT`: (Card not enrolled, authentication unavailable, or error occurred) nothing displays to the customer. The following values can be returned if you are using rules-based payer authentication. - `RIBA`: The card-issuing bank supports risk-based authentication, but whether the cardholder is likely to be challenged cannot be determined. - `RIBA_PASS`: The card-issuing bank supports risk-based authentication and it is likely that the cardholder will not be challenged to provide credentials, also known as _silent authentication_. For details about possible values, see `pa_enroll_authentication_path` field description and "Rules-Based Payer Authentication" in [CyberSource Payer Authentication Using the SCMP API.] (apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)



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

def authentication_path
  @authentication_path
end

#authentication_transaction_idObject

Payer authentication transaction identifier passed to link the check enrollment and validate authentication messages.



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

def authentication_transaction_id
  @authentication_transaction_id
end

#cavvObject

Unique identifier generated by the card-issuing bank for Visa, American Express, JCB, Diners Club, and Discover transactions after the customer is authenticated. The value is in base64. When you request the card authorization service, CyberSource automatically converts the value, not the field name, to the format required by your payment processor.



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

def cavv
  @cavv
end

#cavv_algorithmObject

Field that is returned only when the CAVV is generated, which occurs when paresStatus contains the values Y (successful authentication) or A (attempted authentication). If you use the ATOS processor, send the value of this field in the ‘cavv_algorithm` request field of the authorization service. This field contains one of these values: - `2`: Visa, American Express, JCB, Diners Club, and Discover - `3`: Mastercard



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

def cavv_algorithm
  @cavv_algorithm
end

#challenge_requiredObject

Indicates whether a challenge is required in order to complete authentication. Note Regional mandates might determine that a challenge is required. Possible values: - ‘Y`: Challenge required - `N`: Challenge not required Note Used by the Hybrid integration.



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

def challenge_required
  @challenge_required
end

#eciObject

Note This field applies only to non-U.S-issued cards. For enroll, Numeric electronic commerce indicator (ECI) returned only for Visa, American Express, JCB, Diners Club, and Discover transactions when the card is not enrolled. For more information, see "Interpreting the Reply," page 22. If you are not using the CyberSource payment services, you must send this value to your payment processor in the subsequent request for card authorization. This field contains one of these values: - ‘06`: The card can be enrolled. Liability shift. - `07`: The card cannot be enrolled. No liability shift. For validate, Numeric electronic commerce indicator (ECI) returned only for Visa, American Express, JCB, Diners Club, and Discover transactions. The field is absent when authentication fails. You must send this value to your payment processor in the subsequent request for card authorization. This field contains one of these values: - `05`: Successful authentication - `06`: Authentication attempted - `07`: Failed authentication (No response from the merchant because of a problem.)



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

def eci
  @eci
end

#eci_rawObject

ECI value that can be returned for Visa, Mastercard, American Express, JCB, Diners Club, and Discover. The field is absent when authentication fails. If your payment processor is Streamline, you must pass the value of this field instead of the value of ‘eci` or `ucafCollectionIndicator`. This field can contain one of these values: - `01`: Authentication attempted (Mastercard) - `02`: Successful authentication (Mastercard) - `05`: Successful authentication (Visa, American Express, JCB, Diners Club, and Discover) - `06`: Authentication attempted (Visa, American Express, JCB, Diners Club, and Discover)



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

def eci_raw
  @eci_raw
end

#ecommerce_indicatorObject

Commerce indicator for cards not enrolled. This field contains one of these values: - ‘internet`: Card not enrolled, or card type not supported by payer authentication. No liability shift. - `js_attempted`: Card not enrolled, but attempt to authenticate is recorded. Liability shift. - `js_failure`: J/Secure directory service is not available. No liability shift. - `spa`: Mastercard card not enrolled in the SecureCode program. No liability shift. - `vbv_attempted`: Card not enrolled, but attempt to authenticate is recorded. Liability shift. - `vbv_failure`: For payment processor Barclays, Streamline, AIBMS, or FDC Germany, you receive this result if Visa’s directory service is not available. No liability shift.



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

def ecommerce_indicator
  @ecommerce_indicator
end

#pareqObject

Payer authentication request (PAReq) message that you need to forward to the ACS. The value can be very large. The value is in base64.



45
46
47
# File 'lib/cybersource_rest_client/models/risk_v1_authentications_post201_response_consumer_authentication_information.rb', line 45

def pareq
  @pareq
end

#pares_statusObject

Raw result of the authentication check. If you are configured for Asia, Middle East, and Africa Gateway Processing, you need to send the value of this field in your authorization request. This field can contain one of these values: - ‘A`: Proof of authentication attempt was generated. - `N`: Customer failed or canceled authentication. Transaction denied. - `U`: Authentication not completed regardless of the reason. - `Y`: Customer was successfully authenticated.



48
49
50
# File 'lib/cybersource_rest_client/models/risk_v1_authentications_post201_response_consumer_authentication_information.rb', line 48

def pares_status
  @pares_status
end

#proof_xmlObject

Date and time of the enrollment check combined with the VEReq and VERes elements. If you ever need to show proof of enrollment checking, you may need to parse the string for the information required by the payment card company. The value can be very large. For details about possible values, see the ‘pa_enroll_proofxml` field description in [CyberSource Payer Authentication Using the SCMP API.] (apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) - For cards issued in the U.S. or Canada, Visa may require this data for specific merchant category codes. - For cards not issued in the U.S. or Canada, your bank may require this data as proof of enrollment checking for any payer authentication transaction that you re-present because of a chargeback.



51
52
53
# File 'lib/cybersource_rest_client/models/risk_v1_authentications_post201_response_consumer_authentication_information.rb', line 51

def proof_xml
  @proof_xml
end

#proxy_panObject

Encrypted version of the card number used in the payer authentication request message.



54
55
56
# File 'lib/cybersource_rest_client/models/risk_v1_authentications_post201_response_consumer_authentication_information.rb', line 54

def proxy_pan
  @proxy_pan
end

#specification_versionObject

This field contains the 3D Secure version that was used to process the transaction. For example, 1.0.2 or 2.0.0.



57
58
59
# File 'lib/cybersource_rest_client/models/risk_v1_authentications_post201_response_consumer_authentication_information.rb', line 57

def specification_version
  @specification_version
end

#ucaf_authentication_dataObject

AAV is a unique identifier generated by the card-issuing bank for Mastercard Identity Check transactions after the customer is authenticated. The value is in base64. Include the data in the card authorization request.



60
61
62
# File 'lib/cybersource_rest_client/models/risk_v1_authentications_post201_response_consumer_authentication_information.rb', line 60

def ucaf_authentication_data
  @ucaf_authentication_data
end

#ucaf_collection_indicatorObject

For enroll, Returned only for Mastercard transactions. Indicates that authentication is not required because the customer is not enrolled. Add the value of this field to the authorization field ucaf_collection_indicator. This field can contain these values: 0, 1. For validate, Numeric electronic commerce indicator (ECI) returned only for Mastercard Identity Check transactions. The field is absent when authentication fails. You must send this value to your payment processor in the request for card authorization. This field contain one of these values: - ‘0`: Authentication data not collected, and customer authentication was not completed. - `1`: Authentication data not collected because customer authentication was not completed. - `2`: Authentication data collected because customer completed authentication.



63
64
65
# File 'lib/cybersource_rest_client/models/risk_v1_authentications_post201_response_consumer_authentication_information.rb', line 63

def ucaf_collection_indicator
  @ucaf_collection_indicator
end

#veres_enrolledObject

Result of the enrollment check. This field can contain one of these values: - ‘Y`: Card enrolled or can be enrolled; you must authenticate. Liability shift. - `N`: Card not enrolled; proceed with authorization. Liability shift. - `U`: Unable to authenticate regardless of the reason. No liability shift. Note This field only applies to the Asia, Middle East, and Africa Gateway. If you are configured for this processor, you must send the value of this field in your authorization request. The following value can be returned if you are using rules-based Payer Authentication: - `B`: Indicates that authentication was bypassed. For details, see `pa_enroll_veres_enrolled` field description in [CyberSource Payer Authentication Using the SCMP API.] (apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)



66
67
68
# File 'lib/cybersource_rest_client/models/risk_v1_authentications_post201_response_consumer_authentication_information.rb', line 66

def veres_enrolled
  @veres_enrolled
end

#xidObject

Transaction identifier generated by CyberSource for successful enrollment or validation checks. Use this value, which is in base64, to match an outgoing PAReq with an incoming PARes. CyberSource forwards the XID with the card authorization service to these payment processors in these cases: - Barclays - Streamline (when the ecommerceIndicator`=spa`)



69
70
71
# File 'lib/cybersource_rest_client/models/risk_v1_authentications_post201_response_consumer_authentication_information.rb', line 69

def xid
  @xid
end

Class Method Details

.attribute_mapObject

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
# File 'lib/cybersource_rest_client/models/risk_v1_authentications_post201_response_consumer_authentication_information.rb', line 72

def self.attribute_map
  {
    :'acs_url' => :'acsUrl',
    :'authentication_path' => :'authenticationPath',
    :'authentication_transaction_id' => :'authenticationTransactionId',
    :'cavv' => :'cavv',
    :'cavv_algorithm' => :'cavvAlgorithm',
    :'challenge_required' => :'challengeRequired',
    :'ecommerce_indicator' => :'ecommerceIndicator',
    :'eci' => :'eci',
    :'eci_raw' => :'eciRaw',
    :'pareq' => :'pareq',
    :'pares_status' => :'paresStatus',
    :'proof_xml' => :'proofXml',
    :'proxy_pan' => :'proxyPan',
    :'specification_version' => :'specificationVersion',
    :'ucaf_authentication_data' => :'ucafAuthenticationData',
    :'ucaf_collection_indicator' => :'ucafCollectionIndicator',
    :'veres_enrolled' => :'veresEnrolled',
    :'xid' => :'xid'
  }
end

.swagger_typesObject

Attribute type mapping.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
# File 'lib/cybersource_rest_client/models/risk_v1_authentications_post201_response_consumer_authentication_information.rb', line 96

def self.swagger_types
  {
    :'acs_url' => :'String',
    :'authentication_path' => :'String',
    :'authentication_transaction_id' => :'String',
    :'cavv' => :'String',
    :'cavv_algorithm' => :'String',
    :'challenge_required' => :'String',
    :'ecommerce_indicator' => :'String',
    :'eci' => :'String',
    :'eci_raw' => :'String',
    :'pareq' => :'String',
    :'pares_status' => :'String',
    :'proof_xml' => :'String',
    :'proxy_pan' => :'String',
    :'specification_version' => :'String',
    :'ucaf_authentication_data' => :'String',
    :'ucaf_collection_indicator' => :'Float',
    :'veres_enrolled' => :'String',
    :'xid' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
# File 'lib/cybersource_rest_client/models/risk_v1_authentications_post201_response_consumer_authentication_information.rb', line 305

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      acs_url == o.acs_url &&
      authentication_path == o.authentication_path &&
      authentication_transaction_id == o.authentication_transaction_id &&
      cavv == o.cavv &&
      cavv_algorithm == o.cavv_algorithm &&
      challenge_required == o.challenge_required &&
      ecommerce_indicator == o.ecommerce_indicator &&
      eci == o.eci &&
      eci_raw == o.eci_raw &&
      pareq == o.pareq &&
      pares_status == o.pares_status &&
      proof_xml == o.proof_xml &&
      proxy_pan == o.proxy_pan &&
      specification_version == o.specification_version &&
      ucaf_authentication_data == o.ucaf_authentication_data &&
      ucaf_collection_indicator == o.ucaf_collection_indicator &&
      veres_enrolled == o.veres_enrolled &&
      xid == o.xid
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
# File 'lib/cybersource_rest_client/models/risk_v1_authentications_post201_response_consumer_authentication_information.rb', line 364

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



430
431
432
433
434
435
436
437
438
439
440
441
442
# File 'lib/cybersource_rest_client/models/risk_v1_authentications_post201_response_consumer_authentication_information.rb', line 430

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



343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
# File 'lib/cybersource_rest_client/models/risk_v1_authentications_post201_response_consumer_authentication_information.rb', line 343

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


330
331
332
# File 'lib/cybersource_rest_client/models/risk_v1_authentications_post201_response_consumer_authentication_information.rb', line 330

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.



336
337
338
# File 'lib/cybersource_rest_client/models/risk_v1_authentications_post201_response_consumer_authentication_information.rb', line 336

def hash
  [acs_url, authentication_path, authentication_transaction_id, cavv, cavv_algorithm, challenge_required, ecommerce_indicator, eci, eci_raw, pareq, pares_status, proof_xml, proxy_pan, specification_version, ucaf_authentication_data, ucaf_collection_indicator, veres_enrolled, xid].hash
end

#list_invalid_propertiesObject

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



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

def list_invalid_properties
  invalid_properties = Array.new
  if !@acs_url.nil? && @acs_url.to_s.length > 2048
    invalid_properties.push('invalid value for "acs_url", the character length must be smaller than or equal to 2048.')
  end

  if !@authentication_transaction_id.nil? && @authentication_transaction_id.to_s.length > 20
    invalid_properties.push('invalid value for "authentication_transaction_id", the character length must be smaller than or equal to 20.')
  end

  if !@cavv.nil? && @cavv.to_s.length > 255
    invalid_properties.push('invalid value for "cavv", the character length must be smaller than or equal to 255.')
  end

  if !@cavv_algorithm.nil? && @cavv_algorithm.to_s.length > 1
    invalid_properties.push('invalid value for "cavv_algorithm", the character length must be smaller than or equal to 1.')
  end

  if !@challenge_required.nil? && @challenge_required.to_s.length > 1
    invalid_properties.push('invalid value for "challenge_required", the character length must be smaller than or equal to 1.')
  end

  if !@ecommerce_indicator.nil? && @ecommerce_indicator.to_s.length > 255
    invalid_properties.push('invalid value for "ecommerce_indicator", the character length must be smaller than or equal to 255.')
  end

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)



410
411
412
# File 'lib/cybersource_rest_client/models/risk_v1_authentications_post201_response_consumer_authentication_information.rb', line 410

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash



416
417
418
419
420
421
422
423
424
# File 'lib/cybersource_rest_client/models/risk_v1_authentications_post201_response_consumer_authentication_information.rb', line 416

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



404
405
406
# File 'lib/cybersource_rest_client/models/risk_v1_authentications_post201_response_consumer_authentication_information.rb', line 404

def to_s
  to_hash.to_s
end

#valid?Boolean

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



233
234
235
236
237
238
239
240
241
# File 'lib/cybersource_rest_client/models/risk_v1_authentications_post201_response_consumer_authentication_information.rb', line 233

def valid?
  return false if !@acs_url.nil? && @acs_url.to_s.length > 2048
  return false if !@authentication_transaction_id.nil? && @authentication_transaction_id.to_s.length > 20
  return false if !@cavv.nil? && @cavv.to_s.length > 255
  return false if !@cavv_algorithm.nil? && @cavv_algorithm.to_s.length > 1
  return false if !@challenge_required.nil? && @challenge_required.to_s.length > 1
  return false if !@ecommerce_indicator.nil? && @ecommerce_indicator.to_s.length > 255
  true
end