Class: CyberSource::Riskv1authenticationresultsConsumerAuthenticationInformation

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Riskv1authenticationresultsConsumerAuthenticationInformation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb', line 97

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

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

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

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

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

  if attributes.has_key?(:'responseAccessToken')
    self.response_access_token = attributes[:'responseAccessToken']
  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

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

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

Instance Attribute Details

#authentication_transaction_context ⇒ Object

Authentication transaction context is used as a unique identifier to link enroll and validate call.



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

def authentication_transaction_context
  @authentication_transaction_context
end

#authentication_transaction_id ⇒ Object

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.



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

def authentication_transaction_id
  @authentication_transaction_id
end

#authentication_type ⇒ Object

Indicates the type of authentication that will be used to challenge the card holder. Possible Values: 01 - Static 02 - Dynamic 03 - OOB (Out of Band) 04 - Decoupled 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.



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

def authentication_type
  @authentication_type
end

#credential_encrypted ⇒ Object

A flag to indicate if the passed credential has been encrypted by the Merchant.



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

def credential_encrypted
  @credential_encrypted
end

#effective_authentication_type ⇒ Object

This field describes the type of 3DS transaction flow that took place. It can be one of three possible flows; CH - Challenge FR - Frictionless FD - Frictionless with delegation, (challenge not generated by the issuer but by the scheme on behalf of the issuer).



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

def effective_authentication_type
  @effective_authentication_type
end

#otp_token ⇒ Object

OTP entered by the card holder.



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

def otp_token
  @otp_token
end

#response_access_token ⇒ Object

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.



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

def response_access_token
  @response_access_token
end

#signed_pares ⇒ Object

Payer authentication result (PARes) message returned by the card-issuing bank. If you need to show proof of enrollment checking, you may need to decrypt and parse the string for the information required by the payment card company. For more information, see "Storing Payer Authentication Data," page 160. Important The value is in base64. You must remove all carriage returns and line feeds before adding the PARes to the request.



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

def signed_pares
  @signed_pares
end

#signed_pares_status_reason ⇒ Object

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



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

def signed_pares_status_reason
  @signed_pares_status_reason
end

#white_list_status ⇒ Object

Enables the communication of trusted beneficiary/whitelist status between the ACS, the DS and the 3DS Requestor. Possible Values: Y - 3DS Requestor is whitelisted by cardholder N - 3DS Requestor is not whitelisted by cardholder



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

def white_list_status
  @white_list_status
end

Class Method Details

.attribute_map ⇒ Object

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



48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb', line 48

def self.attribute_map
  {
    :'authentication_transaction_id' => :'authenticationTransactionId',
    :'authentication_transaction_context' => :'authenticationTransactionContext',
    :'otp_token' => :'otpToken',
    :'authentication_type' => :'authenticationType',
    :'effective_authentication_type' => :'effectiveAuthenticationType',
    :'response_access_token' => :'responseAccessToken',
    :'signed_pares_status_reason' => :'signedParesStatusReason',
    :'signed_pares' => :'signedPares',
    :'white_list_status' => :'whiteListStatus',
    :'credential_encrypted' => :'credentialEncrypted'
  }
end

.json_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb', line 64

def self.json_map
  {
    :'authentication_transaction_id' => :'authentication_transaction_id',
    :'authentication_transaction_context' => :'authentication_transaction_context',
    :'otp_token' => :'otp_token',
    :'authentication_type' => :'authentication_type',
    :'effective_authentication_type' => :'effective_authentication_type',
    :'response_access_token' => :'response_access_token',
    :'signed_pares_status_reason' => :'signed_pares_status_reason',
    :'signed_pares' => :'signed_pares',
    :'white_list_status' => :'white_list_status',
    :'credential_encrypted' => :'credential_encrypted'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb', line 80

def self.swagger_types
  {
    :'authentication_transaction_id' => :'String',
    :'authentication_transaction_context' => :'String',
    :'otp_token' => :'String',
    :'authentication_type' => :'String',
    :'effective_authentication_type' => :'String',
    :'response_access_token' => :'String',
    :'signed_pares_status_reason' => :'String',
    :'signed_pares' => :'String',
    :'white_list_status' => :'String',
    :'credential_encrypted' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb', line 207

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      authentication_transaction_id == o.authentication_transaction_id &&
      authentication_transaction_context == o.authentication_transaction_context &&
      otp_token == o.otp_token &&
      authentication_type == o.authentication_type &&
      effective_authentication_type == o.effective_authentication_type &&
      response_access_token == o.response_access_token &&
      signed_pares_status_reason == o.signed_pares_status_reason &&
      signed_pares == o.signed_pares &&
      white_list_status == o.white_list_status &&
      credential_encrypted == o.credential_encrypted
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



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

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



324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb', line 324

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



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb', line 237

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


224
225
226
 
# File 'lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb', line 224

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



230
231
232
 
# File 'lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb', line 230

def hash
  [authentication_transaction_id, authentication_transaction_context, otp_token, authentication_type, effective_authentication_type, response_access_token, signed_pares_status_reason, signed_pares, white_list_status, credential_encrypted].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



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

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



304
305
306
 
# File 'lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb', line 304

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



310
311
312
313
314
315
316
317
318
 
# File 'lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb', line 310

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



298
299
300
 
# File 'lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb', line 298

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



153
154
155
 
# File 'lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb', line 153

def valid?
  true
end