Class: CyberSource::Ptsv2paymentsidrefundsProcessingInformation

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv2paymentsidrefundsProcessingInformation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidrefunds_processing_information.rb', line 65

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?(:'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
end

Instance Attribute Details

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)



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

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.



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

def payment_solution
  @payment_solution
end

#purchase_level ⇒ Object

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



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

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



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

def reconciliation_id
  @reconciliation_id
end

#recurring_options ⇒ Object

Returns the value of attribute recurring_options.



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

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)



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

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)



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

def visa_checkout_id
  @visa_checkout_id
end

Class Method Details

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidrefunds_processing_information.rb', line 38

def self.attribute_map
  {
    :'payment_solution' => :'paymentSolution',
    :'reconciliation_id' => :'reconciliationId',
    :'link_id' => :'linkId',
    :'report_group' => :'reportGroup',
    :'visa_checkout_id' => :'visaCheckoutId',
    :'purchase_level' => :'purchaseLevel',
    :'recurring_options' => :'recurringOptions'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidrefunds_processing_information.rb', line 51

def self.swagger_types
  {
    :'payment_solution' => :'String',
    :'reconciliation_id' => :'String',
    :'link_id' => :'String',
    :'report_group' => :'String',
    :'visa_checkout_id' => :'String',
    :'purchase_level' => :'String',
    :'recurring_options' => :'Ptsv2paymentsidrefundsProcessingInformationRecurringOptions'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidrefunds_processing_information.rb', line 205

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      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
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



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidrefunds_processing_information.rb', line 253

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



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

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



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidrefunds_processing_information.rb', line 232

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


219
220
221
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidrefunds_processing_information.rb', line 219

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [payment_solution, reconciliation_id, link_id, report_group, visa_checkout_id, purchase_level, recurring_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



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

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



299
300
301
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidrefunds_processing_information.rb', line 299

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



305
306
307
308
309
310
311
312
313
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidrefunds_processing_information.rb', line 305

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



293
294
295
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidrefunds_processing_information.rb', line 293

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



133
134
135
136
137
138
139
140
141
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidrefunds_processing_information.rb', line 133

def valid?
  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