class CyberSource::Ptsv2payoutsMerchantInformationMerchantDescriptor

Attributes

administrative_area[RW]

The state where the merchant is located. #### PIN debit State code or region code for your business. Use the Use the [State, Province, and Territory Codes for the United States and Canada](developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) This value might be displayed on the cardholder’s statement. When you do not include this value in your PIN debit request, the merchant name from your account is used. Important This value must consist of English characters. Note This field is supported only for businesses located in the U.S. or Canada. Optional field for PIN debit credit or PIN debit purchase.

contact[RW]

For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_contact` field description in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)–> Contact information for the merchant. Note These are the maximum data lengths for the following payment processors: - FDCCompass (13) - Paymentech (13)

country[RW]

Merchant's country. #### PIN debit Country code for your business location. Use the [ISO Standard Country Codes](developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) This value might be displayed on the cardholder’s statement. When you do not include this value in your PIN debit request, the merchant name from your account is used. Important This value must consist of English characters. Note If your business is located in the U.S. or Canada and you include this field in a request, you must also include `merchantInformation.merchantDescriptor.administrativeArea`. Optional field for PIN debit credit or PIN debit purchase.

locality[RW]

Merchant's City. #### PIN debit City for your business location. This value might be displayed on the cardholder’s statement. When you do not include this value in your PIN debit request, the merchant name from your account is used. Important This value must consist of English characters. Optional field for PIN debit credit or PIN debit purchase requests.

name[RW]

Your merchant name. Note For Paymentech processor using Cybersource Payouts, the maximum data length is 22. #### PIN debit Your business name. This name is displayed on the cardholder’s statement. When you include more than one consecutive space, extra spaces are removed. When you do not include this value in your PIN debit request, the merchant name from your account is used. Important This value must consist of English characters. Optional field for PIN debit credit or PIN debit purchase requests. #### Airline processing Your merchant name. This name is displayed on the cardholder’s statement. When you include more than one consecutive space, extra spaces are removed. Note Some airline fee programs may require the original ticket number (ticket identifier) or the ancillary service description in positions 13 through 23 of this field. Important This value must consist of English characters. Required for captures and credits.

postal_code[RW]

Merchant's postal code. #### PIN debit Postal code for your business location. This value might be displayed on the cardholder’s statement. If your business is domiciled in the U.S., you can use a 5-digit or 9-digit postal code. A 9-digit postal code must follow this format: [5 digits][4 digits] Example: `12345-6789` If your business is domiciled in Canada, you can use a 6-digit or 9-digit postal code. A 6-digit postal code must follow this format: [alpha][alpha] [numeric][numeric] Example: `A1B 2C3` When you do not include this value in your PIN debit request, the merchant name from your account is used. Important This value must consist of English characters. Note This field is supported only for businesses located in the U.S. or Canada. Important Mastercard requires a postal code for any country that uses postal codes. You can provide the postal code in your account or you can include this field in your request. Optional field for PIN debit credit or PIN debit purchase.

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/ptsv2payouts_merchant_information_merchant_descriptor.rb, line 36
def self.attribute_map
  {
    :'name' => :'name',
    :'locality' => :'locality',
    :'country' => :'country',
    :'administrative_area' => :'administrativeArea',
    :'postal_code' => :'postalCode',
    :'contact' => :'contact'
  }
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/ptsv2payouts_merchant_information_merchant_descriptor.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?(:'name')
    self.name = attributes[:'name']
  end

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

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

  if attributes.has_key?(:'administrativeArea')
    self.administrative_area = attributes[:'administrativeArea']
  end

  if attributes.has_key?(:'postalCode')
    self.postal_code = attributes[:'postalCode']
  end

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

Attribute type mapping.

# File lib/cybersource_rest_client/models/ptsv2payouts_merchant_information_merchant_descriptor.rb, line 48
def self.swagger_types
  {
    :'name' => :'String',
    :'locality' => :'String',
    :'country' => :'String',
    :'administrative_area' => :'String',
    :'postal_code' => :'String',
    :'contact' => :'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/ptsv2payouts_merchant_information_merchant_descriptor.rb, line 131
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      locality == o.locality &&
      country == o.country &&
      administrative_area == o.administrative_area &&
      postal_code == o.postal_code &&
      contact == o.contact
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/ptsv2payouts_merchant_information_merchant_descriptor.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_rest_client/models/ptsv2payouts_merchant_information_merchant_descriptor.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_rest_client/models/ptsv2payouts_merchant_information_merchant_descriptor.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
contact=(contact) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payouts_merchant_information_merchant_descriptor.rb, line 125
def contact=(contact)
  @contact = contact
end
country=(country) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payouts_merchant_information_merchant_descriptor.rb, line 113
def country=(country)
  @country = country
end
eql?(o) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payouts_merchant_information_merchant_descriptor.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_rest_client/models/ptsv2payouts_merchant_information_merchant_descriptor.rb, line 150
def hash
  [name, locality, country, administrative_area, postal_code, contact].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/ptsv2payouts_merchant_information_merchant_descriptor.rb, line 94
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
locality=(locality) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payouts_merchant_information_merchant_descriptor.rb, line 107
def locality=(locality)
  @locality = locality
end
postal_code=(postal_code) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payouts_merchant_information_merchant_descriptor.rb, line 119
def postal_code=(postal_code)
  @postal_code = postal_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_rest_client/models/ptsv2payouts_merchant_information_merchant_descriptor.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_rest_client/models/ptsv2payouts_merchant_information_merchant_descriptor.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_rest_client/models/ptsv2payouts_merchant_information_merchant_descriptor.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_rest_client/models/ptsv2payouts_merchant_information_merchant_descriptor.rb, line 101
def valid?
  true
end