class CyberSource::V2payoutsMerchantInformation

Attributes

category_code[RW]

Four-digit number that the payment card industry uses to classify merchants into market segments. Visa assigned one or more of these values to your business when you started accepting Visa cards. If you do not include this field in your request, CyberSource uses the value in your CyberSource account. For processor-specific information, see the merchant_category_code field in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)

merchant_descriptor[RW]
submit_local_date_time[RW]

Time that the transaction was submitted in local time. The time is in hhmmss format.

vat_registration_number[RW]

Your government-assigned tax identification number. For CtV processors, the maximum length is 20. For other processor-specific information, see the merchant_vat_registration_number field in [Level II and Level III Processing Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)

Public Class Methods

attribute_map() click to toggle source

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

# File lib/cyberSource_client/models/v2payouts_merchant_information.rb, line 29
def self.attribute_map
  {
    :'category_code' => :'categoryCode',
    :'submit_local_date_time' => :'submitLocalDateTime',
    :'vat_registration_number' => :'vatRegistrationNumber',
    :'merchant_descriptor' => :'merchantDescriptor'
  }
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/v2payouts_merchant_information.rb, line 50
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?(:'categoryCode')
    self.category_code = attributes[:'categoryCode']
  end

  if attributes.has_key?(:'submitLocalDateTime')
    self.submit_local_date_time = attributes[:'submitLocalDateTime']
  end

  if attributes.has_key?(:'vatRegistrationNumber')
    self.vat_registration_number = attributes[:'vatRegistrationNumber']
  end

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

Attribute type mapping.

# File lib/cyberSource_client/models/v2payouts_merchant_information.rb, line 39
def self.swagger_types
  {
    :'category_code' => :'Integer',
    :'submit_local_date_time' => :'String',
    :'vat_registration_number' => :'String',
    :'merchant_descriptor' => :'V2payoutsMerchantInformationMerchantDescriptor'
  }
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/v2payouts_merchant_information.rb, line 133
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      category_code == o.category_code &&
      submit_local_date_time == o.submit_local_date_time &&
      vat_registration_number == o.vat_registration_number &&
      merchant_descriptor == o.merchant_descriptor
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/v2payouts_merchant_information.rb, line 178
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/v2payouts_merchant_information.rb, line 244
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/v2payouts_merchant_information.rb, line 157
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
category_code=(category_code) click to toggle source

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

# File lib/cyberSource_client/models/v2payouts_merchant_information.rb, line 103
def category_code=(category_code)
  if !category_code.nil? && category_code > 9999
    fail ArgumentError, 'invalid value for "category_code", must be smaller than or equal to 9999.'
  end

  @category_code = category_code
end
eql?(o) click to toggle source

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

# File lib/cyberSource_client/models/v2payouts_merchant_information.rb, line 144
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_client/models/v2payouts_merchant_information.rb, line 150
def hash
  [category_code, submit_local_date_time, vat_registration_number, merchant_descriptor].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/v2payouts_merchant_information.rb, line 75
def list_invalid_properties
  invalid_properties = Array.new
  if !@category_code.nil? && @category_code > 9999
    invalid_properties.push('invalid value for "category_code", must be smaller than or equal to 9999.')
  end

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

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

  invalid_properties
end
submit_local_date_time=(submit_local_date_time) click to toggle source

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

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

  @submit_local_date_time = submit_local_date_time
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/v2payouts_merchant_information.rb, line 224
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/v2payouts_merchant_information.rb, line 230
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/v2payouts_merchant_information.rb, line 218
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_client/models/v2payouts_merchant_information.rb, line 94
def valid?
  return false if !@category_code.nil? && @category_code > 9999
  return false if !@submit_local_date_time.nil? && @submit_local_date_time.to_s.length > 6
  return false if !@vat_registration_number.nil? && @vat_registration_number.to_s.length > 21
  true
end
vat_registration_number=(vat_registration_number) click to toggle source

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

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

  @vat_registration_number = vat_registration_number
end