visa-acceptance-api-sdk 1.0.0

data/lib/visa_acceptance_merged_spec/models/merchant_descriptor6.rb

@@ -0,0 +1,144 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # MerchantDescriptor6 Model.
+  class MerchantDescriptor6 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Merchant's postal code.
+    # #### PIN debit
+    # Postal code for your business location. This value might be displayed on
+    # the cardholder’s statement.
+    # If your business is domiciled in the U.S., you can use a 5-digit or
+    # 9-digit postal code. A 9-digit postal code must follow this format:
+    # [5 digits][dash][4 digits]
+    # Example: `12345-6789`
+    # If your business is domiciled in Canada, you can use a 6-digit or 9-digit
+    # postal code. A 6-digit postal code must follow this format:
+    # [alpha][numeric][alpha][space]
+    # [numeric][alpha][numeric]
+    # Example: `A1B 2C3`
+    # When you do not include this value in your PIN debit request, the merchant
+    # name from your account is used.
+    # **Important** This value must consist of English characters.
+    # **Note** This field is supported only for businesses located in the U.S.
+    # or Canada.
+    # **Important** Mastercard requires a postal code for any country that uses
+    # postal codes.
+    # You can provide the postal code in your account or you can include this
+    # field in your request.
+    # Optional field for PIN debit credit or PIN debit purchase.
+    # @return [String]
+    attr_accessor :postal_code
+
+    # Contact information for the merchant.
+    # **Note** These are the maximum data lengths for the following payment
+    # processors:
+    # - FDCCompass (13)
+    # - Paymentech (13)
+    # @return [String]
+    attr_accessor :contact
+
+    # Merchant's City.
+    # #### PIN debit
+    # City for your business location. This value might be displayed on the
+    # cardholder’s statement.
+    # When you do not include this value in your PIN debit request, the merchant
+    # name from your account is used.
+    # **Important** This value must consist of English characters.
+    # Optional field for PIN debit credit or PIN debit purchase requests.
+    # @return [String]
+    attr_accessor :locality
+
+    # Your merchant name.
+    # **Note** For Paymentech processor using Visa Acceptance Payouts, the
+    # maximum data length is 22.
+    # #### PIN debit
+    # Your business name. This name is displayed on the cardholder’s statement.
+    # When you
+    # include more than one consecutive space, extra spaces are removed.
+    # When you do not include this value in your PIN debit request, the merchant
+    # name from your account is used.
+    # **Important** This value must consist of English characters.
+    # Optional field for PIN debit credit or PIN debit purchase requests.
+    # #### Airline processing
+    # Your merchant name. This name is displayed on the cardholder’s statement.
+    # When you include more than one consecutive space, extra spaces are
+    # removed.
+    # **Note** Some airline fee programs may require the original ticket number
+    # (ticket identifier) or the ancillary service description in positions 13
+    # through 23 of this field.
+    # **Important** This value must consist of English characters.
+    # Required for captures and credits.
+    # @return [String]
+    attr_accessor :name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['postal_code'] = 'postalCode'
+      @_hash['contact'] = 'contact'
+      @_hash['locality'] = 'locality'
+      @_hash['name'] = 'name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        postal_code
+        contact
+        locality
+        name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(postal_code = SKIP, contact = SKIP, locality = SKIP,
+                   name = SKIP)
+      @postal_code = postal_code unless postal_code == SKIP
+      @contact = contact unless contact == SKIP
+      @locality = locality unless locality == SKIP
+      @name = name unless name == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      postal_code = hash.key?('postalCode') ? hash['postalCode'] : SKIP
+      contact = hash.key?('contact') ? hash['contact'] : SKIP
+      locality = hash.key?('locality') ? hash['locality'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+
+      # Create object from extracted values.
+      MerchantDescriptor6.new(postal_code,
+                              contact,
+                              locality,
+                              name)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} postal_code: #{@postal_code}, contact: #{@contact}, locality: #{@locality},"\
+      " name: #{@name}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} postal_code: #{@postal_code.inspect}, contact: #{@contact.inspect},"\
+      " locality: #{@locality.inspect}, name: #{@name.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/merchant_information.rb

