class CyberSource::Riskv1authenticationresultsConsumerAuthenticationInformation

Attributes

authentication_transaction_id[RW]

Payer authentication transaction identifier passed to link the check enrollment and validate authentication messages. Note: Required for Standard integration for enroll service. Required for Hybrid integration for validate service.

authentication_type[RW]

Indicates the type of authentication that will be used to challenge the card holder. Possible Values: 01 - Static 02 - Dynamic 03 - OOB (Out of Band) 04 - Decoupled NOTE: EMV 3-D Secure version 2.1.0 supports values 01-03. Version 2.2.0 supports values 01-04. Decoupled authentication is not supported at this time.

effective_authentication_type[RW]

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

response_access_token[RW]

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.

signed_pares[RW]

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.

signed_pares_status_reason[RW]

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

white_list_status[RW]

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

Public Class Methods

attribute_map() click to toggle source

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

# File lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb, line 39
def self.attribute_map
  {
    :'authentication_transaction_id' => :'authenticationTransactionId',
    :'authentication_type' => :'authenticationType',
    :'effective_authentication_type' => :'effectiveAuthenticationType',
    :'response_access_token' => :'responseAccessToken',
    :'signed_pares_status_reason' => :'signedParesStatusReason',
    :'signed_pares' => :'signedPares',
    :'white_list_status' => :'whiteListStatus'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb, line 66
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?(:'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
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb, line 52
def self.swagger_types
  {
    :'authentication_transaction_id' => :'String',
    :'authentication_type' => :'String',
    :'effective_authentication_type' => :'String',
    :'response_access_token' => :'String',
    :'signed_pares_status_reason' => :'String',
    :'signed_pares' => :'String',
    :'white_list_status' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb, line 146
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      authentication_transaction_id == o.authentication_transaction_id &&
      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
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb, line 194
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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb, line 260
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
authentication_transaction_id=(authentication_transaction_id) click to toggle source

Custom attribute writer method with validation @param [Object] authentication_transaction_id Value to be assigned

# File lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb, line 116
def authentication_transaction_id=(authentication_transaction_id)
  @authentication_transaction_id = authentication_transaction_id
end
authentication_type=(authentication_type) click to toggle source

Custom attribute writer method with validation @param [Object] authentication_type Value to be assigned

# File lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb, line 122
def authentication_type=(authentication_type)
  @authentication_type = authentication_type
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb, line 173
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
effective_authentication_type=(effective_authentication_type) click to toggle source

Custom attribute writer method with validation @param [Object] effective_authentication_type Value to be assigned

# File lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb, line 128
def effective_authentication_type=(effective_authentication_type)
  @effective_authentication_type = effective_authentication_type
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb, line 160
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb, line 166
def hash
  [authentication_transaction_id, authentication_type, effective_authentication_type, response_access_token, signed_pares_status_reason, signed_pares, white_list_status].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb, line 103
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
signed_pares_status_reason=(signed_pares_status_reason) click to toggle source

Custom attribute writer method with validation @param [Object] signed_pares_status_reason Value to be assigned

# File lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb, line 134
def signed_pares_status_reason=(signed_pares_status_reason)
  @signed_pares_status_reason = signed_pares_status_reason
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb, line 240
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb, line 246
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb, line 234
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb, line 110
def valid?
  true
end
white_list_status=(white_list_status) click to toggle source

Custom attribute writer method with validation @param [Object] white_list_status Value to be assigned

# File lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb, line 140
def white_list_status=(white_list_status)
  @white_list_status = white_list_status
end