class CyberSource::V2creditsProcessingInformation
Attributes
Type of transaction. Some payment card companies use this information when determining discount rates. When you omit this field for **Ingenico ePayments**, the processor uses the default transaction type they have on file for you instead of the default value listed here.
Value that links the current payment request to the original request. Set this value to the ID that was returned in the reply message from the original payment request. This value is used for: - Partial authorizations. - Split shipments.
Type of digital payment solution that is being used for the transaction. Possible Values: - visacheckout: Visa Checkout. - 001: Apple Pay. - 005: Masterpass. Required for Masterpass transactions on OmniPay Direct. - 006: Android Pay. - 008: Samsung Pay.
Value that identifies the processor/acquirer to use for the transaction. This value is supported only for **CyberSource through VisaNet**.
Set this field to 3 to indicate that the request includes Level III data.
Please check with Cybersource customer support to see if your merchant account is configured correctly so you can include this field in your request. * For Payouts: max length for FDCCompass is String (22).
Attribute that lets you define custom grouping for your processor reports. This field is supported only for Litle.
Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in the Visa Checkout callID field.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/cyberSource_client/models/v2credits_processing_information.rb, line 44 def self.attribute_map { :'commerce_indicator' => :'commerceIndicator', :'processor_id' => :'processorId', :'payment_solution' => :'paymentSolution', :'reconciliation_id' => :'reconciliationId', :'link_id' => :'linkId', :'report_group' => :'reportGroup', :'visa_checkout_id' => :'visaCheckoutId', :'purchase_level' => :'purchaseLevel', :'recurring_options' => :'recurringOptions' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/cyberSource_client/models/v2credits_processing_information.rb, line 75 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?(:'commerceIndicator') self.commerce_indicator = attributes[:'commerceIndicator'] end if attributes.has_key?(:'processorId') self.processor_id = attributes[:'processorId'] end if attributes.has_key?(:'paymentSolution') self.payment_solution = attributes[:'paymentSolution'] end if attributes.has_key?(:'reconciliationId') self.reconciliation_id = attributes[:'reconciliationId'] end if attributes.has_key?(:'linkId') self.link_id = attributes[:'linkId'] end if attributes.has_key?(:'reportGroup') self.report_group = attributes[:'reportGroup'] end if attributes.has_key?(:'visaCheckoutId') self.visa_checkout_id = attributes[:'visaCheckoutId'] end if attributes.has_key?(:'purchaseLevel') self.purchase_level = attributes[:'purchaseLevel'] end if attributes.has_key?(:'recurringOptions') self.recurring_options = attributes[:'recurringOptions'] end end
Attribute type mapping.
# File lib/cyberSource_client/models/v2credits_processing_information.rb, line 59 def self.swagger_types { :'commerce_indicator' => :'String', :'processor_id' => :'String', :'payment_solution' => :'String', :'reconciliation_id' => :'String', :'link_id' => :'String', :'report_group' => :'String', :'visa_checkout_id' => :'String', :'purchase_level' => :'String', :'recurring_options' => :'V2paymentsidrefundsProcessingInformationRecurringOptions' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/cyberSource_client/models/v2credits_processing_information.rb, line 253 def ==(o) return true if self.equal?(o) self.class == o.class && commerce_indicator == o.commerce_indicator && processor_id == o.processor_id && payment_solution == o.payment_solution && reconciliation_id == o.reconciliation_id && link_id == o.link_id && report_group == o.report_group && visa_checkout_id == o.visa_checkout_id && purchase_level == o.purchase_level && recurring_options == o.recurring_options end
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/v2credits_processing_information.rb, line 303 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
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/v2credits_processing_information.rb, line 369 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
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/v2credits_processing_information.rb, line 282 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
Custom attribute writer method with validation @param [Object] commerce_indicator
Value to be assigned
# File lib/cyberSource_client/models/v2credits_processing_information.rb, line 173 def commerce_indicator=(commerce_indicator) if !commerce_indicator.nil? && commerce_indicator.to_s.length > 20 fail ArgumentError, 'invalid value for "commerce_indicator", the character length must be smaller than or equal to 20.' end @commerce_indicator = commerce_indicator end
@see the `==` method @param [Object] Object to be compared
# File lib/cyberSource_client/models/v2credits_processing_information.rb, line 269 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/cyberSource_client/models/v2credits_processing_information.rb, line 275 def hash [commerce_indicator, processor_id, payment_solution, reconciliation_id, link_id, report_group, visa_checkout_id, purchase_level, recurring_options].hash end
Custom attribute writer method with validation @param [Object] link_id
Value to be assigned
# File lib/cyberSource_client/models/v2credits_processing_information.rb, line 213 def link_id=(link_id) if !link_id.nil? && link_id.to_s.length > 26 fail ArgumentError, 'invalid value for "link_id", the character length must be smaller than or equal to 26.' end @link_id = link_id end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/cyberSource_client/models/v2credits_processing_information.rb, line 120 def list_invalid_properties invalid_properties = Array.new if !@commerce_indicator.nil? && @commerce_indicator.to_s.length > 20 invalid_properties.push('invalid value for "commerce_indicator", the character length must be smaller than or equal to 20.') end if !@processor_id.nil? && @processor_id.to_s.length > 3 invalid_properties.push('invalid value for "processor_id", the character length must be smaller than or equal to 3.') end if !@payment_solution.nil? && @payment_solution.to_s.length > 12 invalid_properties.push('invalid value for "payment_solution", the character length must be smaller than or equal to 12.') end if !@reconciliation_id.nil? && @reconciliation_id.to_s.length > 60 invalid_properties.push('invalid value for "reconciliation_id", the character length must be smaller than or equal to 60.') end if !@link_id.nil? && @link_id.to_s.length > 26 invalid_properties.push('invalid value for "link_id", the character length must be smaller than or equal to 26.') end if !@report_group.nil? && @report_group.to_s.length > 25 invalid_properties.push('invalid value for "report_group", the character length must be smaller than or equal to 25.') end if !@visa_checkout_id.nil? && @visa_checkout_id.to_s.length > 48 invalid_properties.push('invalid value for "visa_checkout_id", the character length must be smaller than or equal to 48.') end if !@purchase_level.nil? && @purchase_level.to_s.length > 1 invalid_properties.push('invalid value for "purchase_level", the character length must be smaller than or equal to 1.') end invalid_properties end
Custom attribute writer method with validation @param [Object] payment_solution
Value to be assigned
# File lib/cyberSource_client/models/v2credits_processing_information.rb, line 193 def payment_solution=(payment_solution) if !payment_solution.nil? && payment_solution.to_s.length > 12 fail ArgumentError, 'invalid value for "payment_solution", the character length must be smaller than or equal to 12.' end @payment_solution = payment_solution end
Custom attribute writer method with validation @param [Object] processor_id
Value to be assigned
# File lib/cyberSource_client/models/v2credits_processing_information.rb, line 183 def processor_id=(processor_id) if !processor_id.nil? && processor_id.to_s.length > 3 fail ArgumentError, 'invalid value for "processor_id", the character length must be smaller than or equal to 3.' end @processor_id = processor_id end
Custom attribute writer method with validation @param [Object] purchase_level
Value to be assigned
# File lib/cyberSource_client/models/v2credits_processing_information.rb, line 243 def purchase_level=(purchase_level) if !purchase_level.nil? && purchase_level.to_s.length > 1 fail ArgumentError, 'invalid value for "purchase_level", the character length must be smaller than or equal to 1.' end @purchase_level = purchase_level end
Custom attribute writer method with validation @param [Object] reconciliation_id
Value to be assigned
# File lib/cyberSource_client/models/v2credits_processing_information.rb, line 203 def reconciliation_id=(reconciliation_id) if !reconciliation_id.nil? && reconciliation_id.to_s.length > 60 fail ArgumentError, 'invalid value for "reconciliation_id", the character length must be smaller than or equal to 60.' end @reconciliation_id = reconciliation_id end
Custom attribute writer method with validation @param [Object] report_group
Value to be assigned
# File lib/cyberSource_client/models/v2credits_processing_information.rb, line 223 def report_group=(report_group) if !report_group.nil? && report_group.to_s.length > 25 fail ArgumentError, 'invalid value for "report_group", the character length must be smaller than or equal to 25.' end @report_group = report_group end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/cyberSource_client/models/v2credits_processing_information.rb, line 355 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/cyberSource_client/models/v2credits_processing_information.rb, line 343 def to_s to_hash.to_s end
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/v2credits_processing_information.rb, line 159 def valid? return false if !@commerce_indicator.nil? && @commerce_indicator.to_s.length > 20 return false if !@processor_id.nil? && @processor_id.to_s.length > 3 return false if !@payment_solution.nil? && @payment_solution.to_s.length > 12 return false if !@reconciliation_id.nil? && @reconciliation_id.to_s.length > 60 return false if !@link_id.nil? && @link_id.to_s.length > 26 return false if !@report_group.nil? && @report_group.to_s.length > 25 return false if !@visa_checkout_id.nil? && @visa_checkout_id.to_s.length > 48 return false if !@purchase_level.nil? && @purchase_level.to_s.length > 1 true end
Custom attribute writer method with validation @param [Object] visa_checkout_id
Value to be assigned
# File lib/cyberSource_client/models/v2credits_processing_information.rb, line 233 def visa_checkout_id=(visa_checkout_id) if !visa_checkout_id.nil? && visa_checkout_id.to_s.length > 48 fail ArgumentError, 'invalid value for "visa_checkout_id", the character length must be smaller than or equal to 48.' end @visa_checkout_id = visa_checkout_id end