class CyberSource::InlineResponse2011ProcessorInformation

Attributes

forwarded_acquirer_code[RW]

Name of the Japanese acquirer that processed the transaction. Returned only for CCS (CAFIS) and JCN Gateway. Please contact the CyberSource Japan Support Group for more information.

master_card_service_code[RW]

Mastercard service that was used for the transaction. Mastercard provides this value to CyberSource. Possible value: - 53: Mastercard card-on-file token service

master_card_service_reply_code[RW]

Result of the Mastercard card-on-file token service. Mastercard provides this value to CyberSource. Possible values: - C: Service completed successfully. - F: One of the following: - Incorrect Mastercard POS entry mode. The Mastercard POS entry mode should be 81 for an authorization or authorization reversal. - Incorrect Mastercard POS entry mode. The Mastercard POS entry mode should be 01 for a tokenized request. - Token requestor ID is missing or formatted incorrectly. - I: One of the following: - Invalid token requestor ID. - Suspended or deactivated token. - Invalid token (not in mapping table). - T: Invalid combination of token requestor ID and token. - U: Expired token. - W: Primary account number (PAN) listed in electronic warning bulletin. Note This field is returned only for **CyberSource through VisaNet**.

response_category_code[RW]

Processor-defined response category code. The associated detail error code is in the auth_auth_response field or the auth_reversal_auth_ response field depending on which service you requested. This field is supported only for: - Japanese issuers - Domestic transactions in Japan - Comercio Latino—processor transaction ID required for troubleshooting **Maximum length for processors**: - Comercio Latino: 32 - All other processors: 3

response_code[RW]

For most processors, this is the error message sent directly from the bank. Returned only when the processor returns this value. Important Do not use this field to evaluate the result of the authorization.

transaction_id[RW]

Processor transaction ID. This value identifies the transaction on a host system. This value is supported only for Moneris. It contains this information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. Example For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003

Public Class Methods

attribute_map() click to toggle source

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

# File lib/cyberSource_client/models/inline_response_201_1_processor_information.rb, line 36
def self.attribute_map
  {
    :'transaction_id' => :'transactionId',
    :'response_code' => :'responseCode',
    :'response_category_code' => :'responseCategoryCode',
    :'forwarded_acquirer_code' => :'forwardedAcquirerCode',
    :'master_card_service_code' => :'masterCardServiceCode',
    :'master_card_service_reply_code' => :'masterCardServiceReplyCode'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/cyberSource_client/models/inline_response_201_1_processor_information.rb, line 61
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?(:'transactionId')
    self.transaction_id = attributes[:'transactionId']
  end

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

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

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

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

  if attributes.has_key?(:'masterCardServiceReplyCode')
    self.master_card_service_reply_code = attributes[:'masterCardServiceReplyCode']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/cyberSource_client/models/inline_response_201_1_processor_information.rb, line 48
def self.swagger_types
  {
    :'transaction_id' => :'String',
    :'response_code' => :'String',
    :'response_category_code' => :'String',
    :'forwarded_acquirer_code' => :'String',
    :'master_card_service_code' => :'String',
    :'master_card_service_reply_code' => :'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_client/models/inline_response_201_1_processor_information.rb, line 197
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      transaction_id == o.transaction_id &&
      response_code == o.response_code &&
      response_category_code == o.response_category_code &&
      forwarded_acquirer_code == o.forwarded_acquirer_code &&
      master_card_service_code == o.master_card_service_code &&
      master_card_service_reply_code == o.master_card_service_reply_code
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_client/models/inline_response_201_1_processor_information.rb, line 244
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_client/models/inline_response_201_1_processor_information.rb, line 310
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) 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_client/models/inline_response_201_1_processor_information.rb, line 223
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) click to toggle source

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

# File lib/cyberSource_client/models/inline_response_201_1_processor_information.rb, line 210
def eql?(o)
  self == o
end
forwarded_acquirer_code=(forwarded_acquirer_code) click to toggle source

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

