Class: CyberSource::Ptsv2creditsProcessingInformation

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv2creditsProcessingInformation

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/ptsv2credits_processing_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?(:'commerceIndicator')
    self.commerce_indicator = attributes[:'commerceIndicator']
  end

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#bank_transfer_options ⇒ Object

Returns the value of attribute bank_transfer_options.



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

def bank_transfer_options
  @bank_transfer_options
end

#commerce_indicator ⇒ Object

Type of transaction. Some payment card companies use this information when determining discount rates. When you omit this field for **Ingenico ePayments**, the processor uses the default transaction type they have on file for you instead of the default value listed here.



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

def commerce_indicator
  @commerce_indicator
end

#link_id ⇒ Object

Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments For details, see ‘link_to_request` field description in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)



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

def link_id
  @link_id
end

#payment_solution ⇒ Object

Type of digital payment solution for the transaction. Possible Values: - ‘visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see "Masterpass" in the [Credit Card Services Using the SCMP API Guide.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay.



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

def payment_solution
  @payment_solution
end

#processor_id ⇒ Object

Value that identifies the processor/acquirer to use for the transaction. This value is supported only for **CyberSource through VisaNet**. Contact CyberSource Customer Support to get the value for this field.



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

def processor_id
  @processor_id
end

#purchase_level ⇒ Object

Set this field to 3 to indicate that the request includes Level III data.



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

def purchase_level
  @purchase_level
end

#reconciliation_id ⇒ Object

Please check with Cybersource customer support to see if your merchant account is configured correctly so you can include this field in your request. * For Payouts: max length for FDCCompass is String (22).



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

def reconciliation_id
  @reconciliation_id
end

#recurring_options ⇒ Object

Returns the value of attribute recurring_options.



41
42
43
 
# File 'lib/cybersource_rest_client/models/ptsv2credits_processing_information.rb', line 41

def recurring_options
  @recurring_options
end

#report_group ⇒ Object

Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. For details, see ‘report_group` field description in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)



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

def report_group
  @report_group
end

#visa_checkout_id ⇒ Object

Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in the Visa Checkout callID field. For details, see the ‘vc_order_id` field description in [Visa Checkout Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)



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

def visa_checkout_id
  @visa_checkout_id
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/ptsv2credits_processing_information.rb', line 46

def self.attribute_map
  {
    :'commerce_indicator' => :'commerceIndicator',
    :'processor_id' => :'processorId',
    :'payment_solution' => :'paymentSolution',
    :'reconciliation_id' => :'reconciliationId',
    :'link_id' => :'linkId',
    :'report_group' => :'reportGroup',
    :'visa_checkout_id' => :'visaCheckoutId',
    :'purchase_level' => :'purchaseLevel',
    :'recurring_options' => :'recurringOptions',
    :'bank_transfer_options' => :'bankTransferOptions'
  }
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/ptsv2credits_processing_information.rb', line 62

def self.swagger_types
  {
    :'commerce_indicator' => :'String',
    :'processor_id' => :'String',
    :'payment_solution' => :'String',
    :'reconciliation_id' => :'String',
    :'link_id' => :'String',
    :'report_group' => :'String',
    :'visa_checkout_id' => :'String',
    :'purchase_level' => :'String',
    :'recurring_options' => :'Ptsv2paymentsidrefundsProcessingInformationRecurringOptions',
    :'bank_transfer_options' => :'Ptsv2creditsProcessingInformationBankTransferOptions'
  }
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/ptsv2credits_processing_information.rb', line 261

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      commerce_indicator == o.commerce_indicator &&
      processor_id == o.processor_id &&
      payment_solution == o.payment_solution &&
      reconciliation_id == o.reconciliation_id &&
      link_id == o.link_id &&
      report_group == o.report_group &&
      visa_checkout_id == o.visa_checkout_id &&
      purchase_level == o.purchase_level &&
      recurring_options == o.recurring_options &&
      bank_transfer_options == o.bank_transfer_options
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/ptsv2credits_processing_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/ptsv2credits_processing_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/ptsv2credits_processing_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/ptsv2credits_processing_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/ptsv2credits_processing_information.rb', line 284

def hash
  [commerce_indicator, processor_id, payment_solution, reconciliation_id, link_id, report_group, visa_checkout_id, purchase_level, recurring_options, bank_transfer_options].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/ptsv2credits_processing_information.rb', line 128

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

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

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

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

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

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

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

  if !@purchase_level.nil? && @purchase_level.to_s.length > 1
    invalid_properties.push('invalid value for "purchase_level", the character length must be smaller than or equal to 1.')
  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/ptsv2credits_processing_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/ptsv2credits_processing_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/ptsv2credits_processing_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/ptsv2credits_processing_information.rb', line 167

def valid?
  return false if !@commerce_indicator.nil? && @commerce_indicator.to_s.length > 20
  return false if !@processor_id.nil? && @processor_id.to_s.length > 3
  return false if !@payment_solution.nil? && @payment_solution.to_s.length > 12
  return false if !@reconciliation_id.nil? && @reconciliation_id.to_s.length > 60
  return false if !@link_id.nil? && @link_id.to_s.length > 26
  return false if !@report_group.nil? && @report_group.to_s.length > 25
  return false if !@visa_checkout_id.nil? && @visa_checkout_id.to_s.length > 48
  return false if !@purchase_level.nil? && @purchase_level.to_s.length > 1
  true
end