Class: CyberSourceMergedSpec::InstallmentInformation2

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/cyber_source_merged_spec/models/installment_information2.rb

Overview

InstallmentInformation2 Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(amount: SKIP, frequency: SKIP, plan_type: SKIP, sequence: SKIP, total_amount: SKIP, total_count: SKIP, first_installment_date: SKIP, first_installment_amount: SKIP, invoice_data: SKIP, payment_type: SKIP, additional_costs: SKIP, additional_costs_percentage: SKIP, amount_funded: SKIP, amount_requested_percentage: SKIP, annual_financing_cost: SKIP, annual_interest_rate: SKIP, expenses: SKIP, expenses_percentage: SKIP, fees: SKIP, fees_percentage: SKIP, insurance: SKIP, insurance_percentage: SKIP, monthly_interest_rate: SKIP, taxes: SKIP, taxes_percentage: SKIP, additional_properties: nil) ⇒ InstallmentInformation2

Returns a new instance of InstallmentInformation2.



530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
 
# File 'lib/cyber_source_merged_spec/models/installment_information2.rb', line 530

def initialize(amount: SKIP, frequency: SKIP, plan_type: SKIP,
               sequence: SKIP, total_amount: SKIP, total_count: SKIP,
               first_installment_date: SKIP, first_installment_amount: SKIP,
               invoice_data: SKIP, payment_type: SKIP,
               additional_costs: SKIP, additional_costs_percentage: SKIP,
               amount_funded: SKIP, amount_requested_percentage: SKIP,
               annual_financing_cost: SKIP, annual_interest_rate: SKIP,
               expenses: SKIP, expenses_percentage: SKIP, fees: SKIP,
               fees_percentage: SKIP, insurance: SKIP,
               insurance_percentage: SKIP, monthly_interest_rate: SKIP,
               taxes: SKIP, taxes_percentage: SKIP,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @amount = amount unless amount == SKIP
  @frequency = frequency unless frequency == SKIP
  @plan_type = plan_type unless plan_type == SKIP
  @sequence = sequence unless sequence == SKIP
  @total_amount = total_amount unless total_amount == SKIP
  @total_count = total_count unless total_count == SKIP
  @first_installment_date = first_installment_date unless first_installment_date == SKIP
  @first_installment_amount = first_installment_amount unless first_installment_amount == SKIP
  @invoice_data = invoice_data unless invoice_data == SKIP
  @payment_type = payment_type unless payment_type == SKIP
  @additional_costs = additional_costs unless additional_costs == SKIP
  unless additional_costs_percentage == SKIP
    @additional_costs_percentage =
      additional_costs_percentage
  end
  @amount_funded = amount_funded unless amount_funded == SKIP
  unless amount_requested_percentage == SKIP
    @amount_requested_percentage =
      amount_requested_percentage
  end
  @annual_financing_cost = annual_financing_cost unless annual_financing_cost == SKIP
  @annual_interest_rate = annual_interest_rate unless annual_interest_rate == SKIP
  @expenses = expenses unless expenses == SKIP
  @expenses_percentage = expenses_percentage unless expenses_percentage == SKIP
  @fees = fees unless fees == SKIP
  @fees_percentage = fees_percentage unless fees_percentage == SKIP
  @insurance = insurance unless insurance == SKIP
  @insurance_percentage = insurance_percentage unless insurance_percentage == SKIP
  @monthly_interest_rate = monthly_interest_rate unless monthly_interest_rate == SKIP
  @taxes = taxes unless taxes == SKIP
  @taxes_percentage = taxes_percentage unless taxes_percentage == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#additional_costs ⇒ String

Additional costs charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. 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 file1:

  • Record: CP01 TCR9
  • Position: 128-139
  • Field: Total Other Costs

Returns:

  • (String) 


234
235
236
 
# File 'lib/cyber_source_merged_spec/models/installment_information2.rb', line 234

def additional_costs
  @additional_costs
end

#additional_costs_percentage ⇒ String

Additional costs divided by the amount funded. For example:

  • A value of 1.0 specifies 1%.
  • A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. 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 file1:
  • Record: CP01 TCR9
  • Position: 140-143
  • Field: Percent of Total Other Costs

Returns:

  • (String) 


251
252
253
 
# File 'lib/cyber_source_merged_spec/models/installment_information2.rb', line 251

def additional_costs_percentage
  @additional_costs_percentage
end

#amount ⇒ String

Amount for the current installment payment. This field is supported only for CyberSource through VisaNet.

Returns:

  • (String) 


15
16
17
 
# File 'lib/cyber_source_merged_spec/models/installment_information2.rb', line 15

def amount
  @amount
end

#amount_funded ⇒ String

Amount funded. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. 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 file1:

  • Record: CP01 TCR9
  • Position: 48-59
  • Field: Total Amount Funded

Returns:

  • (String) 


265
266
267
 
# File 'lib/cyber_source_merged_spec/models/installment_information2.rb', line 265

def amount_funded
  @amount_funded
end

#amount_requested_percentage ⇒ String

Amount requested divided by the amount funded. For example:

  • A value of 90.0 specifies 90%.
  • A value of 93.7 specifies 93.7%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. 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 file1:
  • Record: CP01 TCR9
  • Position: 60-63
  • Field: Percent of Amount Requested

Returns:

  • (String) 


282
283
284
 
# File 'lib/cyber_source_merged_spec/models/installment_information2.rb', line 282

def amount_requested_percentage
  @amount_requested_percentage
end

#annual_financing_cost ⇒ String

Annual cost of financing the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. 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 file1:

  • Record: CP01 TCR9
  • Position: 158-164
  • Field: Annual Total Cost of Financing

Returns:

  • (String) 


296
297
298
 
# File 'lib/cyber_source_merged_spec/models/installment_information2.rb', line 296

def annual_financing_cost
  @annual_financing_cost
end

#annual_interest_rate ⇒ String

Annual interest rate. This field is returned only for two kinds of installment payments on Visa Platform Connect:

  • Crediario with Visa in Brazil: this field is included in the authorization response for the Crediario eligibility request when the issuer approves the customer's request for Crediario installment payments.
  • Mastercard in all countries except Brazil, Croatia, Georgia, and Greece. Example: A value of 1.0 specifies 1%. Example: A value of 4.0 specifies 4%.

Brazil

The value for this field corresponds to the following data in the TC 33 capture file:

  • Record: CP01 TCR9
  • Position: 151-157
  • Field: Annual Interest Rate

Other Countries

The value for this field corresponds to the following data in the TC 33 capture file:

  • Record: CP01 TCR5
  • Position: 58-62 SCMP API Fields| 216
  • Field: Mastercard Annual Percentage Rate

Returns:

  • (String) 


320
321
322
 
# File 'lib/cyber_source_merged_spec/models/installment_information2.rb', line 320

def annual_interest_rate
  @annual_interest_rate
end

#expenses ⇒ String

Expenses charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. 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 file1:

  • Record: CP01 TCR9
  • Position: 64-75
  • Field: Total Expenses

Returns:

  • (String) 


334
335
336
 
# File 'lib/cyber_source_merged_spec/models/installment_information2.rb', line 334

def expenses
  @expenses
end

#expenses_percentage ⇒ String

Expenses divided by the amount funded. For example:

  • A value of 1.0 specifies 1%.
  • A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. 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 file1:
  • Record: CP01 TCR9
  • Position: 76-79
  • Field: Percent of Total Expenses

Returns:

  • (String) 


351
352
353
 
# File 'lib/cyber_source_merged_spec/models/installment_information2.rb', line 351

def expenses_percentage
  @expenses_percentage
end

#fees ⇒ String

Fees charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. 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 file1:

  • Record: CP01 TCR9
  • Position: 80-91
  • Field: Total Fees

Returns:

  • (String) 


365
366
367
 
# File 'lib/cyber_source_merged_spec/models/installment_information2.rb', line 365

def fees
  @fees
end

#fees_percentage ⇒ String

Fees divided by the amount funded. For example:

  • A value of 1.0 specifies 1%.
  • A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. 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 file1:
  • Record: CP01 TCR9
  • Position: 92-95
  • Field: Percent of Total Fees

Returns:

  • (String) 


382
383
384
 
# File 'lib/cyber_source_merged_spec/models/installment_information2.rb', line 382

def fees_percentage
  @fees_percentage
end

#first_installment_amount ⇒ String

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

Returns:

  • (String) 


178
179
180
 
# File 'lib/cyber_source_merged_spec/models/installment_information2.rb', line 178

def first_installment_amount
  @first_installment_amount
end

#first_installment_date ⇒ String

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

Returns:

  • (String) 


165
166
167
 
# File 'lib/cyber_source_merged_spec/models/installment_information2.rb', line 165

def first_installment_date
  @first_installment_date
end

#frequency ⇒ String

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

Returns:

  • (String) 


32
33
34
 
# File 'lib/cyber_source_merged_spec/models/installment_information2.rb', line 32

def frequency
  @frequency
end

#insurance ⇒ String

Insurance charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. 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 file1:

  • Record: CP01 TCR9
  • Position: 112-123
  • Field: Total Insurance

Returns:

  • (String) 


396
397
398
 
# File 'lib/cyber_source_merged_spec/models/installment_information2.rb', line 396

def insurance
  @insurance
end

#insurance_percentage ⇒ String

Insurance costs divided by the amount funded. For example:

  • A value of 1.0 specifies 1%.
  • A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. 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 file1:
  • Record: CP01 TCR9
  • Position: 124-127
  • Field: Percent Of Total Insurance

Returns:

  • (String) 


413
414
415
 
# File 'lib/cyber_source_merged_spec/models/installment_information2.rb', line 413

def insurance_percentage
  @insurance_percentage
end

#invoice_data ⇒ String

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

Returns:

  • (String) 


191
192
193
 
# File 'lib/cyber_source_merged_spec/models/installment_information2.rb', line 191

def invoice_data
  @invoice_data
end

#monthly_interest_rate ⇒ String

Monthly interest rate. For example:

  • A value of 1.0 specifies 1%.
  • A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. 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 file1:
  • Record: CP01 TCR9
  • Position: 144-150
  • Field: Monthly Interest Rate

Returns:

  • (String) 


430
431
432
 
# File 'lib/cyber_source_merged_spec/models/installment_information2.rb', line 430

def monthly_interest_rate
  @monthly_interest_rate
end

#payment_type ⇒ String

Payment plan for the installments. This field is supported only for installment payments on Visa Platform Connect, RuPay and SPG-KSA seamless flow. Possible values for a standing-instruction (SI) merchant-initiated transaction (MIT) with Diners Club or Mastercard in India or with an India-issued card:

  • 1: SI with a fixed amount.
  • 2: SI with a maximum amount.
  • 3: Other kind of SI. Possible values for a type of Installment transaction for on-soil transaction in Kingdom of Saudi Arabia
  • 1: Registration or first transaction.
  • 2: Subsequent transaction. Possible values for other kinds of installment payments:
  • 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.
  • 6: SI de-registration on RuPay for the payer authentication seamless flow.

Returns:

  • (String) 


220
221
222
 
# File 'lib/cyber_source_merged_spec/models/installment_information2.rb', line 220

def payment_type
  @payment_type
end

#plan_type ⇒ String

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.

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

Returns:

  • (String) 


80
81
82
 
# File 'lib/cyber_source_merged_spec/models/installment_information2.rb', line 80

def plan_type
  @plan_type
end

#sequence ⇒ Integer

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.

Chase Paymentech Solutions and FDC Compass

This field is optional because this value is required in the merchant descriptors.

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.

Returns:

  • (Integer) 


103
104
105
 
# File 'lib/cyber_source_merged_spec/models/installment_information2.rb', line 103

def sequence
  @sequence
end

#taxes ⇒ String

Taxes collected by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. 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 file1:

  • Record: CP01 TCR9
  • Position: 96-107
  • Field: Total Taxes

Returns:

  • (String) 


444
445
446
 
# File 'lib/cyber_source_merged_spec/models/installment_information2.rb', line 444

def taxes
  @taxes
end

#taxes_percentage ⇒ String

Taxes divided by the amount funded. For example:

  • A value of 1.0 specifies 1%.
  • A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. 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 file1:
  • Record: CP01 TCR9
  • Position: 108-111
  • Field: Percent of Total Taxes

Returns:

  • (String) 


461
462
463
 
# File 'lib/cyber_source_merged_spec/models/installment_information2.rb', line 461

def taxes_percentage
  @taxes_percentage
end

#total_amount ⇒ String

Total amount of the loan that is being paid in installments. This field is supported only for CyberSource through VisaNet.

Returns:

  • (String) 


109
110
111
 
# File 'lib/cyber_source_merged_spec/models/installment_information2.rb', line 109

def total_amount
  @total_amount
end

#total_count ⇒ Integer

Total number of installments when making payments in installments.

Chase Paymentech Solutions and FDC Compass

This field is optional because this value is required in the merchant descriptors.

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.

Returns:

  • (Integer) 


152
153
154
 
# File 'lib/cyber_source_merged_spec/models/installment_information2.rb', line 152

def total_count
  @total_count
end

Class Method Details

.from_element(root) ⇒ Object 



658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
 
# File 'lib/cyber_source_merged_spec/models/installment_information2.rb', line 658

def self.from_element(root)
  amount = XmlUtilities.from_element(root, 'amount', String)
  frequency = XmlUtilities.from_element(root, 'frequency', String)
  plan_type = XmlUtilities.from_element(root, 'planType', String)
  sequence = XmlUtilities.from_element(root, 'sequence', Integer)
  total_amount = XmlUtilities.from_element(root, 'totalAmount', String)
  total_count = XmlUtilities.from_element(root, 'totalCount', Integer)
  first_installment_date = XmlUtilities.from_element(root,
                                                     'firstInstallmentDate',
                                                     String)
  first_installment_amount = XmlUtilities.from_element(
    root, 'firstInstallmentAmount', String
  )
  invoice_data = XmlUtilities.from_element(root, 'invoiceData', String)
  payment_type = XmlUtilities.from_element(root, 'paymentType', String)
  additional_costs = XmlUtilities.from_element(root, 'additionalCosts',
                                               String)
  additional_costs_percentage = XmlUtilities.from_element(
    root, 'additionalCostsPercentage', String
  )
  amount_funded = XmlUtilities.from_element(root, 'amountFunded', String)
  amount_requested_percentage = XmlUtilities.from_element(
    root, 'amountRequestedPercentage', String
  )
  annual_financing_cost = XmlUtilities.from_element(root,
                                                    'annualFinancingCost',
                                                    String)
  annual_interest_rate = XmlUtilities.from_element(root,
                                                   'annualInterestRate',
                                                   String)
  expenses = XmlUtilities.from_element(root, 'expenses', String)
  expenses_percentage = XmlUtilities.from_element(root,
                                                  'expensesPercentage',
                                                  String)
  fees = XmlUtilities.from_element(root, 'fees', String)
  fees_percentage = XmlUtilities.from_element(root, 'feesPercentage',
                                              String)
  insurance = XmlUtilities.from_element(root, 'insurance', String)
  insurance_percentage = XmlUtilities.from_element(root,
                                                   'insurancePercentage',
                                                   String)
  monthly_interest_rate = XmlUtilities.from_element(root,
                                                    'monthlyInterestRate',
                                                    String)
  taxes = XmlUtilities.from_element(root, 'taxes', String)
  taxes_percentage = XmlUtilities.from_element(root, 'taxesPercentage',
                                               String)

  new(amount: amount,
      frequency: frequency,
      plan_type: plan_type,
      sequence: sequence,
      total_amount: total_amount,
      total_count: total_count,
      first_installment_date: first_installment_date,
      first_installment_amount: first_installment_amount,
      invoice_data: invoice_data,
      payment_type: payment_type,
      additional_costs: additional_costs,
      additional_costs_percentage: additional_costs_percentage,
      amount_funded: amount_funded,
      amount_requested_percentage: amount_requested_percentage,
      annual_financing_cost: annual_financing_cost,
      annual_interest_rate: annual_interest_rate,
      expenses: expenses,
      expenses_percentage: expenses_percentage,
      fees: fees,
      fees_percentage: fees_percentage,
      insurance: insurance,
      insurance_percentage: insurance_percentage,
      monthly_interest_rate: monthly_interest_rate,
      taxes: taxes,
      taxes_percentage: taxes_percentage,
      additional_properties: additional_properties)
end

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
 
# File 'lib/cyber_source_merged_spec/models/installment_information2.rb', line 580

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  amount = hash.key?('amount') ? hash['amount'] : SKIP
  frequency = hash.key?('frequency') ? hash['frequency'] : SKIP
  plan_type = hash.key?('planType') ? hash['planType'] : SKIP
  sequence = hash.key?('sequence') ? hash['sequence'] : SKIP
  total_amount = hash.key?('totalAmount') ? hash['totalAmount'] : SKIP
  total_count = hash.key?('totalCount') ? hash['totalCount'] : SKIP
  first_installment_date =
    hash.key?('firstInstallmentDate') ? hash['firstInstallmentDate'] : SKIP
  first_installment_amount =
    hash.key?('firstInstallmentAmount') ? hash['firstInstallmentAmount'] : SKIP
  invoice_data = hash.key?('invoiceData') ? hash['invoiceData'] : SKIP
  payment_type = hash.key?('paymentType') ? hash['paymentType'] : SKIP
  additional_costs =
    hash.key?('additionalCosts') ? hash['additionalCosts'] : SKIP
  additional_costs_percentage =
    hash.key?('additionalCostsPercentage') ? hash['additionalCostsPercentage'] : SKIP
  amount_funded = hash.key?('amountFunded') ? hash['amountFunded'] : SKIP
  amount_requested_percentage =
    hash.key?('amountRequestedPercentage') ? hash['amountRequestedPercentage'] : SKIP
  annual_financing_cost =
    hash.key?('annualFinancingCost') ? hash['annualFinancingCost'] : SKIP
  annual_interest_rate =
    hash.key?('annualInterestRate') ? hash['annualInterestRate'] : SKIP
  expenses = hash.key?('expenses') ? hash['expenses'] : SKIP
  expenses_percentage =
    hash.key?('expensesPercentage') ? hash['expensesPercentage'] : SKIP
  fees = hash.key?('fees') ? hash['fees'] : SKIP
  fees_percentage =
    hash.key?('feesPercentage') ? hash['feesPercentage'] : SKIP
  insurance = hash.key?('insurance') ? hash['insurance'] : SKIP
  insurance_percentage =
    hash.key?('insurancePercentage') ? hash['insurancePercentage'] : SKIP
  monthly_interest_rate =
    hash.key?('monthlyInterestRate') ? hash['monthlyInterestRate'] : SKIP
  taxes = hash.key?('taxes') ? hash['taxes'] : SKIP
  taxes_percentage =
    hash.key?('taxesPercentage') ? hash['taxesPercentage'] : SKIP

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  InstallmentInformation2.new(amount: amount,
                              frequency: frequency,
                              plan_type: plan_type,
                              sequence: sequence,
                              total_amount: total_amount,
                              total_count: total_count,
                              first_installment_date: first_installment_date,
                              first_installment_amount: first_installment_amount,
                              invoice_data: invoice_data,
                              payment_type: payment_type,
                              additional_costs: additional_costs,
                              additional_costs_percentage: additional_costs_percentage,
                              amount_funded: amount_funded,
                              amount_requested_percentage: amount_requested_percentage,
                              annual_financing_cost: annual_financing_cost,
                              annual_interest_rate: annual_interest_rate,
                              expenses: expenses,
                              expenses_percentage: expenses_percentage,
                              fees: fees,
                              fees_percentage: fees_percentage,
                              insurance: insurance,
                              insurance_percentage: insurance_percentage,
                              monthly_interest_rate: monthly_interest_rate,
                              taxes: taxes,
                              taxes_percentage: taxes_percentage,
                              additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
 
# File 'lib/cyber_source_merged_spec/models/installment_information2.rb', line 464

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['amount'] = 'amount'
  @_hash['frequency'] = 'frequency'
  @_hash['plan_type'] = 'planType'
  @_hash['sequence'] = 'sequence'
  @_hash['total_amount'] = 'totalAmount'
  @_hash['total_count'] = 'totalCount'
  @_hash['first_installment_date'] = 'firstInstallmentDate'
  @_hash['first_installment_amount'] = 'firstInstallmentAmount'
  @_hash['invoice_data'] = 'invoiceData'
  @_hash['payment_type'] = 'paymentType'
  @_hash['additional_costs'] = 'additionalCosts'
  @_hash['additional_costs_percentage'] = 'additionalCostsPercentage'
  @_hash['amount_funded'] = 'amountFunded'
  @_hash['amount_requested_percentage'] = 'amountRequestedPercentage'
  @_hash['annual_financing_cost'] = 'annualFinancingCost'
  @_hash['annual_interest_rate'] = 'annualInterestRate'
  @_hash['expenses'] = 'expenses'
  @_hash['expenses_percentage'] = 'expensesPercentage'
  @_hash['fees'] = 'fees'
  @_hash['fees_percentage'] = 'feesPercentage'
  @_hash['insurance'] = 'insurance'
  @_hash['insurance_percentage'] = 'insurancePercentage'
  @_hash['monthly_interest_rate'] = 'monthlyInterestRate'
  @_hash['taxes'] = 'taxes'
  @_hash['taxes_percentage'] = 'taxesPercentage'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



526
527
528
 
# File 'lib/cyber_source_merged_spec/models/installment_information2.rb', line 526

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
 
# File 'lib/cyber_source_merged_spec/models/installment_information2.rb', line 495

def self.optionals
  %w[
    amount
    frequency
    plan_type
    sequence
    total_amount
    total_count
    first_installment_date
    first_installment_amount
    invoice_data
    payment_type
    additional_costs
    additional_costs_percentage
    amount_funded
    amount_requested_percentage
    annual_financing_cost
    annual_interest_rate
    expenses
    expenses_percentage
    fees
    fees_percentage
    insurance
    insurance_percentage
    monthly_interest_rate
    taxes
    taxes_percentage
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
 
# File 'lib/cyber_source_merged_spec/models/installment_information2.rb', line 799

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} amount: #{@amount.inspect}, frequency: #{@frequency.inspect}, plan_type:"\
  " #{@plan_type.inspect}, sequence: #{@sequence.inspect}, total_amount:"\
  " #{@total_amount.inspect}, total_count: #{@total_count.inspect}, first_installment_date:"\
  " #{@first_installment_date.inspect}, first_installment_amount:"\
  " #{@first_installment_amount.inspect}, invoice_data: #{@invoice_data.inspect},"\
  " payment_type: #{@payment_type.inspect}, additional_costs: #{@additional_costs.inspect},"\
  " additional_costs_percentage: #{@additional_costs_percentage.inspect}, amount_funded:"\
  " #{@amount_funded.inspect}, amount_requested_percentage:"\
  " #{@amount_requested_percentage.inspect}, annual_financing_cost:"\
  " #{@annual_financing_cost.inspect}, annual_interest_rate: #{@annual_interest_rate.inspect},"\
  " expenses: #{@expenses.inspect}, expenses_percentage: #{@expenses_percentage.inspect},"\
  " fees: #{@fees.inspect}, fees_percentage: #{@fees_percentage.inspect}, insurance:"\
  " #{@insurance.inspect}, insurance_percentage: #{@insurance_percentage.inspect},"\
  " monthly_interest_rate: #{@monthly_interest_rate.inspect}, taxes: #{@taxes.inspect},"\
  " taxes_percentage: #{@taxes_percentage.inspect}, additional_properties:"\
  " #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
 
# File 'lib/cyber_source_merged_spec/models/installment_information2.rb', line 781

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} amount: #{@amount}, frequency: #{@frequency}, plan_type: #{@plan_type},"\
  " sequence: #{@sequence}, total_amount: #{@total_amount}, total_count: #{@total_count},"\
  " first_installment_date: #{@first_installment_date}, first_installment_amount:"\
  " #{@first_installment_amount}, invoice_data: #{@invoice_data}, payment_type:"\
  " #{@payment_type}, additional_costs: #{@additional_costs}, additional_costs_percentage:"\
  " #{@additional_costs_percentage}, amount_funded: #{@amount_funded},"\
  " amount_requested_percentage: #{@amount_requested_percentage}, annual_financing_cost:"\
  " #{@annual_financing_cost}, annual_interest_rate: #{@annual_interest_rate}, expenses:"\
  " #{@expenses}, expenses_percentage: #{@expenses_percentage}, fees: #{@fees},"\
  " fees_percentage: #{@fees_percentage}, insurance: #{@insurance}, insurance_percentage:"\
  " #{@insurance_percentage}, monthly_interest_rate: #{@monthly_interest_rate}, taxes:"\
  " #{@taxes}, taxes_percentage: #{@taxes_percentage}, additional_properties:"\
  " #{@additional_properties}>"
end

#to_xml_element(doc, root_name) ⇒ Object 



734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
 
# File 'lib/cyber_source_merged_spec/models/installment_information2.rb', line 734

def to_xml_element(doc, root_name)
  root = doc.create_element(root_name)

  XmlUtilities.add_as_subelement(doc, root, 'amount', amount)
  XmlUtilities.add_as_subelement(doc, root, 'frequency', frequency)
  XmlUtilities.add_as_subelement(doc, root, 'planType', plan_type)
  XmlUtilities.add_as_subelement(doc, root, 'sequence', sequence)
  XmlUtilities.add_as_subelement(doc, root, 'totalAmount', total_amount)
  XmlUtilities.add_as_subelement(doc, root, 'totalCount', total_count)
  XmlUtilities.add_as_subelement(doc, root, 'firstInstallmentDate',
                                 first_installment_date)
  XmlUtilities.add_as_subelement(doc, root, 'firstInstallmentAmount',
                                 first_installment_amount)
  XmlUtilities.add_as_subelement(doc, root, 'invoiceData', invoice_data)
  XmlUtilities.add_as_subelement(doc, root, 'paymentType', payment_type)
  XmlUtilities.add_as_subelement(doc, root, 'additionalCosts',
                                 additional_costs)
  XmlUtilities.add_as_subelement(doc, root, 'additionalCostsPercentage',
                                 additional_costs_percentage)
  XmlUtilities.add_as_subelement(doc, root, 'amountFunded', amount_funded)
  XmlUtilities.add_as_subelement(doc, root, 'amountRequestedPercentage',
                                 amount_requested_percentage)
  XmlUtilities.add_as_subelement(doc, root, 'annualFinancingCost',
                                 annual_financing_cost)
  XmlUtilities.add_as_subelement(doc, root, 'annualInterestRate',
                                 annual_interest_rate)
  XmlUtilities.add_as_subelement(doc, root, 'expenses', expenses)
  XmlUtilities.add_as_subelement(doc, root, 'expensesPercentage',
                                 expenses_percentage)
  XmlUtilities.add_as_subelement(doc, root, 'fees', fees)
  XmlUtilities.add_as_subelement(doc, root, 'feesPercentage',
                                 fees_percentage)
  XmlUtilities.add_as_subelement(doc, root, 'insurance', insurance)
  XmlUtilities.add_as_subelement(doc, root, 'insurancePercentage',
                                 insurance_percentage)
  XmlUtilities.add_as_subelement(doc, root, 'monthlyInterestRate',
                                 monthly_interest_rate)
  XmlUtilities.add_as_subelement(doc, root, 'taxes', taxes)
  XmlUtilities.add_as_subelement(doc, root, 'taxesPercentage',
                                 taxes_percentage)
  XmlUtilities.add_as_subelement(doc, root, 'additional_properties',
                                 additional_properties)

  root
end