# File lib/cyberSource_client/models/inline_response_201_1_processor_information.rb, line 167
def forwarded_acquirer_code=(forwarded_acquirer_code)
  if !forwarded_acquirer_code.nil? && forwarded_acquirer_code.to_s.length > 32
    fail ArgumentError, 'invalid value for "forwarded_acquirer_code", the character length must be smaller than or equal to 32.'
  end

  @forwarded_acquirer_code = forwarded_acquirer_code
end
hash() click to toggle source

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

# File lib/cyberSource_client/models/inline_response_201_1_processor_information.rb, line 216
def hash
  [transaction_id, response_code, response_category_code, forwarded_acquirer_code, master_card_service_code, master_card_service_reply_code].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_client/models/inline_response_201_1_processor_information.rb, line 94
def list_invalid_properties
  invalid_properties = Array.new
  if !@transaction_id.nil? && @transaction_id.to_s.length > 18
    invalid_properties.push('invalid value for "transaction_id", the character length must be smaller than or equal to 18.')
  end

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

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

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

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

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

  invalid_properties
end
master_card_service_code=(master_card_service_code) click to toggle source

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

# File lib/cyberSource_client/models/inline_response_201_1_processor_information.rb, line 177
def master_card_service_code=(master_card_service_code)
  if !master_card_service_code.nil? && master_card_service_code.to_s.length > 2
    fail ArgumentError, 'invalid value for "master_card_service_code", the character length must be smaller than or equal to 2.'
  end

  @master_card_service_code = master_card_service_code
end
master_card_service_reply_code=(master_card_service_reply_code) click to toggle source

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

# File lib/cyberSource_client/models/inline_response_201_1_processor_information.rb, line 187
def master_card_service_reply_code=(master_card_service_reply_code)
  if !master_card_service_reply_code.nil? && master_card_service_reply_code.to_s.length > 1
    fail ArgumentError, 'invalid value for "master_card_service_reply_code", the character length must be smaller than or equal to 1.'
  end

  @master_card_service_reply_code = master_card_service_reply_code
end
response_category_code=(response_category_code) click to toggle source

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

# File lib/cyberSource_client/models/inline_response_201_1_processor_information.rb, line 157
def response_category_code=(response_category_code)
  if !response_category_code.nil? && response_category_code.to_s.length > 32
    fail ArgumentError, 'invalid value for "response_category_code", the character length must be smaller than or equal to 32.'
  end

  @response_category_code = response_category_code
end
response_code=(response_code) click to toggle source

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

# File lib/cyberSource_client/models/inline_response_201_1_processor_information.rb, line 147
def response_code=(response_code)
  if !response_code.nil? && response_code.to_s.length > 10
    fail ArgumentError, 'invalid value for "response_code", the character length must be smaller than or equal to 10.'
  end

  @response_code = response_code
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_client/models/inline_response_201_1_processor_information.rb, line 290
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_client/models/inline_response_201_1_processor_information.rb, line 296
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_client/models/inline_response_201_1_processor_information.rb, line 284
def to_s
  to_hash.to_s
end
transaction_id=(transaction_id) click to toggle source

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

# File lib/cyberSource_client/models/inline_response_201_1_processor_information.rb, line 137
def transaction_id=(transaction_id)
  if !transaction_id.nil? && transaction_id.to_s.length > 18
    fail ArgumentError, 'invalid value for "transaction_id", the character length must be smaller than or equal to 18.'
  end

  @transaction_id = transaction_id
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_client/models/inline_response_201_1_processor_information.rb, line 125
def valid?
  return false if !@transaction_id.nil? && @transaction_id.to_s.length > 18
  return false if !@response_code.nil? && @response_code.to_s.length > 10
  return false if !@response_category_code.nil? && @response_category_code.to_s.length > 32
  return false if !@forwarded_acquirer_code.nil? && @forwarded_acquirer_code.to_s.length > 32
  return false if !@master_card_service_code.nil? && @master_card_service_code.to_s.length > 2
  return false if !@master_card_service_reply_code.nil? && @master_card_service_reply_code.to_s.length > 1
  true
end