class CyberSource::PtsV2IncrementalAuthorizationPatch201ResponseProcessorInformation

Attributes

approval_code[RW]

Authorization code. Returned only when the processor returns this value. The length of this value depends on your processor. Returned by authorization service. #### PIN debit Authorization code that is returned by the processor. Returned by PIN debit credit. #### Elavon Encrypted Account Number Program The returned value is OFFLINE. #### TSYS Acquiring Solutions The returned value for a successful zero amount authorization is 000000.

merchant_advice[RW]
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. #### PIN debit Response value that is returned by the processor or bank. Important Do not use this field to evaluate the results of the transaction request. Returned by PIN debit credit, PIN debit purchase, and PIN debit reversal. #### AIBMS If this value is `08`, you can accept the transaction if the customer provides you with identification. #### Atos This value is the response code sent from Atos and it might also include the response code from the bank. Format: `aa,bb` with the two values separated by a comma and where: - `aa` is the two-digit error message from Atos. - `bb` is the optional two-digit error message from the bank. #### Comercio Latino This value is the status code and the error or response code received from the processor separated by a colon. Format: [status code]:E[error code] or [status code]:R[response code] Example `2:R06` #### JCN Gateway Processor-defined detail error code. The associated response category code is in the `processorInformation.responseCategoryCode` field. String (3)

response_details[RW]

This field might contain information about a decline. This field is supported only for **CyberSource through VisaNet**.

system_trace_audit_number[RW]

This field is returned only for **American Express Direct** and **CyberSource through VisaNet**. Returned by authorization and incremental authorization services. #### American Express Direct System trace audit number (STAN). This value identifies the transaction and is useful when investigating a chargeback dispute. #### CyberSource through VisaNet System trace number that must be printed on the customer’s receipt.

transaction_id[RW]

Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. Returned by the authorization service. #### PIN debit Transaction identifier generated by the processor. Returned by PIN debit credit. #### GPX Processor transaction ID. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see "Network Transaction Identifiers" in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Moneris This value identifies the transaction on a host system. It contains the following 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_rest_client/models/pts_v2_incremental_authorization_patch201_response_processor_information.rb, line 35
def self.attribute_map
  {
    :'approval_code' => :'approvalCode',
    :'transaction_id' => :'transactionId',
    :'response_code' => :'responseCode',
    :'system_trace_audit_number' => :'systemTraceAuditNumber',
    :'response_details' => :'responseDetails',
    :'merchant_advice' => :'merchantAdvice'
  }
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/pts_v2_incremental_authorization_patch201_response_processor_information.rb, line 60
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?(:'approvalCode')
    self.approval_code = attributes[:'approvalCode']
  end

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

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

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

Attribute type mapping.

# File lib/cybersource_rest_client/models/pts_v2_incremental_authorization_patch201_response_processor_information.rb, line 47
def self.swagger_types
  {
    :'approval_code' => :'String',
    :'transaction_id' => :'String',
    :'response_code' => :'String',
    :'system_trace_audit_number' => :'String',
    :'response_details' => :'String',
    :'merchant_advice' => :'PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice'
  }
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/pts_v2_incremental_authorization_patch201_response_processor_information.rb, line 136
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      approval_code == o.approval_code &&
      transaction_id == o.transaction_id &&
      response_code == o.response_code &&
      system_trace_audit_number == o.system_trace_audit_number &&
      response_details == o.response_details &&
      merchant_advice == o.merchant_advice
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/pts_v2_incremental_authorization_patch201_response_processor_information.rb, line 183
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/pts_v2_incremental_authorization_patch201_response_processor_information.rb, line 249
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
approval_code=(approval_code) click to toggle source

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

# File lib/cybersource_rest_client/models/pts_v2_incremental_authorization_patch201_response_processor_information.rb, line 106
def approval_code=(approval_code)
  @approval_code = approval_code
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/pts_v2_incremental_authorization_patch201_response_processor_information.rb, line 162
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_rest_client/models/pts_v2_incremental_authorization_patch201_response_processor_information.rb, line 149
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/pts_v2_incremental_authorization_patch201_response_processor_information.rb, line 155
def hash
  [approval_code, transaction_id, response_code, system_trace_audit_number, response_details, merchant_advice].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/pts_v2_incremental_authorization_patch201_response_processor_information.rb, line 93
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
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_rest_client/models/pts_v2_incremental_authorization_patch201_response_processor_information.rb, line 118
def response_code=(response_code)
  @response_code = response_code
end
response_details=(response_details) click to toggle source

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

# File lib/cybersource_rest_client/models/pts_v2_incremental_authorization_patch201_response_processor_information.rb, line 130
def response_details=(response_details)
  @response_details = response_details
end
system_trace_audit_number=(system_trace_audit_number) click to toggle source

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

# File lib/cybersource_rest_client/models/pts_v2_incremental_authorization_patch201_response_processor_information.rb, line 124
def system_trace_audit_number=(system_trace_audit_number)
  @system_trace_audit_number = system_trace_audit_number
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/pts_v2_incremental_authorization_patch201_response_processor_information.rb, line 229
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/pts_v2_incremental_authorization_patch201_response_processor_information.rb, line 235
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/pts_v2_incremental_authorization_patch201_response_processor_information.rb, line 223
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_rest_client/models/pts_v2_incremental_authorization_patch201_response_processor_information.rb, line 112
def transaction_id=(transaction_id)
  @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_rest_client/models/pts_v2_incremental_authorization_patch201_response_processor_information.rb, line 100
def valid?
  true
end