Class: CyberSource::Ptsv2paymentsidcapturesInstallmentInformation

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv2paymentsidcapturesInstallmentInformation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_installment_information.rb', line 187

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

  if attributes.has_key?(:'additionalCostsPercentage')
    self.additional_costs_percentage = attributes[:'additionalCostsPercentage']
  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?(:'insurance')
    self.insurance = attributes[:'insurance']
  end

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

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

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

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

Instance Attribute Details

#additional_costs ⇒ Object

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



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

def additional_costs
  @additional_costs
end

#additional_costs_percentage ⇒ Object

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



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

def additional_costs_percentage
  @additional_costs_percentage
end

#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/ptsv2paymentsidcaptures_installment_information.rb', line 18

def amount
  @amount
end

#amount_funded ⇒ Object

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



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

def amount_funded
  @amount_funded
end

#amount_requested_percentage ⇒ Object

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



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

def amount_requested_percentage
  @amount_requested_percentage
end

#annual_financing_cost ⇒ Object

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



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

def annual_financing_cost
  @annual_financing_cost
end

#annual_interest_rate ⇒ Object

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



63
64
65
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_installment_information.rb', line 63

def annual_interest_rate
  @annual_interest_rate
end

#expenses ⇒ Object

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



66
67
68
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_installment_information.rb', line 66

def expenses
  @expenses
end

#expenses_percentage ⇒ Object

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



69
70
71
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_installment_information.rb', line 69

def expenses_percentage
  @expenses_percentage
end

#fees ⇒ Object

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



72
73
74
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_installment_information.rb', line 72

def fees
  @fees
end

#fees_percentage ⇒ Object

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



75
76
77
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_installment_information.rb', line 75

def fees_percentage
  @fees_percentage
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



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

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/ptsv2paymentsidcaptures_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/ptsv2paymentsidcaptures_installment_information.rb', line 21

def frequency
  @frequency
end

#insurance ⇒ Object

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



78
79
80
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_installment_information.rb', line 78

def insurance
  @insurance
end

#insurance_percentage ⇒ Object

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



81
82
83
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_installment_information.rb', line 81

def insurance_percentage
  @insurance_percentage
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



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

def invoice_data
  @invoice_data
end

#monthly_interest_rate ⇒ Object

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



84
85
86
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_installment_information.rb', line 84

def monthly_interest_rate
  @monthly_interest_rate
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



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

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/ptsv2paymentsidcaptures_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/ptsv2paymentsidcaptures_installment_information.rb', line 27

def sequence
  @sequence
end

#taxes ⇒ Object

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



87
88
89
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_installment_information.rb', line 87

def taxes
  @taxes
end

#taxes_percentage ⇒ Object

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



90
91
92
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_installment_information.rb', line 90

def taxes_percentage
  @taxes_percentage
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/ptsv2paymentsidcaptures_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/ptsv2paymentsidcaptures_installment_information.rb', line 33

def total_count
  @total_count
end

Class Method Details

.attribute_map ⇒ Object

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



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_installment_information.rb', line 93

def self.attribute_map
  {
    :'amount' => :'amount',
    :'frequency' => :'frequency',
    :'plan_type' => :'planType',
    :'sequence' => :'sequence',
    :'total_amount' => :'totalAmount',
    :'total_count' => :'totalCount',
    :'first_installment_date' => :'firstInstallmentDate',
    :'first_installment_amount' => :'firstInstallmentAmount',
    :'invoice_data' => :'invoiceData',
    :'payment_type' => :'paymentType',
    :'additional_costs' => :'additionalCosts',
    :'additional_costs_percentage' => :'additionalCostsPercentage',
    :'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',
    :'insurance' => :'insurance',
    :'insurance_percentage' => :'insurancePercentage',
    :'monthly_interest_rate' => :'monthlyInterestRate',
    :'taxes' => :'taxes',
    :'taxes_percentage' => :'taxesPercentage'
  }
end

.json_map ⇒ Object

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



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

def self.json_map
  {
    :'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'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_installment_information.rb', line 155

def self.swagger_types
  {
    :'amount' => :'String',
    :'frequency' => :'String',
    :'plan_type' => :'String',
    :'sequence' => :'Integer',
    :'total_amount' => :'String',
    :'total_count' => :'Integer',
    :'first_installment_date' => :'String',
    :'first_installment_amount' => :'String',
    :'invoice_data' => :'String',
    :'payment_type' => :'String',
    :'additional_costs' => :'String',
    :'additional_costs_percentage' => :'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',
    :'insurance' => :'String',
    :'insurance_percentage' => :'String',
    :'monthly_interest_rate' => :'String',
    :'taxes' => :'String',
    :'taxes_percentage' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_installment_information.rb', line 459

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 &&
      first_installment_amount == o.first_installment_amount &&
      invoice_data == o.invoice_data &&
      payment_type == o.payment_type &&
      additional_costs == o.additional_costs &&
      additional_costs_percentage == o.additional_costs_percentage &&
      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 &&
      insurance == o.insurance &&
      insurance_percentage == o.insurance_percentage &&
      monthly_interest_rate == o.monthly_interest_rate &&
      taxes == o.taxes &&
      taxes_percentage == o.taxes_percentage
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



525
526
527
528
529
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
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_installment_information.rb', line 525

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



591
592
593
594
595
596
597
598
599
600
601
602
603
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_installment_information.rb', line 591

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



504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_installment_information.rb', line 504

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("#{self.class.json_map[key]}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{self.class.json_map[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


491
492
493
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_installment_information.rb', line 491

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



497
498
499
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_installment_information.rb', line 497

def hash
  [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].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



296
297
298
299
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_installment_information.rb', line 296

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



571
572
573
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_installment_information.rb', line 571

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



577
578
579
580
581
582
583
584
585
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_installment_information.rb', line 577

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



565
566
567
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_installment_information.rb', line 565

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



303
304
305
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_installment_information.rb', line 303

def valid?
  true
end