Class: CyberSource::Ptsv2paymentsAggregatorInformationSubMerchant

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv2paymentsAggregatorInformationSubMerchant

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_aggregator_information_sub_merchant.rb', line 86

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#address1 ⇒ Object

First line of the sub-merchant’s street address. For processor-specific details, see ‘submerchant_street` 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 does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters.



27
28
29
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_aggregator_information_sub_merchant.rb', line 27

def address1
  @address1
end

#administrative_area ⇒ Object

Sub-merchant’s state or province. For possible values and also aggregator support, see ‘submerchant_state` request 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 does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters.



33
34
35
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_aggregator_information_sub_merchant.rb', line 33

def administrative_area
  @administrative_area
end

#card_acceptor_id ⇒ Object

Unique identifier assigned by the payment card company to the sub-merchant.



18
19
20
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_aggregator_information_sub_merchant.rb', line 18

def card_acceptor_id
  @card_acceptor_id
end

#country ⇒ Object

Sub-merchant’s country. Use the [ISO Standard Country Codes](developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file. #### FDC Compass This value must consist of uppercase characters. For details, see the ‘submerchant_country` request-level field description in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)



42
43
44
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_aggregator_information_sub_merchant.rb', line 42

def country
  @country
end

#email ⇒ Object

Sub-merchant’s email address. **Maximum length for processors** - American Express Direct: 40 - CyberSource through VisaNet: 40 - FDC Compass: 40 - FDC Nashville Global: 19 #### CyberSource through VisaNet With American Express, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCRB - Position: 25-64 - Field: American Express Seller E-mail Address 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.



45
46
47
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_aggregator_information_sub_merchant.rb', line 45

def email
  @email
end

#id ⇒ Object

The ID you assigned to your sub-merchant. CyberSource through VisaNet: For American Express transaction, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCRB - Position: 65-84 - Field: American Express Seller ID For Mastercard transactions, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 117-131 - Field: Mastercard Sub-Merchant ID FDC Compass: This value must consist of uppercase characters. American Express Direct: String (20) CyberSource through VisaNet with American Express: String (20) CyberSource through VisaNet with Mastercard: String (15) FDC Compass: String (20) FDC Nashville Global: String (14)



21
22
23
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_aggregator_information_sub_merchant.rb', line 21

def id
  @id
end

#locality ⇒ Object

Sub-merchant’s city. For processor-specific details, see ‘submerchant_city` request 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 does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters.



30
31
32
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_aggregator_information_sub_merchant.rb', line 30

def locality
  @locality
end

#name ⇒ Object

Sub-merchant’s business name. #### American Express Direct The maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters. #### CyberSource through VisaNet With American Express, the maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. #### FDC Nashville Global With Mastercard, the maximum length of the sub-merchant name depends on the length of the aggregator name: - If aggregator name length is 1 through 3, maximum sub-merchant name length is 21. - If aggregator name length is 4 through 7, maximum sub-merchant name length is 17. - If aggregator name length is 8 through 12, maximum sub-merchant name length is 12.



24
25
26
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_aggregator_information_sub_merchant.rb', line 24

def name
  @name
end

#phone_number ⇒ Object

Sub-merchant’s telephone number. **Maximum length for procesors** - American Express Direct: 20 - CyberSource through VisaNet: 20 - FDC Compass: 13 - FDC Nashville Global: 10 #### CyberSource through VisaNet With American Express, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCRB - Position: 5-24 - Field: American Express Seller Telephone Number **FDC Compass**\ This value must consist of uppercase characters. Use one of these recommended formats:\ ‘NNN-NNN-NNNN`\ `NNN-AAAAAAA`



48
49
50
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_aggregator_information_sub_merchant.rb', line 48

def phone_number
  @phone_number
end

#postal_code ⇒ Object

Partial postal code for the sub-merchant’s address. For processor-specific details, see ‘submerchant_postal_code` request 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 does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters.



39
40
41
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_aggregator_information_sub_merchant.rb', line 39

def postal_code
  @postal_code
end

#region ⇒ Object

Sub-merchant’s region. Example\ ‘NE` indicates that the sub-merchant is in the northeast region. For processor-specific details, see `submerchant_region` request field description in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)



36
37
38
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_aggregator_information_sub_merchant.rb', line 36

def region
  @region
end

Class Method Details

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_aggregator_information_sub_merchant.rb', line 51

def self.attribute_map
  {
    :'card_acceptor_id' => :'cardAcceptorId',
    :'id' => :'id',
    :'name' => :'name',
    :'address1' => :'address1',
    :'locality' => :'locality',
    :'administrative_area' => :'administrativeArea',
    :'region' => :'region',
    :'postal_code' => :'postalCode',
    :'country' => :'country',
    :'email' => :'email',
    :'phone_number' => :'phoneNumber'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_aggregator_information_sub_merchant.rb', line 68

def self.swagger_types
  {
    :'card_acceptor_id' => :'String',
    :'id' => :'String',
    :'name' => :'String',
    :'address1' => :'String',
    :'locality' => :'String',
    :'administrative_area' => :'String',
    :'region' => :'String',
    :'postal_code' => :'String',
    :'country' => :'String',
    :'email' => :'String',
    :'phone_number' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_aggregator_information_sub_merchant.rb', line 317

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      card_acceptor_id == o.card_acceptor_id &&
      id == o.id &&
      name == o.name &&
      address1 == o.address1 &&
      locality == o.locality &&
      administrative_area == o.administrative_area &&
      region == o.region &&
      postal_code == o.postal_code &&
      country == o.country &&
      email == o.email &&
      phone_number == o.phone_number
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



369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_aggregator_information_sub_merchant.rb', line 369

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



435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_aggregator_information_sub_merchant.rb', line 435

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



348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_aggregator_information_sub_merchant.rb', line 348

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


335
336
337
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_aggregator_information_sub_merchant.rb', line 335

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



341
342
343
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_aggregator_information_sub_merchant.rb', line 341

def hash
  [card_acceptor_id, id, name, address1, locality, administrative_area, region, postal_code, country, email, phone_number].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



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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_aggregator_information_sub_merchant.rb', line 139

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

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

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

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

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

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

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

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

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

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

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



415
416
417
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_aggregator_information_sub_merchant.rb', line 415

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



421
422
423
424
425
426
427
428
429
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_aggregator_information_sub_merchant.rb', line 421

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



409
410
411
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_aggregator_information_sub_merchant.rb', line 409

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



190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_aggregator_information_sub_merchant.rb', line 190

def valid?
  return false if !@card_acceptor_id.nil? && @card_acceptor_id.to_s.length > 15
  return false if !@id.nil? && @id.to_s.length > 20
  return false if !@name.nil? && @name.to_s.length > 37
  return false if !@address1.nil? && @address1.to_s.length > 38
  return false if !@locality.nil? && @locality.to_s.length > 21
  return false if !@administrative_area.nil? && @administrative_area.to_s.length > 3
  return false if !@region.nil? && @region.to_s.length > 3
  return false if !@postal_code.nil? && @postal_code.to_s.length > 15
  return false if !@country.nil? && @country.to_s.length > 3
  return false if !@email.nil? && @email.to_s.length > 40
  return false if !@phone_number.nil? && @phone_number.to_s.length > 20
  true
end