@@ -0,0 +1,367 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # MerchantInformation Model.
+  class MerchantInformation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [MerchantDescriptor]
+    attr_accessor :merchant_descriptor
+
+    # This field will contain either the merchant url or the reverse domain as
+    # per the requirement for DSRP Format 3. This might vary transaction to
+    # transaction and might not be static. Merchant needs to have access to send
+    # this value for all DSRP program.
+    # @return [String]
+    attr_accessor :domain_name
+
+    # Company ID assigned to an independent sales organization. Get this value
+    # from Mastercard.
+    # #### Visa Acceptance through VisaNet
+    # The value for this field corresponds to the following data in the TC 33
+    # capture file:
+    # - Record: CP01 TCR6
+    # - Position: 106-116
+    # - Field: Independent Sales Organization ID
+    # This field is supported for Visa, Mastercard and Discover Transactions.
+    # **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 [String]
+    attr_accessor :sales_organization_id
+
+    # The value for this field is a four-digit number that the payment card
+    # industry uses to classify
+    # merchants into market segments. A payment card company assigned one or
+    # more of these values to your business when you started
+    # accepting the payment card company’s cards. When you do not include this
+    # field in your request, Visa Acceptance uses the value in your
+    # Visa Acceptance account.
+    # #### Visa Acceptance through VisaNet
+    # The value for this field corresponds to the following data in the TC 33
+    # capture file5:
+    # - Record: CP01 TCR4
+    # - Position: 150-153
+    # - Field: Merchant Category Code
+    # @return [Integer]
+    attr_accessor :category_code
+
+    # Merchant category code for domestic transactions. The value for this field
+    # is a four-digit number that the payment
+    # card industry uses to classify merchants into market segments. A payment
+    # card company assigned one or more of these
+    # values to your business when you started accepting the payment card
+    # company’s cards. Including this field in a request
+    # for a domestic transaction might reduce interchange fees.
+    # When you include this field in a request:
+    # - Do not include the `merchant_category_code` field.
+    # - The value for this field overrides the value in your Visa Acceptance
+    # account.
+    # This field is supported only for:
+    # - Domestic transactions with Mastercard in Spain. Domestic means that you
+    # and the cardholder are in the same country.
+    # - Merchants enrolled in the OmniPay Direct interchange program.
+    # - First Data Merchant Solutions (Europe) on OmniPay Direct.
+    # @return [Integer]
+    attr_accessor :category_code_domestic
+
+    # Your Cadastro Nacional da Pessoa Jurídica (CNPJ) number.
+    # This field is supported only for BNDES transactions on Visa Acceptance
+    # through VisaNet.
+    # The value for this field corresponds to the following data in the TC 33
+    # capture file5:
+    # - Record: CP07 TCR6
+    # - Position: 40-59
+    # - Field: BNDES Reference Field 1
+    # @return [String]
+    attr_accessor :tax_id
+
+    # Your government-assigned tax identification number.
+    # #### Tax Calculation
+    # Required field for value added tax only. Not applicable to U.S. and
+    # Canadian taxes.
+    # #### Visa Acceptance through VisaNet
+    # For CtV processors, the maximum length is 20.
+    # @return [String]
+    attr_accessor :vat_registration_number
+
+    # Reference number that facilitates card acceptor/corporation communication
+    # and record keeping.
+    # @return [String]
+    attr_accessor :card_acceptor_reference_number
+
+    # Date and time at your physical location.
+    # Format: `YYYYMMDDhhmmss`, where:
+    #  - `YYYY` = year
+    #  - `MM` = month
+    #  - `DD` = day
+    #  - `hh` = hour
+    #  - `mm` = minutes
+    #  - `ss` = seconds
+    # #### Used by
+    # **Authorization**
+    # Required for these processors:
+    # - American Express Direct
+    #
+    #
+    #
+    #                                       - American Express Direct
+    # - Credit Mutuel-CIC
+    # - FDC Nashville Global
+    # - SIX
+    # Optional for all other processors.
+    # @return [String]
+    attr_accessor :transaction_local_date_time
+
+    # Date and time at your physical location.
+    # Format: `YYYYMMDDhhmmss`, where:
+    #  - `YYYY` = year
+    #  - `MM` = month
+    #  - `DD` = day
+    #  - `hh` = hour
+    #  - `mm` = minutes
+    #  - `ss` = seconds
+    # #### Used by
+    # **Authorization**
+    # Required for these processors:
+    # - American Express Direct
+    #
+    #
+    #
+    #                                       - American Express Direct
+    # - Credit Mutuel-CIC
+    # - FDC Nashville Global
+    # - SIX
+    # Optional for all other processors.
+    # @return [ServiceFeeDescriptor]
+    attr_accessor :service_fee_descriptor
+
+    # customer would be redirected to this url based on the decision of the
+    # transaction
+    # @return [String]
+    attr_accessor :cancel_url
+
+    # customer would be redirected to this url based on the decision of the
+    # transaction
+    # @return [String]
+    attr_accessor :success_url
+
+    # customer would be redirected to this url based on the decision of the
+    # transaction
+    # @return [String]
+    attr_accessor :failure_url
+
+    # URL for displaying payment results to the consumer (notifications) after
+    # the transaction is processed. Usually this URL belongs to merchant and its
+    # behavior is defined by merchant
+    # @return [String]
+    attr_accessor :return_url
+
+    # #### Visa Platform Connect
+    # This field may be used for transactions on accounts issued under
+    # co-branding agreements when one of the
+    # co-branding partners.
+    # @return [String]
+    attr_accessor :partner_id_code
+
+    # #### Visa Platform Connect
+    # This field may be used for transactions on accounts issued under
+    # co-branding agreements when one of the
+    # co-branding partners.
+    # @return [ServiceLocation]
+    attr_accessor :service_location
+
+    # Free-form text field.
+    # @return [String]
+    attr_accessor :note_to_buyer
+
+    # Use this field only if you are requesting payment with Payer
+    # Authentication serice together.
+    # Your company’s name as you want it to appear to the customer in the
+    # issuing bank’s authentication form.
+    # This value overrides the value specified by your merchant bank.
+    # @return [String]
+    attr_accessor :merchant_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['merchant_descriptor'] = 'merchantDescriptor'
+      @_hash['domain_name'] = 'domainName'
+      @_hash['sales_organization_id'] = 'salesOrganizationId'
+      @_hash['category_code'] = 'categoryCode'
+      @_hash['category_code_domestic'] = 'categoryCodeDomestic'
+      @_hash['tax_id'] = 'taxId'
+      @_hash['vat_registration_number'] = 'vatRegistrationNumber'
+      @_hash['card_acceptor_reference_number'] = 'cardAcceptorReferenceNumber'
+      @_hash['transaction_local_date_time'] = 'transactionLocalDateTime'
+      @_hash['service_fee_descriptor'] = 'serviceFeeDescriptor'
+      @_hash['cancel_url'] = 'cancelUrl'
+      @_hash['success_url'] = 'successUrl'
+      @_hash['failure_url'] = 'failureUrl'
+      @_hash['return_url'] = 'returnUrl'
+      @_hash['partner_id_code'] = 'partnerIdCode'
+      @_hash['service_location'] = 'serviceLocation'
+      @_hash['note_to_buyer'] = 'noteToBuyer'
+      @_hash['merchant_name'] = 'merchantName'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        merchant_descriptor
+        domain_name
+        sales_organization_id
+        category_code
+        category_code_domestic
+        tax_id
+        vat_registration_number
+        card_acceptor_reference_number
+        transaction_local_date_time
+        service_fee_descriptor
+        cancel_url
+        success_url
+        failure_url
+        return_url
+        partner_id_code
+        service_location
+        note_to_buyer
+        merchant_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(merchant_descriptor = SKIP, domain_name = SKIP,
+                   sales_organization_id = SKIP, category_code = SKIP,
+                   category_code_domestic = SKIP, tax_id = SKIP,
+                   vat_registration_number = SKIP,
+                   card_acceptor_reference_number = SKIP,
+                   transaction_local_date_time = SKIP,
+                   service_fee_descriptor = SKIP, cancel_url = SKIP,
+                   success_url = SKIP, failure_url = SKIP, return_url = SKIP,
+                   partner_id_code = SKIP, service_location = SKIP,
+                   note_to_buyer = SKIP, merchant_name = SKIP)
+      @merchant_descriptor = merchant_descriptor unless merchant_descriptor == SKIP
+      @domain_name = domain_name unless domain_name == SKIP
+      @sales_organization_id = sales_organization_id unless sales_organization_id == SKIP
+      @category_code = category_code unless category_code == SKIP
+      @category_code_domestic = category_code_domestic unless category_code_domestic == SKIP
+      @tax_id = tax_id unless tax_id == SKIP
+      @vat_registration_number = vat_registration_number unless vat_registration_number == SKIP
+      unless card_acceptor_reference_number == SKIP
+        @card_acceptor_reference_number =
+          card_acceptor_reference_number
+      end
+      unless transaction_local_date_time == SKIP
+        @transaction_local_date_time =
+          transaction_local_date_time
+      end
+      @service_fee_descriptor = service_fee_descriptor unless service_fee_descriptor == SKIP
+      @cancel_url = cancel_url unless cancel_url == SKIP
+      @success_url = success_url unless success_url == SKIP
+      @failure_url = failure_url unless failure_url == SKIP
+      @return_url = return_url unless return_url == SKIP
+      @partner_id_code = partner_id_code unless partner_id_code == SKIP
+      @service_location = service_location unless service_location == SKIP
+      @note_to_buyer = note_to_buyer unless note_to_buyer == SKIP
+      @merchant_name = merchant_name unless merchant_name == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      merchant_descriptor = MerchantDescriptor.from_hash(hash['merchantDescriptor']) if
+        hash['merchantDescriptor']
+      domain_name = hash.key?('domainName') ? hash['domainName'] : SKIP
+      sales_organization_id =
+        hash.key?('salesOrganizationId') ? hash['salesOrganizationId'] : SKIP
+      category_code = hash.key?('categoryCode') ? hash['categoryCode'] : SKIP
+      category_code_domestic =
+        hash.key?('categoryCodeDomestic') ? hash['categoryCodeDomestic'] : SKIP
+      tax_id = hash.key?('taxId') ? hash['taxId'] : SKIP
+      vat_registration_number =
+        hash.key?('vatRegistrationNumber') ? hash['vatRegistrationNumber'] : SKIP
+      card_acceptor_reference_number =
+        hash.key?('cardAcceptorReferenceNumber') ? hash['cardAcceptorReferenceNumber'] : SKIP
+      transaction_local_date_time =
+        hash.key?('transactionLocalDateTime') ? hash['transactionLocalDateTime'] : SKIP
+      service_fee_descriptor = ServiceFeeDescriptor.from_hash(hash['serviceFeeDescriptor']) if
+        hash['serviceFeeDescriptor']
+      cancel_url = hash.key?('cancelUrl') ? hash['cancelUrl'] : SKIP
+      success_url = hash.key?('successUrl') ? hash['successUrl'] : SKIP
+      failure_url = hash.key?('failureUrl') ? hash['failureUrl'] : SKIP
+      return_url = hash.key?('returnUrl') ? hash['returnUrl'] : SKIP
+      partner_id_code =
+        hash.key?('partnerIdCode') ? hash['partnerIdCode'] : SKIP
+      service_location = ServiceLocation.from_hash(hash['serviceLocation']) if
+        hash['serviceLocation']
+      note_to_buyer = hash.key?('noteToBuyer') ? hash['noteToBuyer'] : SKIP
+      merchant_name = hash.key?('merchantName') ? hash['merchantName'] : SKIP
+
+      # Create object from extracted values.
+      MerchantInformation.new(merchant_descriptor,
+                              domain_name,
+                              sales_organization_id,
+                              category_code,
+                              category_code_domestic,
+                              tax_id,
+                              vat_registration_number,
+                              card_acceptor_reference_number,
+                              transaction_local_date_time,
+                              service_fee_descriptor,
+                              cancel_url,
+                              success_url,
+                              failure_url,
+                              return_url,
+                              partner_id_code,
+                              service_location,
+                              note_to_buyer,
+                              merchant_name)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} merchant_descriptor: #{@merchant_descriptor}, domain_name: #{@domain_name},"\
+      " sales_organization_id: #{@sales_organization_id}, category_code: #{@category_code},"\
+      " category_code_domestic: #{@category_code_domestic}, tax_id: #{@tax_id},"\
+      " vat_registration_number: #{@vat_registration_number}, card_acceptor_reference_number:"\
+      " #{@card_acceptor_reference_number}, transaction_local_date_time:"\
+      " #{@transaction_local_date_time}, service_fee_descriptor: #{@service_fee_descriptor},"\
+      " cancel_url: #{@cancel_url}, success_url: #{@success_url}, failure_url: #{@failure_url},"\
+      " return_url: #{@return_url}, partner_id_code: #{@partner_id_code}, service_location:"\
+      " #{@service_location}, note_to_buyer: #{@note_to_buyer}, merchant_name: #{@merchant_name}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} merchant_descriptor: #{@merchant_descriptor.inspect}, domain_name:"\
+      " #{@domain_name.inspect}, sales_organization_id: #{@sales_organization_id.inspect},"\
+      " category_code: #{@category_code.inspect}, category_code_domestic:"\
+      " #{@category_code_domestic.inspect}, tax_id: #{@tax_id.inspect}, vat_registration_number:"\
+      " #{@vat_registration_number.inspect}, card_acceptor_reference_number:"\
+      " #{@card_acceptor_reference_number.inspect}, transaction_local_date_time:"\
+      " #{@transaction_local_date_time.inspect}, service_fee_descriptor:"\
+      " #{@service_fee_descriptor.inspect}, cancel_url: #{@cancel_url.inspect}, success_url:"\
+      " #{@success_url.inspect}, failure_url: #{@failure_url.inspect}, return_url:"\
+      " #{@return_url.inspect}, partner_id_code: #{@partner_id_code.inspect}, service_location:"\
+      " #{@service_location.inspect}, note_to_buyer: #{@note_to_buyer.inspect}, merchant_name:"\
+      " #{@merchant_name.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/merchant_information1.rb

