acceptance-api-sdk 0.0.1

data/lib/visa_acceptance_merged_spec/models/installment_information.rb

@@ -0,0 +1,490 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # InstallmentInformation Model.
+  class InstallmentInformation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Amount for the current installment payment.
+    # This field is supported only for Visa Acceptance through VisaNet.
+    # @return [String]
+    attr_accessor :amount
+
+    # Frequency of the installment payments. When you do not include this field
+    # in a request for a
+    # Crediario installment payment, Visa Acceptance sends a space character to
+    # the processor.
+    # This field is supported only for Visa Acceptance 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
+    # @return [String]
+    attr_accessor :frequency
+
+    # #### American Express Direct, Cielo, and Visa Acceptance 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, Visa Acceptance uses the
+    # value in your Visa Acceptance account.
+    # To change the value in your Visa Acceptance account, contact Visa
+    # Acceptance Customer Service.
+    # #### Visa Acceptance 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 Visa Acceptance. Visa Acceptance
+    # 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.
+    # #### Visa Acceptance 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)
+    # @return [String]
+    attr_accessor :plan_type
+
+    # 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 Visa Acceptance
+    # 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.
+    # #### Visa Acceptance through VisaNet
+    # When you do not include this field in a request for a Crediario
+    # installment payment, Visa Acceptance 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 Visa Acceptance. Visa Acceptance
+    # 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.
+    # @return [Integer]
+    attr_accessor :sequence
+
+    # Total amount of the loan that is being paid in installments. This field is
+    # supported only for Visa Acceptance
+    # through VisaNet.
+    # @return [String]
+    attr_accessor :total_amount
+
+    # 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.
+    # #### Visa Acceptance 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 Visa Acceptance
+    # as _sequence_ = 2 and _totalCount_ = 5.
+    # #### Visa Acceptance 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 Visa Acceptance. Visa Acceptance
+    # 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.
+    # @return [Integer]
+    attr_accessor :total_count
+
+    # Date of the first installment payment. Format: YYMMDD. When you do not
+    # include this field, Visa Acceptance sends a string of six zeros (000000)
+    # to the processor.
+    # This field is supported only for Crediario installment payments in Brazil
+    # on Visa Acceptance 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
+    # @return [String]
+    attr_accessor :first_installment_date
+
+    # 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
+    # Visa Acceptance 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
+    # @return [String]
+    attr_accessor :invoice_data
+
+    # 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.
+    # @return [String]
+    attr_accessor :payment_type
+
+    # Indicates whether the authorization request is a Crediario eligibility
+    # inquiry.
+    # Set the value for this field to `Crediario`.
+    # This field is supported only for Crediario installment payments in Brazil
+    # on Visa Acceptance through VisaNet.
+    # @return [String]
+    attr_accessor :eligibility_inquiry
+
+    # Grace period requested by the customer before the first installment
+    # payment is due.
+    # When you include this field in a request, you must also include the grace
+    # period duration type field.
+    # The value for this field corresponds to the following data in the TC 33
+    # capture file3: Record: CP01 TCR5, Position: 100-101, Field: Mastercard
+    # Grace Period Details.
+    # This field is supported only for Mastercard installment payments in Brazil
+    # and Greece.
+    # @return [String]
+    attr_accessor :grace_period_duration
+
+    # Unit for the requested grace period duration.
+    # Possible values:
+    # - `D`: Days
+    # - `W`: Weeks
+    # - `M`: Months
+    # The value for this field corresponds to the following data in the TC 33
+    # capture file3: Record: CP01 TCR5, Position: 99, Field: Mastercard Grace
+    # Period Details
+    # This field is supported only for Mastercard installment payments in Brazil
+    # and Greece on Visa Acceptance through VisaNet.
+    # @return [String]
+    attr_accessor :grace_period_duration_type
+
+    # 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 Visa
+    # Acceptance 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
+    # @return [String]
+    attr_accessor :first_installment_amount
+
+    # Standing Instruction/Installment validation indicator.
+    # - '1': Prevalidated
+    # - '2': Not Validated
+    # @return [String]
+    attr_accessor :validation_indicator
+
+    # Standing Instruction/Installment identifier.
+    # @return [String]
+    attr_accessor :identifier
+
+    # 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
+    # @return [String]
+    attr_accessor :annual_interest_rate
+
+    # Indicates if the installment plan has interest.
+    # Possible values:
+    # -Y - with interest
+    # -N - without interest
+    # -NULL - Do not send the field if no information available
+    # @return [String]
+    attr_accessor :interest_indicator
+
+    # Indicates if an installment plan is a government sponsored or part of a
+    # government program.
+    # Possible values:
+    # -true
+    # -false
+    # This field defaults to false when no value is provided.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_government_plan
+
+    # A mapping from model property names to API property names.
+    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['invoice_data'] = 'invoiceData'
+      @_hash['payment_type'] = 'paymentType'
+      @_hash['eligibility_inquiry'] = 'eligibilityInquiry'
+      @_hash['grace_period_duration'] = 'gracePeriodDuration'
+      @_hash['grace_period_duration_type'] = 'gracePeriodDurationType'
+      @_hash['first_installment_amount'] = 'firstInstallmentAmount'
+      @_hash['validation_indicator'] = 'validationIndicator'
+      @_hash['identifier'] = 'identifier'
+      @_hash['annual_interest_rate'] = 'annualInterestRate'
+      @_hash['interest_indicator'] = 'interestIndicator'
+      @_hash['is_government_plan'] = 'isGovernmentPlan'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        amount
+        frequency
+        plan_type
+        sequence
+        total_amount
+        total_count
+        first_installment_date
+        invoice_data
+        payment_type
+        eligibility_inquiry
+        grace_period_duration
+        grace_period_duration_type
+        first_installment_amount
+        validation_indicator
+        identifier
+        annual_interest_rate
+        interest_indicator
+        is_government_plan
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount: SKIP, frequency: SKIP, plan_type: SKIP,
+                   sequence: SKIP, total_amount: SKIP, total_count: SKIP,
+                   first_installment_date: SKIP, invoice_data: SKIP,
+                   payment_type: SKIP, eligibility_inquiry: SKIP,
+                   grace_period_duration: SKIP,
+                   grace_period_duration_type: SKIP,
+                   first_installment_amount: SKIP, validation_indicator: SKIP,
+                   identifier: SKIP, annual_interest_rate: SKIP,
+                   interest_indicator: SKIP, is_government_plan: 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
+      @invoice_data = invoice_data unless invoice_data == SKIP
+      @payment_type = payment_type unless payment_type == SKIP
+      @eligibility_inquiry = eligibility_inquiry unless eligibility_inquiry == SKIP
+      @grace_period_duration = grace_period_duration unless grace_period_duration == SKIP
+      unless grace_period_duration_type == SKIP
+        @grace_period_duration_type =
+          grace_period_duration_type
+      end
+      @first_installment_amount = first_installment_amount unless first_installment_amount == SKIP
+      @validation_indicator = validation_indicator unless validation_indicator == SKIP
+      @identifier = identifier unless identifier == SKIP
+      @annual_interest_rate = annual_interest_rate unless annual_interest_rate == SKIP
+      @interest_indicator = interest_indicator unless interest_indicator == SKIP
+      @is_government_plan = is_government_plan unless is_government_plan == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    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
+      invoice_data = hash.key?('invoiceData') ? hash['invoiceData'] : SKIP
+      payment_type = hash.key?('paymentType') ? hash['paymentType'] : SKIP
+      eligibility_inquiry =
+        hash.key?('eligibilityInquiry') ? hash['eligibilityInquiry'] : SKIP
+      grace_period_duration =
+        hash.key?('gracePeriodDuration') ? hash['gracePeriodDuration'] : SKIP
+      grace_period_duration_type =
+        hash.key?('gracePeriodDurationType') ? hash['gracePeriodDurationType'] : SKIP
+      first_installment_amount =
+        hash.key?('firstInstallmentAmount') ? hash['firstInstallmentAmount'] : SKIP
+      validation_indicator =
+        hash.key?('validationIndicator') ? hash['validationIndicator'] : SKIP
+      identifier = hash.key?('identifier') ? hash['identifier'] : SKIP
+      annual_interest_rate =
+        hash.key?('annualInterestRate') ? hash['annualInterestRate'] : SKIP
+      interest_indicator =
+        hash.key?('interestIndicator') ? hash['interestIndicator'] : SKIP
+      is_government_plan =
+        hash.key?('isGovernmentPlan') ? hash['isGovernmentPlan'] : 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.
+      InstallmentInformation.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,
+                                 invoice_data: invoice_data,
+                                 payment_type: payment_type,
+                                 eligibility_inquiry: eligibility_inquiry,
+                                 grace_period_duration: grace_period_duration,
+                                 grace_period_duration_type: grace_period_duration_type,
+                                 first_installment_amount: first_installment_amount,
+                                 validation_indicator: validation_indicator,
+                                 identifier: identifier,
+                                 annual_interest_rate: annual_interest_rate,
+                                 interest_indicator: interest_indicator,
+                                 is_government_plan: is_government_plan,
+                                 additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    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}, invoice_data: #{@invoice_data},"\
+      " payment_type: #{@payment_type}, eligibility_inquiry: #{@eligibility_inquiry},"\
+      " grace_period_duration: #{@grace_period_duration}, grace_period_duration_type:"\
+      " #{@grace_period_duration_type}, first_installment_amount: #{@first_installment_amount},"\
+      " validation_indicator: #{@validation_indicator}, identifier: #{@identifier},"\
+      " annual_interest_rate: #{@annual_interest_rate}, interest_indicator:"\
+      " #{@interest_indicator}, is_government_plan: #{@is_government_plan}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    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}, invoice_data: #{@invoice_data.inspect}, payment_type:"\
+      " #{@payment_type.inspect}, eligibility_inquiry: #{@eligibility_inquiry.inspect},"\
+      " grace_period_duration: #{@grace_period_duration.inspect}, grace_period_duration_type:"\
+      " #{@grace_period_duration_type.inspect}, first_installment_amount:"\
+      " #{@first_installment_amount.inspect}, validation_indicator:"\
+      " #{@validation_indicator.inspect}, identifier: #{@identifier.inspect},"\
+      " annual_interest_rate: #{@annual_interest_rate.inspect}, interest_indicator:"\
+      " #{@interest_indicator.inspect}, is_government_plan: #{@is_government_plan.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end