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



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
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
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information.rb', line 141

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?(:'domainName')
    self.domain_name = attributes[:'domainName']
  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?(:'cancelUrl')
    self.cancel_url = attributes[:'cancelUrl']
  end

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

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

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

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

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

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

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

Instance Attribute Details

#cancel_url ⇒ Object

customer would be redirected to this url based on the decision of the transaction



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

def cancel_url
  @cancel_url
end

#card_acceptor_reference_number ⇒ Object

Reference number that facilitates card acceptor/corporation communication and record keeping.



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

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. #### 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



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

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.



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

def category_code_domestic
  @category_code_domestic
end

#domain_name ⇒ Object

This field will contain either the merchant url or the reverse domain as per the requirement for DSRP Format 3. This might vary transaction to transaction and might not be static. Merchant needs to have access to send this value for all DSRP program.



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

def domain_name
  @domain_name
end

#failure_url ⇒ Object

customer would be redirected to this url based on the decision of the transaction



51
52
53
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information.rb', line 51

def failure_url
  @failure_url
end

#merchant_descriptor ⇒ Object

Returns the value of attribute merchant_descriptor.



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

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.



65
66
67
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information.rb', line 65

def merchant_name
  @merchant_name
end

#note_to_buyer ⇒ Object

Free-form text field.



62
63
64
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information.rb', line 62

def note_to_buyer
  @note_to_buyer
end

#partner_id_code ⇒ Object

#### Visa Platform Connect This field may be used for transactions on accounts issued under co-branding agreements when one of the co-branding partners.



57
58
59
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information.rb', line 57

def partner_id_code
  @partner_id_code
end

#return_url ⇒ Object

URL for displaying payment results to the consumer (notifications) after the transaction is processed. Usually this URL belongs to merchant and its behavior is defined by merchant



54
55
56
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information.rb', line 54

def return_url
  @return_url
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: Independent Sales Organization ID This field is supported for Visa, Mastercard and Discover Transactions. 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.



22
23
24
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information.rb', line 22

def sales_organization_id
  @sales_organization_id
end

#service_fee_descriptor ⇒ Object

Returns the value of attribute service_fee_descriptor.



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

def service_fee_descriptor
  @service_fee_descriptor
end

#service_location ⇒ Object

Returns the value of attribute service_location.



59
60
61
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information.rb', line 59

def service_location
  @service_location
end

#success_url ⇒ Object

customer would be redirected to this url based on the decision of the transaction



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

def success_url
  @success_url
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



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

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.



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

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.



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

def vat_registration_number
  @vat_registration_number
end

Class Method Details

.attribute_map ⇒ Object

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



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information.rb', line 68

def self.attribute_map
  {
    :'merchant_descriptor' => :'merchantDescriptor',
    :'domain_name' => :'domainName',
    :'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',
    :'cancel_url' => :'cancelUrl',
    :'success_url' => :'successUrl',
    :'failure_url' => :'failureUrl',
    :'return_url' => :'returnUrl',
    :'partner_id_code' => :'partnerIdCode',
    :'service_location' => :'serviceLocation',
    :'note_to_buyer' => :'noteToBuyer',
    :'merchant_name' => :'merchantName'
  }
end

.json_map ⇒ Object

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



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information.rb', line 92

def self.json_map
  {
    :'merchant_descriptor' => :'merchant_descriptor',
    :'domain_name' => :'domain_name',
    :'sales_organization_id' => :'sales_organization_id',
    :'category_code' => :'category_code',
    :'category_code_domestic' => :'category_code_domestic',
    :'tax_id' => :'tax_id',
    :'vat_registration_number' => :'vat_registration_number',
    :'card_acceptor_reference_number' => :'card_acceptor_reference_number',
    :'transaction_local_date_time' => :'transaction_local_date_time',
    :'service_fee_descriptor' => :'service_fee_descriptor',
    :'cancel_url' => :'cancel_url',
    :'success_url' => :'success_url',
    :'failure_url' => :'failure_url',
    :'return_url' => :'return_url',
    :'partner_id_code' => :'partner_id_code',
    :'service_location' => :'service_location',
    :'note_to_buyer' => :'note_to_buyer',
    :'merchant_name' => :'merchant_name'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information.rb', line 116

def self.swagger_types
  {
    :'merchant_descriptor' => :'Ptsv2paymentsMerchantInformationMerchantDescriptor',
    :'domain_name' => :'String',
    :'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',
    :'cancel_url' => :'String',
    :'success_url' => :'String',
    :'failure_url' => :'String',
    :'return_url' => :'String',
    :'partner_id_code' => :'String',
    :'service_location' => :'Ptsv2paymentsMerchantInformationServiceLocation',
    :'note_to_buyer' => :'String',
    :'merchant_name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information.rb', line 325

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      merchant_descriptor == o.merchant_descriptor &&
      domain_name == o.domain_name &&
      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 &&
      cancel_url == o.cancel_url &&
      success_url == o.success_url &&
      failure_url == o.failure_url &&
      return_url == o.return_url &&
      partner_id_code == o.partner_id_code &&
      service_location == o.service_location &&
      note_to_buyer == o.note_to_buyer &&
      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



384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information.rb', line 384

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



450
451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information.rb', line 450

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



363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information.rb', line 363

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("#{self.class.json_map[key]}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{self.class.json_map[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


350
351
352
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information.rb', line 350

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



356
357
358
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information.rb', line 356

def hash
  [merchant_descriptor, domain_name, sales_organization_id, category_code, category_code_domestic, tax_id, vat_registration_number, card_acceptor_reference_number, transaction_local_date_time, service_fee_descriptor, cancel_url, success_url, failure_url, return_url, partner_id_code, service_location, note_to_buyer, 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



222
223
224
225
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information.rb', line 222

def list_invalid_properties
  invalid_properties = Array.new
  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



430
431
432
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information.rb', line 430

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



436
437
438
439
440
441
442
443
444
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information.rb', line 436

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



424
425
426
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information.rb', line 424

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



229
230
231
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information.rb', line 229

def valid?
  true
end