Class: CyberSource::Ptsv2paymentsMerchantInformation

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv2paymentsMerchantInformation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information.rb', line 79

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'merchantName')
    self.merchant_name = attributes[:'merchantName']
  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)



35
36
37
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information.rb', line 35

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/ptsv2payments_merchant_information.rb', line 23

def category_code
  @category_code
end

#category_code_domestic ⇒ Object

Merchant category code for domestic transactions. 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. Including this field in a request for a domestic transaction might reduce interchange fees. When you include this field in a request: - Do not include the ‘merchant_category_code` field. - The value for this field overrides the value in your CyberSource account. This field is supported only for: - Domestic transactions with Mastercard in Spain. Domestic means that you and the cardholder are in the same country. - Merchants enrolled in the OmniPay Direct interchange program. - First Data Merchant Solutions (Europe) on OmniPay Direct.



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

def category_code_domestic
  @category_code_domestic
end

#merchant_descriptor ⇒ Object

Returns the value of attribute merchant_descriptor.



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

def merchant_descriptor
  @merchant_descriptor
end

#merchant_name ⇒ Object

Use this field only if you are requesting payment with Payer Authentication serice together. Your company’s name as you want it to appear to the customer in the issuing bank’s authentication form. This value overrides the value specified by your merchant bank.



43
44
45
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information.rb', line 43

def merchant_name
  @merchant_name
end

#sales_organization_id ⇒ Object

Company ID assigned to an independent sales organization. Get this value from Mastercard. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 106-116 - Field: Mastercard Independent Sales Organization ID Note The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. For processor-specific information, see the ‘sales_organization_ID` field description in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)



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

def sales_organization_id
  @sales_organization_id
end

#service_fee_descriptor ⇒ Object

Returns the value of attribute service_fee_descriptor.



40
41
42
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information.rb', line 40

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/)



29
30
31
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information.rb', line 29

def tax_id
  @tax_id
end

#transaction_local_date_time ⇒ Object

Date and time at your physical location. Format: ‘YYYYMMDDhhmmss`, where: - `YYYY` = year - `MM` = month - `DD` = day - `hh` = hour - `mm` = minutes - `ss` = seconds #### Used by Authorization Required for these processors: - American Express Direct - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - SIX Optional for all other processors.



38
39
40
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information.rb', line 38

def transaction_local_date_time
  @transaction_local_date_time
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)



32
33
34
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information.rb', line 32

def vat_registration_number
  @vat_registration_number
end

Class Method Details

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information.rb', line 46

def self.attribute_map
  {
    :'merchant_descriptor' => :'merchantDescriptor',
    :'sales_organization_id' => :'salesOrganizationId',
    :'category_code' => :'categoryCode',
    :'category_code_domestic' => :'categoryCodeDomestic',
    :'tax_id' => :'taxId',
    :'vat_registration_number' => :'vatRegistrationNumber',
    :'card_acceptor_reference_number' => :'cardAcceptorReferenceNumber',
    :'transaction_local_date_time' => :'transactionLocalDateTime',
    :'service_fee_descriptor' => :'serviceFeeDescriptor',
    :'merchant_name' => :'merchantName'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information.rb', line 62

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information.rb', line 261

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      merchant_descriptor == o.merchant_descriptor &&
      sales_organization_id == o.sales_organization_id &&
      category_code == o.category_code &&
      category_code_domestic == o.category_code_domestic &&
      tax_id == o.tax_id &&
      vat_registration_number == o.vat_registration_number &&
      card_acceptor_reference_number == o.card_acceptor_reference_number &&
      transaction_local_date_time == o.transaction_local_date_time &&
      service_fee_descriptor == o.service_fee_descriptor &&
      merchant_name == o.merchant_name
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



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information.rb', line 312

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



378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information.rb', line 378

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



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information.rb', line 291

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


278
279
280
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information.rb', line 278

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



284
285
286
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information.rb', line 284

def hash
  [merchant_descriptor, sales_organization_id, category_code, category_code_domestic, tax_id, vat_registration_number, card_acceptor_reference_number, transaction_local_date_time, service_fee_descriptor, merchant_name].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



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information.rb', line 128

def list_invalid_properties
  invalid_properties = Array.new
  if !@sales_organization_id.nil? && @sales_organization_id.to_s.length > 11
    invalid_properties.push('invalid value for "sales_organization_id", the character length must be smaller than or equal to 11.')
  end

  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 !@category_code_domestic.nil? && @category_code_domestic > 9999
    invalid_properties.push('invalid value for "category_code_domestic", must be smaller than or equal to 9999.')
  end

  if !@tax_id.nil? && @tax_id.to_s.length > 15
    invalid_properties.push('invalid value for "tax_id", the character length must be smaller than or equal to 15.')
  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

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

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

  if !@merchant_name.nil? && @merchant_name.to_s.length > 25
    invalid_properties.push('invalid value for "merchant_name", the character length must be smaller than or equal to 25.')
  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



358
359
360
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information.rb', line 358

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



364
365
366
367
368
369
370
371
372
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information.rb', line 364

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



352
353
354
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information.rb', line 352

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



167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information.rb', line 167

def valid?
  return false if !@sales_organization_id.nil? && @sales_organization_id.to_s.length > 11
  return false if !@category_code.nil? && @category_code > 9999
  return false if !@category_code_domestic.nil? && @category_code_domestic > 9999
  return false if !@tax_id.nil? && @tax_id.to_s.length > 15
  return false if !@vat_registration_number.nil? && @vat_registration_number.to_s.length > 21
  return false if !@card_acceptor_reference_number.nil? && @card_acceptor_reference_number.to_s.length > 25
  return false if !@transaction_local_date_time.nil? && @transaction_local_date_time.to_s.length > 14
  return false if !@merchant_name.nil? && @merchant_name.to_s.length > 25
  true
end