@@ -0,0 +1,94 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # MerchantInformation1 Model.
+  class MerchantInformation1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Use this field only if you are requesting payment with Payer
+    # Authentication serice together.
+    # Your company’s name as you want it to appear to the customer in the
+    # issuing bank’s authentication form.
+    # This value overrides the value specified by your merchant bank.
+    # @return [String]
+    attr_accessor :merchant_name
+
+    # Use this field only if you are requesting payment with Payer
+    # Authentication serice together.
+    # Your company’s name as you want it to appear to the customer in the
+    # issuing bank’s authentication form.
+    # This value overrides the value specified by your merchant bank.
+    # @return [MerchantDescriptor1]
+    attr_accessor :merchant_descriptor
+
+    # URL for displaying payment results to the consumer (notifications) after
+    # the transaction is processed. Usually this URL belongs to merchant and its
+    # behavior is defined by merchant
+    # @return [String]
+    attr_accessor :return_url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['merchant_name'] = 'merchantName'
+      @_hash['merchant_descriptor'] = 'merchantDescriptor'
+      @_hash['return_url'] = 'returnUrl'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        merchant_name
+        merchant_descriptor
+        return_url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(merchant_name = SKIP, merchant_descriptor = SKIP,
+                   return_url = SKIP)
+      @merchant_name = merchant_name unless merchant_name == SKIP
+      @merchant_descriptor = merchant_descriptor unless merchant_descriptor == SKIP
+      @return_url = return_url unless return_url == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      merchant_name = hash.key?('merchantName') ? hash['merchantName'] : SKIP
+      merchant_descriptor = MerchantDescriptor1.from_hash(hash['merchantDescriptor']) if
+        hash['merchantDescriptor']
+      return_url = hash.key?('returnUrl') ? hash['returnUrl'] : SKIP
+
+      # Create object from extracted values.
+      MerchantInformation1.new(merchant_name,
+                               merchant_descriptor,
+                               return_url)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} merchant_name: #{@merchant_name}, merchant_descriptor:"\
+      " #{@merchant_descriptor}, return_url: #{@return_url}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} merchant_name: #{@merchant_name.inspect}, merchant_descriptor:"\
+      " #{@merchant_descriptor.inspect}, return_url: #{@return_url.inspect}>"
+    end
+  end
+end