Class: CyberSource::Ptsv2paymentsInstallmentInformation

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv2paymentsInstallmentInformation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
164
165
166
167
168
169
170
171
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_installment_information.rb', line 106

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amount ⇒ Object

Amount for the current installment payment. This field is supported only for CyberSource through VisaNet. For details, see ‘installment_amount` field description in the [Credit Card Services Using the SCMP API Guide.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)



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

def amount
  @amount
end

#eligibility_inquiry ⇒ Object

Indicates whether the authorization request is a Crediario eligibility inquiry. For details, see "Installment Payments on CyberSource through VisaNet" in the [Credit Card Services Using the SCMP API Guide.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) Set the value for this field to ‘Crediario`. This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet.



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

def eligibility_inquiry
  @eligibility_inquiry
end

#first_installment_amount ⇒ Object

Amount of the first installment payment. The issuer provides this value when the first installment payment is successful. This field is supported for Mastercard installment payments on CyberSource through VisaNet in all countries except Brazil,Croatia, Georgia, and Greece. The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR5 - Position: 23-34 - Field: Amount of Each Installment



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

def first_installment_amount
  @first_installment_amount
end

#first_installment_date ⇒ Object

Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a string of six zeros (000000) to the processor. For details, see "Installment Payments on CyberSource through VisaNet" in the [Credit Card Services Using the SCMP API Guide.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR9 - Position: 42-47 - Field: Date of First Installment



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

def first_installment_date
  @first_installment_date
end

#frequency ⇒ Object

Frequency of the installment payments. When you do not include this field in a request for a Crediario installment payment, CyberSource sends a space character to the processor. For details, see ‘installment_frequency` field description in the [Credit Card Services Using the SCMP API Guide](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for CyberSource through VisaNet. Possible values: - `B`: Biweekly - `M`: Monthly - `W`: Weekly For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR9 - Position: 41 - Field: Installment Frequency For details, see "Installment Payments" in the [Credit Card Services Using the SCMP API Guide](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)



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

def frequency
  @frequency
end

#grace_period_duration ⇒ Object

Grace period requested by the customer before the first installment payment is due. When you include this field in a request, you must also include the grace period duration type field. The value for this field corresponds to the following data in the TC 33 capture file3: Record: CP01 TCR5, Position: 100-101, Field: Mastercard Grace Period Details. This field is supported only for Mastercard installment payments in Brazil and Greece.



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

def grace_period_duration
  @grace_period_duration
end

#grace_period_duration_type ⇒ Object

Unit for the requested grace period duration. Possible values: - ‘D`: Days - `W`: Weeks - `M`: Months The value for this field corresponds to the following data in the TC 33 capture file3: Record: CP01 TCR5, Position: 99, Field: Mastercard Grace Period Details This field is supported only for Mastercard installment payments in Brazil and Greece on CyberSource through VisaNet.



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

def grace_period_duration_type
  @grace_period_duration_type
end

#identifier ⇒ Object

Standing Instruction/Installment identifier.



60
61
62
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_installment_information.rb', line 60

def identifier
  @identifier
end

#invoice_data ⇒ Object

Invoice information that you want to provide to the issuer. This value is similar to a tracking number and is the same for all installment payments for one purchase. This field is supported only for installment payments with Mastercard on CyberSource through VisaNet in Brazil. For details, see "Installment Payments on CyberSource through VisaNet" in the [Credit Card Services Using the SCMP API Guide.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR4 - Position: 51-70 - Field: Purchase Identification



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

def invoice_data
  @invoice_data
end

#payment_type ⇒ Object

Payment plan for the installments. Possible values: - 0 (default): Regular installment. This value is not allowed for airline transactions. - 1: Installment payment with down payment. - 2: Installment payment without down payment. This value is supported only for airline transactions. - 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions. - 4: Down payment only; regular installment payment will follow. - 5: Boarding fee only. This value is supported only for airline transactions. This field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil. For details, see "Installment Payments on CyberSource through VisaNet" in the [Credit Card Services Using the SCMP API Guide.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 9 - Field: Merchant Installment Supporting Information



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

def payment_type
  @payment_type
end

#plan_type ⇒ Object

#### American Express Direct, Cielo, and CyberSource Latin American Processing Flag that indicates the type of funding for the installment plan associated with the payment. Possible values: - ‘1`: Merchant-funded installment plan - `2`: Issuer-funded installment plan If you do not include this field in the request, CyberSource uses the value in your CyberSource account. To change the value in your CyberSource account, contact CyberSource Customer Service. For details, see `installment_plan_type` field description in the [Credit Card Services Using the SCMP API Guide](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### CyberSource through VisaNet and American Express Defined code that indicates the type of installment plan for this transaction. Contact American Express for: - Information about the kinds of installment plans that American Express provides - Values for this field For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 5-6 - Field: Plan Type * 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. #### CyberSource through VisaNet with Visa or Mastercard Flag indicating the type of funding for the installment plan associated with the payment. Possible values: - 1 or 01: Merchant-funded installment plan - 2 or 02: Issuer-funded installment plan - 43: Crediario installment plan—only with Visa in Brazil For details, see "Installment Payments on CyberSource through VisaNet" in the [Credit Card Services Using the SCMP API Guide](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 5-6 - Field: Installment Type For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR5 - Position: 39-40 - Field: Installment Plan Type (Issuer or Merchant)



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

def plan_type
  @plan_type
end

#sequence ⇒ Object

Installment number when making payments in installments. Used along with ‘totalCount` to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5. For details, see "Installment Payments" in the [Credit Card Services Using the SCMP API Guide](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. For details, see "Chase Paymentech Solutions Merchant Descriptors" and "FDC Compass Merchant Descriptors" in the [Merchant Descriptors Using the SCMP API] (apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### CyberSource through VisaNet When you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor. For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 38-40 - Field: Installment Payment Number * 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.



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

def sequence
  @sequence
end

#total_amount ⇒ Object

Total amount of the loan that is being paid in installments. This field is supported only for CyberSource through VisaNet. For details, see "Installment Payments" in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)



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

def total_amount
  @total_amount
end

#total_count ⇒ Object

Total number of installments when making payments in installments. For details, see "Installment Payments" in the [Credit Card Services Using the SCMP API Guide.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. For details, see "Chase Paymentech Solutions Merchant Descriptors" and "FDC Compass Merchant Descriptors" in the [Merchant Descriptors Using the SCMP API.] (apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### American Express Direct, Cielo, and Comercio Latino This value is the total number of installments you approved. #### CyberSource Latin American Processing in Brazil This value is the total number of installments that you approved. The default is 1. #### All Other Processors This value is used along with sequence to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as sequence = 2 and totalCount = 5. #### CyberSource through VisaNet For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 23-25 - Field: Number of Installments For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 7-8 - Field: Number of Installments For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR1 - Position: 7-8 - Field: Number of Installments For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR5 - Position: 20-22 - Field: Installment Total Count 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.



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

def total_count
  @total_count
end

#validation_indicator ⇒ Object

Standing Instruction/Installment validation indicator. - ‘1’: Prevalidated - ‘2’: Not Validated



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

def validation_indicator
  @validation_indicator
end

Class Method Details

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_installment_information.rb', line 63

def self.attribute_map
  {
    :'amount' => :'amount',
    :'frequency' => :'frequency',
    :'plan_type' => :'planType',
    :'sequence' => :'sequence',
    :'total_amount' => :'totalAmount',
    :'total_count' => :'totalCount',
    :'first_installment_date' => :'firstInstallmentDate',
    :'invoice_data' => :'invoiceData',
    :'payment_type' => :'paymentType',
    :'eligibility_inquiry' => :'eligibilityInquiry',
    :'grace_period_duration' => :'gracePeriodDuration',
    :'grace_period_duration_type' => :'gracePeriodDurationType',
    :'first_installment_amount' => :'firstInstallmentAmount',
    :'validation_indicator' => :'validationIndicator',
    :'identifier' => :'identifier'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_installment_information.rb', line 84

def self.swagger_types
  {
    :'amount' => :'String',
    :'frequency' => :'String',
    :'plan_type' => :'String',
    :'sequence' => :'Integer',
    :'total_amount' => :'String',
    :'total_count' => :'Integer',
    :'first_installment_date' => :'String',
    :'invoice_data' => :'String',
    :'payment_type' => :'String',
    :'eligibility_inquiry' => :'String',
    :'grace_period_duration' => :'String',
    :'grace_period_duration_type' => :'String',
    :'first_installment_amount' => :'String',
    :'validation_indicator' => :'String',
    :'identifier' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_installment_information.rb', line 278

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      amount == o.amount &&
      frequency == o.frequency &&
      plan_type == o.plan_type &&
      sequence == o.sequence &&
      total_amount == o.total_amount &&
      total_count == o.total_count &&
      first_installment_date == o.first_installment_date &&
      invoice_data == o.invoice_data &&
      payment_type == o.payment_type &&
      eligibility_inquiry == o.eligibility_inquiry &&
      grace_period_duration == o.grace_period_duration &&
      grace_period_duration_type == o.grace_period_duration_type &&
      first_installment_amount == o.first_installment_amount &&
      validation_indicator == o.validation_indicator &&
      identifier == o.identifier
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



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_installment_information.rb', line 334

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



400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_installment_information.rb', line 400

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



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_installment_information.rb', line 313

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


300
301
302
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_installment_information.rb', line 300

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



306
307
308
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_installment_information.rb', line 306

def hash
  [amount, frequency, plan_type, sequence, total_amount, total_count, first_installment_date, invoice_data, payment_type, eligibility_inquiry, grace_period_duration, grace_period_duration_type, first_installment_amount, validation_indicator, identifier].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



175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_installment_information.rb', line 175

def list_invalid_properties
  invalid_properties = Array.new
  if !@sequence.nil? && @sequence > 99
    invalid_properties.push('invalid value for "sequence", must be smaller than or equal to 99.')
  end

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



380
381
382
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_installment_information.rb', line 380

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



386
387
388
389
390
391
392
393
394
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_installment_information.rb', line 386

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



374
375
376
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_installment_information.rb', line 374

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

def valid?
  return false if !@sequence.nil? && @sequence > 99
  return false if !@total_count.nil? && @total_count > 99
  true
end