Class: CyberSource::Ptsv2paymentsidcapturesMerchantInformation

Inherits:
Object
  • Object
show all
Defined in:
lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_merchant_information.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv2paymentsidcapturesMerchantInformation

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_merchant_information.rb', line 59

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

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

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

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

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

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

Instance Attribute Details

#card_acceptor_reference_number ⇒ Object

Reference number that facilitates card acceptor/corporation communication and record keeping. For processor-specific information, see the ‘card_acceptor_ref_number` field description in [Level II and Level III Processing Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)



20
21
22
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_merchant_information.rb', line 20

def card_acceptor_reference_number
  @card_acceptor_reference_number
end

#category_code ⇒ Object

The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company’s cards. When 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 description in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR4 - Position: 150-153 - Field: Merchant Category Code



23
24
25
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_merchant_information.rb', line 23

def category_code
  @category_code
end

#merchant_descriptor ⇒ Object

Returns the value of attribute merchant_descriptor.



17
18
19
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_merchant_information.rb', line 17

def merchant_descriptor
  @merchant_descriptor
end

#service_fee_descriptor ⇒ Object

Returns the value of attribute service_fee_descriptor.



28
29
30
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_merchant_information.rb', line 28

def service_fee_descriptor
  @service_fee_descriptor
end

#tax_id ⇒ Object

Your Cadastro Nacional da Pessoa Jurídica (CNPJ) number. This field is supported only for BNDES transactions on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR6 - Position: 40-59 - Field: BNDES Reference Field 1 For details, see ‘bill_merchant_tax_id` field description in the [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)



31
32
33
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_merchant_information.rb', line 31

def tax_id
  @tax_id
end

#vat_registration_number ⇒ Object

Your government-assigned tax identification number. #### Tax Calculation Required field for value added tax only. Not applicable to U.S. and Canadian taxes. #### CyberSource through VisaNet For CtV processors, the maximum length is 20. For other processor-specific information, see the ‘merchant_vat_registration_number` field description in [Level II and Level III Processing Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)



26
27
28
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_merchant_information.rb', line 26

def vat_registration_number
  @vat_registration_number
end

Class Method Details

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
41
42
43
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_merchant_information.rb', line 34

def self.attribute_map
  {
    :'merchant_descriptor' => :'merchantDescriptor',
    :'card_acceptor_reference_number' => :'cardAcceptorReferenceNumber',
    :'category_code' => :'categoryCode',
    :'vat_registration_number' => :'vatRegistrationNumber',
    :'service_fee_descriptor' => :'serviceFeeDescriptor',
    :'tax_id' => :'taxId'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



46
47
48
49
50
51
52
53
54
55
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_merchant_information.rb', line 46

def self.swagger_types
  {
    :'merchant_descriptor' => :'Ptsv2paymentsMerchantInformationMerchantDescriptor',
    :'card_acceptor_reference_number' => :'String',
    :'category_code' => :'Integer',
    :'vat_registration_number' => :'String',
    :'service_fee_descriptor' => :'Ptsv2paymentsMerchantInformationServiceFeeDescriptor',
    :'tax_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



138
139
140
141
142
143
144
145
146
147
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_merchant_information.rb', line 138

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      merchant_descriptor == o.merchant_descriptor &&
      card_acceptor_reference_number == o.card_acceptor_reference_number &&
      category_code == o.category_code &&
      vat_registration_number == o.vat_registration_number &&
      service_fee_descriptor == o.service_fee_descriptor &&
      tax_id == o.tax_id
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_merchant_information.rb', line 185

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) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_merchant_information.rb', line 251

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_merchant_information.rb', line 164

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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


151
152
153
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_merchant_information.rb', line 151

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



157
158
159
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_merchant_information.rb', line 157

def hash
  [merchant_descriptor, card_acceptor_reference_number, category_code, vat_registration_number, service_fee_descriptor, tax_id].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



92
93
94
95
96
97
98
99
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_merchant_information.rb', line 92

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



231
232
233
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_merchant_information.rb', line 231

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



237
238
239
240
241
242
243
244
245
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_merchant_information.rb', line 237

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



225
226
227
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_merchant_information.rb', line 225

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



103
104
105
106
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_merchant_information.rb', line 103

def valid?
  return false if !@category_code.nil? && @category_code > 9999
  true
end