class CyberSource::PtsV2PaymentsPost201ResponseInstallmentInformation

Attributes

additional_costs[RW]

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. 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 file1: - Record: CP01 TCR9 - Position: 128-139 - Field: Total Other Costs

additional_costs_percentage[RW]

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. For details, see "Installment Payments on CyberSource through VisaNet" in [Credit Card Services Using the SCMP API.](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 file1: - Record: CP01 TCR9 - Position: 140-143 - Field: Percent of Total Other Costs

amount[RW]

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

amount_funded[RW]

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. For details, see "Installment Payments on CyberSource through VisaNet" in [Credit Card Services Using the SCMP API.](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 file1: - Record: CP01 TCR9 - Position: 48-59 - Field: Total Amount Funded

amount_requested_percentage[RW]

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. 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 file1: - Record: CP01 TCR9 - Position: 60-63 - Field: Percent of Amount Requested

annual_financing_cost[RW]

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. 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 file1: - Record: CP01 TCR9 - Position: 158-164 - Field: Annual Total Cost of Financing

annual_interest_rate[RW]

Annual 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. 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 file1: - Record: CP01 TCR9 - Position: 151-157 - Field: Annual Interest Rate

expenses[RW]

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. 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 file1: - Record: CP01 TCR9 - Position: 64-75 - Field: Total Expenses

expenses_percentage[RW]

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. 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 file1: - Record: CP01 TCR9 - Position: 76-79 - Field: Percent of Total Expenses

fees[RW]

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. 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 file1: - Record: CP01 TCR9 - Position: 80-91 - Field: Total Fees

fees_percentage[RW]

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. 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 file1: - Record: CP01 TCR9 - Position: 92-95 - Field: Percent of Total Fees

first_installment_amount[RW]

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

first_installment_date[RW]

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

frequency[RW]

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

insurance[RW]

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. 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 file1: - Record: CP01 TCR9 - Position: 112-123 - Field: Total Insurance

insurance_percentage[RW]

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. 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 file1: - Record: CP01 TCR9 - Position: 124-127 - Field: Percent Of Total Insurance

invoice_data[RW]

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

maximum_total_count[RW]

Maximum number of installments offered by the issuer for this purchase. The issuer provides this value when the first installment payment is successful. This field is supported for installment payments with Mastercard 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 file1: - Record: CP01 TCR5 - Position: 77-78 - Field: Mastercard Maximum Number Of Installments

minimum_total_count[RW]

"Minimum number of installments offered by the issuer for this purchase. The issuer provides this value when the first installment payment is successful. This field is supported for installment payments with Mastercard 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: 75-76 - Field: Mastercard Minimum Number Of Installments

monthly_interest_rate[RW]

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. 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 file1: - Record: CP01 TCR9 - Position: 144-150 - Field: Monthly Interest Rate

plan_type[RW]

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)

sequence[RW]

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.

taxes[RW]

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. 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 file1: - Record: CP01 TCR9 - Position: 96-107 - Field: Total Taxes

taxes_percentage[RW]

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. 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 file1: - Record: CP01 TCR9 - Position: 108-111 - Field: Percent of Total Taxes

total_amount[RW]

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

total_count[RW]

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.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_installment_information.rb, line 96
def self.attribute_map
  {
    :'additional_costs' => :'additionalCosts',
    :'additional_costs_percentage' => :'additionalCostsPercentage',
    :'amount' => :'amount',
    :'amount_funded' => :'amountFunded',
    :'amount_requested_percentage' => :'amountRequestedPercentage',
    :'annual_financing_cost' => :'annualFinancingCost',
    :'annual_interest_rate' => :'annualInterestRate',
    :'expenses' => :'expenses',
    :'expenses_percentage' => :'expensesPercentage',
    :'fees' => :'fees',
    :'fees_percentage' => :'feesPercentage',
    :'frequency' => :'frequency',
    :'insurance' => :'insurance',
    :'insurance_percentage' => :'insurancePercentage',
    :'invoice_data' => :'invoiceData',
    :'monthly_interest_rate' => :'monthlyInterestRate',
    :'plan_type' => :'planType',
    :'sequence' => :'sequence',
    :'taxes' => :'taxes',
    :'taxes_percentage' => :'taxesPercentage',
    :'total_amount' => :'totalAmount',
    :'total_count' => :'totalCount',
    :'minimum_total_count' => :'minimumTotalCount',
    :'maximum_total_count' => :'maximumTotalCount',
    :'first_installment_amount' => :'firstInstallmentAmount',
    :'first_installment_date' => :'firstInstallmentDate'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_installment_information.rb, line 161
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?(:'additionalCosts')
    self.additional_costs = attributes[:'additionalCosts']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'monthlyInterestRate')
    self.monthly_interest_rate = attributes[:'monthlyInterestRate']
  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?(:'taxes')
    self.taxes = attributes[:'taxes']
  end

  if attributes.has_key?(:'taxesPercentage')
    self.taxes_percentage = attributes[:'taxesPercentage']
  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?(:'minimumTotalCount')
    self.minimum_total_count = attributes[:'minimumTotalCount']
  end

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

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

  if attributes.has_key?(:'firstInstallmentDate')
    self.first_installment_date = attributes[:'firstInstallmentDate']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_installment_information.rb, line 128
def self.swagger_types
  {
    :'additional_costs' => :'String',
    :'additional_costs_percentage' => :'String',
    :'amount' => :'String',
    :'amount_funded' => :'String',
    :'amount_requested_percentage' => :'String',
    :'annual_financing_cost' => :'String',
    :'annual_interest_rate' => :'String',
    :'expenses' => :'String',
    :'expenses_percentage' => :'String',
    :'fees' => :'String',
    :'fees_percentage' => :'String',
    :'frequency' => :'String',
    :'insurance' => :'String',
    :'insurance_percentage' => :'String',
    :'invoice_data' => :'String',
    :'monthly_interest_rate' => :'String',
    :'plan_type' => :'String',
    :'sequence' => :'Integer',
    :'taxes' => :'String',
    :'taxes_percentage' => :'String',
    :'total_amount' => :'String',
    :'total_count' => :'Integer',
    :'minimum_total_count' => :'String',
    :'maximum_total_count' => :'String',
    :'first_installment_amount' => :'String',
    :'first_installment_date' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_installment_information.rb, line 449
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      additional_costs == o.additional_costs &&
      additional_costs_percentage == o.additional_costs_percentage &&
      amount == o.amount &&
      amount_funded == o.amount_funded &&
      amount_requested_percentage == o.amount_requested_percentage &&
      annual_financing_cost == o.annual_financing_cost &&
      annual_interest_rate == o.annual_interest_rate &&
      expenses == o.expenses &&
      expenses_percentage == o.expenses_percentage &&
      fees == o.fees &&
      fees_percentage == o.fees_percentage &&
      frequency == o.frequency &&
      insurance == o.insurance &&
      insurance_percentage == o.insurance_percentage &&
      invoice_data == o.invoice_data &&
      monthly_interest_rate == o.monthly_interest_rate &&
      plan_type == o.plan_type &&
      sequence == o.sequence &&
      taxes == o.taxes &&
      taxes_percentage == o.taxes_percentage &&
      total_amount == o.total_amount &&
      total_count == o.total_count &&
      minimum_total_count == o.minimum_total_count &&
      maximum_total_count == o.maximum_total_count &&
      first_installment_amount == o.first_installment_amount &&
      first_installment_date == o.first_installment_date
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_installment_information.rb, line 516
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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_installment_information.rb, line 582
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
additional_costs=(additional_costs) click to toggle source

Custom attribute writer method with validation @param [Object] additional_costs Value to be assigned

# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_installment_information.rb, line 297
def additional_costs=(additional_costs)
  @additional_costs = additional_costs
end
additional_costs_percentage=(additional_costs_percentage) click to toggle source

Custom attribute writer method with validation @param [Object] additional_costs_percentage Value to be assigned

# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_installment_information.rb, line 303
def additional_costs_percentage=(additional_costs_percentage)
  @additional_costs_percentage = additional_costs_percentage
end
amount=(amount) click to toggle source

Custom attribute writer method with validation @param [Object] amount Value to be assigned

# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_installment_information.rb, line 309
def amount=(amount)
  @amount = amount
end
amount_funded=(amount_funded) click to toggle source

Custom attribute writer method with validation @param [Object] amount_funded Value to be assigned

# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_installment_information.rb, line 315
def amount_funded=(amount_funded)
  @amount_funded = amount_funded
end
amount_requested_percentage=(amount_requested_percentage) click to toggle source

Custom attribute writer method with validation @param [Object] amount_requested_percentage Value to be assigned

# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_installment_information.rb, line 321
def amount_requested_percentage=(amount_requested_percentage)
  @amount_requested_percentage = amount_requested_percentage
end
annual_financing_cost=(annual_financing_cost) click to toggle source

Custom attribute writer method with validation @param [Object] annual_financing_cost Value to be assigned

# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_installment_information.rb, line 327
def annual_financing_cost=(annual_financing_cost)
  @annual_financing_cost = annual_financing_cost
end
annual_interest_rate=(annual_interest_rate) click to toggle source

Custom attribute writer method with validation @param [Object] annual_interest_rate Value to be assigned

# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_installment_information.rb, line 333
def annual_interest_rate=(annual_interest_rate)
  @annual_interest_rate = annual_interest_rate
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_installment_information.rb, line 495
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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_installment_information.rb, line 482
def eql?(o)
  self == o
end
expenses=(expenses) click to toggle source

Custom attribute writer method with validation @param [Object] expenses Value to be assigned

# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_installment_information.rb, line 339
def expenses=(expenses)
  @expenses = expenses
end
expenses_percentage=(expenses_percentage) click to toggle source

Custom attribute writer method with validation @param [Object] expenses_percentage Value to be assigned

# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_installment_information.rb, line 345
def expenses_percentage=(expenses_percentage)
  @expenses_percentage = expenses_percentage
end
fees=(fees) click to toggle source

Custom attribute writer method with validation @param [Object] fees Value to be assigned

# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_installment_information.rb, line 351
def fees=(fees)
  @fees = fees
end
fees_percentage=(fees_percentage) click to toggle source

Custom attribute writer method with validation @param [Object] fees_percentage Value to be assigned

# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_installment_information.rb, line 357
def fees_percentage=(fees_percentage)
  @fees_percentage = fees_percentage
end
first_installment_amount=(first_installment_amount) click to toggle source

Custom attribute writer method with validation @param [Object] first_installment_amount Value to be assigned

# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_installment_information.rb, line 437
def first_installment_amount=(first_installment_amount)
  @first_installment_amount = first_installment_amount
end
first_installment_date=(first_installment_date) click to toggle source

Custom attribute writer method with validation @param [Object] first_installment_date Value to be assigned

# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_installment_information.rb, line 443
def first_installment_date=(first_installment_date)
  @first_installment_date = first_installment_date
end
frequency=(frequency) click to toggle source

Custom attribute writer method with validation @param [Object] frequency Value to be assigned

# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_installment_information.rb, line 363
def frequency=(frequency)
  @frequency = frequency
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_installment_information.rb, line 488
def hash
  [additional_costs, additional_costs_percentage, amount, amount_funded, amount_requested_percentage, annual_financing_cost, annual_interest_rate, expenses, expenses_percentage, fees, fees_percentage, frequency, insurance, insurance_percentage, invoice_data, monthly_interest_rate, plan_type, sequence, taxes, taxes_percentage, total_amount, total_count, minimum_total_count, maximum_total_count, first_installment_amount, first_installment_date].hash
end
insurance=(insurance) click to toggle source

Custom attribute writer method with validation @param [Object] insurance Value to be assigned

# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_installment_information.rb, line 369
def insurance=(insurance)
  @insurance = insurance
end
insurance_percentage=(insurance_percentage) click to toggle source

Custom attribute writer method with validation @param [Object] insurance_percentage Value to be assigned

# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_installment_information.rb, line 375
def insurance_percentage=(insurance_percentage)
  @insurance_percentage = insurance_percentage
end
invoice_data=(invoice_data) click to toggle source

Custom attribute writer method with validation @param [Object] invoice_data Value to be assigned

# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_installment_information.rb, line 381
def invoice_data=(invoice_data)
  @invoice_data = invoice_data
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_installment_information.rb, line 274
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
monthly_interest_rate=(monthly_interest_rate) click to toggle source

Custom attribute writer method with validation @param [Object] monthly_interest_rate Value to be assigned

# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_installment_information.rb, line 387
def monthly_interest_rate=(monthly_interest_rate)
  @monthly_interest_rate = monthly_interest_rate
end
plan_type=(plan_type) click to toggle source

Custom attribute writer method with validation @param [Object] plan_type Value to be assigned

# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_installment_information.rb, line 393
def plan_type=(plan_type)
  @plan_type = plan_type
end
sequence=(sequence) click to toggle source

Custom attribute writer method with validation @param [Object] sequence Value to be assigned

# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_installment_information.rb, line 399
def sequence=(sequence)
  if !sequence.nil? && sequence > 99
    fail ArgumentError, 'invalid value for "sequence", must be smaller than or equal to 99.'
  end

  @sequence = sequence
end
taxes=(taxes) click to toggle source

Custom attribute writer method with validation @param [Object] taxes Value to be assigned

# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_installment_information.rb, line 409
def taxes=(taxes)
  @taxes = taxes
end
taxes_percentage=(taxes_percentage) click to toggle source

Custom attribute writer method with validation @param [Object] taxes_percentage Value to be assigned

# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_installment_information.rb, line 415
def taxes_percentage=(taxes_percentage)
  @taxes_percentage = taxes_percentage
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_installment_information.rb, line 562
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_installment_information.rb, line 568
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_installment_information.rb, line 556
def to_s
  to_hash.to_s
end
total_amount=(total_amount) click to toggle source

Custom attribute writer method with validation @param [Object] total_amount Value to be assigned

# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_installment_information.rb, line 421
def total_amount=(total_amount)
  @total_amount = total_amount
end
total_count=(total_count) click to toggle source

Custom attribute writer method with validation @param [Object] total_count Value to be assigned

# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_installment_information.rb, line 427
def total_count=(total_count)
  if !total_count.nil? && total_count > 99
    fail ArgumentError, 'invalid value for "total_count", must be smaller than or equal to 99.'
  end

  @total_count = total_count
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_installment_information.rb, line 289
def valid?
  return false if !@sequence.nil? && @sequence > 99
  return false if !@total_count.nil? && @total_count > 99
  true
end