visa-acceptance-api-sdk 1.0.0

data/lib/visa_acceptance_merged_spec/models/processor_information24.rb

@@ -0,0 +1,511 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # ProcessorInformation24 Model.
+  class ProcessorInformation24 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Processor]
+    attr_accessor :processor
+
+    # An array of object that contains the list of acquirer response codes &
+    # reasons if a transaction is routed to multiple acquirers.
+    # @return [Array[MultiProcessorRouting]]
+    attr_accessor :multi_processor_routing
+
+    # Network transaction identifier (TID). You can use this value to identify a
+    # specific transaction when you are
+    # discussing the transaction with your processor. Not all processors provide
+    # this value.
+    # Returned by the authorization service.
+    # #### PIN debit
+    # Transaction identifier generated by the processor.
+    # Returned by PIN debit credit.
+    # #### GPX
+    # Processor transaction ID.
+    # #### Cielo
+    # For Cielo, this value is the non-sequential unit (NSU) and is supported
+    # for all transactions. The value is generated by Cielo or the issuing bank.
+    # #### Comercio Latino
+    # For Comercio Latino, this value is the proof of sale or non-sequential
+    # unit (NSU) number generated by the acquirers Cielo and Rede, or the
+    # issuing bank.
+    # #### Visa Acceptance through VisaNet and GPN
+    # For details about this value for Visa Acceptance through VisaNet and GPN,
+    # see "processorInformation.networkTransactionId" in [REST API Fields](
+    # #### Moneris
+    # This value identifies the transaction on a host system. It contains the
+    # following information:
+    # - Terminal used to process the transaction
+    # - Shift during which the transaction took place
+    # - Batch number
+    # - Transaction number within the batch
+    # You must store this value. If you give the customer a receipt, display
+    # this value on the receipt.
+    # **Example** For the value
+    # 66012345001069003:
+    # - Terminal ID = 66012345
+    # - Shift number = 001
+    # - Batch number = 069
+    # - Transaction number = 003
+    # @return [String]
+    attr_accessor :transaction_id
+
+    # Same value as `processorInformation.transactionId`
+    # @return [String]
+    attr_accessor :network_transaction_id
+
+    # #### Ingenico ePayments
+    # Unique number that Visa Acceptance generates to identify the transaction.
+    # You can use this value to identify transactions in the Ingenico ePayments
+    # Collections Report, which provides settlement information. Contact
+    # customer support for information about the report.
+    # ### Visa Acceptance through VisaNet
+    # Retrieval request number.
+    # @return [String]
+    attr_accessor :retrieval_reference_number
+
+    # Response ID sent from the processor.
+    # @return [String]
+    attr_accessor :response_id
+
+    # Authorization code. Returned only when the processor returns this value.
+    # The length of this value depends on your processor.
+    # Returned by authorization service.
+    # #### PIN debit
+    # Authorization code that is returned by the processor.
+    # Returned by PIN debit credit.
+    # #### Elavon Encrypted Account Number Program
+    # The returned value is OFFLINE.
+    # #### TSYS Acquiring Solutions
+    # The returned value for a successful zero amount authorization is 000000.
+    # @return [String]
+    attr_accessor :approval_code
+
+    # For most processors, this is the error message sent directly from the
+    # bank. Returned only when the processor
+    # returns this value.
+    # **Important** Do not use this field to evaluate the result of the
+    # authorization.
+    # #### PIN debit
+    # Response value that is returned by the processor or bank.
+    # **Important** Do not use this field to evaluate the results of the
+    # transaction request.
+    # Returned by PIN debit credit, PIN debit purchase, and PIN debit reversal.
+    # #### AIBMS
+    # If this value is `08`, you can accept the transaction if the customer
+    # provides you with identification.
+    # #### Atos
+    # This value is the response code sent from Atos and it might also include
+    # the response code from the bank.
+    # Format: `aa,bb` with the two values separated by a comma and where:
+    # - `aa` is the two-digit error message from Atos.
+    # - `bb` is the optional two-digit error message from the bank.
+    # #### Comercio Latino
+    # This value is the status code and the error or response code received from
+    # the processor separated by a colon.
+    # Format: [status code]:E[error code] or [status code]:R[response code]
+    # Example `2:R06`
+    # #### JCN Gateway
+    # Processor-defined detail error code. The associated response category code
+    # is in the `processorInformation.responseCategoryCode` field.
+    # String (3)
+    # #### paypalgateway
+    # Processor generated ID for the itemized detail.
+    # @return [String]
+    attr_accessor :response_code
+
+    # For most processors, this is the error message sent directly from the
+    # bank. Returned only when the processor
+    # returns this value.
+    # **Important** Do not use this field to evaluate the result of the
+    # authorization.
+    # #### PIN debit
+    # Response value that is returned by the processor or bank.
+    # **Important** Do not use this field to evaluate the results of the
+    # transaction request.
+    # Returned by PIN debit credit, PIN debit purchase, and PIN debit reversal.
+    # #### AIBMS
+    # If this value is `08`, you can accept the transaction if the customer
+    # provides you with identification.
+    # #### Atos
+    # This value is the response code sent from Atos and it might also include
+    # the response code from the bank.
+    # Format: `aa,bb` with the two values separated by a comma and where:
+    # - `aa` is the two-digit error message from Atos.
+    # - `bb` is the optional two-digit error message from the bank.
+    # #### Comercio Latino
+    # This value is the status code and the error or response code received from
+    # the processor separated by a colon.
+    # Format: [status code]:E[error code] or [status code]:R[response code]
+    # Example `2:R06`
+    # #### JCN Gateway
+    # Processor-defined detail error code. The associated response category code
+    # is in the `processorInformation.responseCategoryCode` field.
+    # String (3)
+    # #### paypalgateway
+    # Processor generated ID for the itemized detail.
+    # @return [Avs]
+    attr_accessor :avs
+
+    # For most processors, this is the error message sent directly from the
+    # bank. Returned only when the processor
+    # returns this value.
+    # **Important** Do not use this field to evaluate the result of the
+    # authorization.
+    # #### PIN debit
+    # Response value that is returned by the processor or bank.
+    # **Important** Do not use this field to evaluate the results of the
+    # transaction request.
+    # Returned by PIN debit credit, PIN debit purchase, and PIN debit reversal.
+    # #### AIBMS
+    # If this value is `08`, you can accept the transaction if the customer
+    # provides you with identification.
+    # #### Atos
+    # This value is the response code sent from Atos and it might also include
+    # the response code from the bank.
+    # Format: `aa,bb` with the two values separated by a comma and where:
+    # - `aa` is the two-digit error message from Atos.
+    # - `bb` is the optional two-digit error message from the bank.
+    # #### Comercio Latino
+    # This value is the status code and the error or response code received from
+    # the processor separated by a colon.
+    # Format: [status code]:E[error code] or [status code]:R[response code]
+    # Example `2:R06`
+    # #### JCN Gateway
+    # Processor-defined detail error code. The associated response category code
+    # is in the `processorInformation.responseCategoryCode` field.
+    # String (3)
+    # #### paypalgateway
+    # Processor generated ID for the itemized detail.
+    # @return [CardVerification1]
+    attr_accessor :card_verification
+
+    # For most processors, this is the error message sent directly from the
+    # bank. Returned only when the processor
+    # returns this value.
+    # **Important** Do not use this field to evaluate the result of the
+    # authorization.
+    # #### PIN debit
+    # Response value that is returned by the processor or bank.
+    # **Important** Do not use this field to evaluate the results of the
+    # transaction request.
+    # Returned by PIN debit credit, PIN debit purchase, and PIN debit reversal.
+    # #### AIBMS
+    # If this value is `08`, you can accept the transaction if the customer
+    # provides you with identification.
+    # #### Atos
+    # This value is the response code sent from Atos and it might also include
+    # the response code from the bank.
+    # Format: `aa,bb` with the two values separated by a comma and where:
+    # - `aa` is the two-digit error message from Atos.
+    # - `bb` is the optional two-digit error message from the bank.
+    # #### Comercio Latino
+    # This value is the status code and the error or response code received from
+    # the processor separated by a colon.
+    # Format: [status code]:E[error code] or [status code]:R[response code]
+    # Example `2:R06`
+    # #### JCN Gateway
+    # Processor-defined detail error code. The associated response category code
+    # is in the `processorInformation.responseCategoryCode` field.
+    # String (3)
+    # #### paypalgateway
+    # Processor generated ID for the itemized detail.
+    # @return [AchVerification]
+    attr_accessor :ach_verification
+
+    # For most processors, this is the error message sent directly from the
+    # bank. Returned only when the processor
+    # returns this value.
+    # **Important** Do not use this field to evaluate the result of the
+    # authorization.
+    # #### PIN debit
+    # Response value that is returned by the processor or bank.
+    # **Important** Do not use this field to evaluate the results of the
+    # transaction request.
+    # Returned by PIN debit credit, PIN debit purchase, and PIN debit reversal.
+    # #### AIBMS
+    # If this value is `08`, you can accept the transaction if the customer
+    # provides you with identification.
+    # #### Atos
+    # This value is the response code sent from Atos and it might also include
+    # the response code from the bank.
+    # Format: `aa,bb` with the two values separated by a comma and where:
+    # - `aa` is the two-digit error message from Atos.
+    # - `bb` is the optional two-digit error message from the bank.
+    # #### Comercio Latino
+    # This value is the status code and the error or response code received from
+    # the processor separated by a colon.
+    # Format: [status code]:E[error code] or [status code]:R[response code]
+    # Example `2:R06`
+    # #### JCN Gateway
+    # Processor-defined detail error code. The associated response category code
+    # is in the `processorInformation.responseCategoryCode` field.
+    # String (3)
+    # #### paypalgateway
+    # Processor generated ID for the itemized detail.
+    # @return [ElectronicVerificationResults1]
+    attr_accessor :electronic_verification_results
+
+    # The event status.
+    # @return [String]
+    attr_accessor :event_status
+
+    # This field is returned only for **American Express Direct** and **Visa
+    # Acceptance through VisaNet**.
+    # Returned by authorization and incremental authorization services.
+    # #### American Express Direct
+    # System trace audit number (STAN). This value identifies the transaction
+    # and is useful when investigating a
+    # chargeback dispute.
+    # #### Visa Acceptance through VisaNet
+    # System trace number that must be printed on the customer’s receipt.
+    # @return [String]
+    attr_accessor :system_trace_audit_number
+
+    # Used by Visa only and contains the response source/reason code that
+    # identifies the source of the response decision.
+    # @return [String]
+    attr_accessor :response_code_source
+
+    # Payment Account Reference (PAR) is a non-financial reference assigned to
+    # each unique payment account and used to link a payment account to
+    # associated network tokens, i.e. the same PAR is returned for PAN-based and
+    # tokenized transactions, such as from digital wallets. PAR can be returned
+    # in authorisation responses for requests initiated with both real PANs and
+    # tokenized PANs. PAR can be used by merchants for fraud detection and
+    # regulatory compliance across different channels and digital wallets. PAR
+    # allows all participants in the payments chain to have a single,
+    # non-sensitive value assigned to a consumer. This value can be used in
+    # place of sensitive card holder identification fields, and transmitted
+    # across the payments ecosystem to facilitate card holder identification.
+    # **Note** On Visa Acceptance through VisaNet, the value for this field
+    # corresponds to the following data in the TC 33 capture file:
+    # - Record: CP01 TCR8
+    # - Position: 79-110
+    # - Field: Payment Account Reference
+    # 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 networks.
+    # @return [String]
+    attr_accessor :payment_account_reference_number
+
+    # Payment Account Reference (PAR) is a non-financial reference assigned to
+    # each unique payment account and used to link a payment account to
+    # associated network tokens, i.e. the same PAR is returned for PAN-based and
+    # tokenized transactions, such as from digital wallets. PAR can be returned
+    # in authorisation responses for requests initiated with both real PANs and
+    # tokenized PANs. PAR can be used by merchants for fraud detection and
+    # regulatory compliance across different channels and digital wallets. PAR
+    # allows all participants in the payments chain to have a single,
+    # non-sensitive value assigned to a consumer. This value can be used in
+    # place of sensitive card holder identification fields, and transmitted
+    # across the payments ecosystem to facilitate card holder identification.
+    # **Note** On Visa Acceptance through VisaNet, the value for this field
+    # corresponds to the following data in the TC 33 capture file:
+    # - Record: CP01 TCR8
+    # - Position: 79-110
+    # - Field: Payment Account Reference
+    # 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 networks.
+    # @return [Routing]
+    attr_accessor :routing
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['processor'] = 'processor'
+      @_hash['multi_processor_routing'] = 'multiProcessorRouting'
+      @_hash['transaction_id'] = 'transactionId'
+      @_hash['network_transaction_id'] = 'networkTransactionId'
+      @_hash['retrieval_reference_number'] = 'retrievalReferenceNumber'
+      @_hash['response_id'] = 'responseId'
+      @_hash['approval_code'] = 'approvalCode'
+      @_hash['response_code'] = 'responseCode'
+      @_hash['avs'] = 'avs'
+      @_hash['card_verification'] = 'cardVerification'
+      @_hash['ach_verification'] = 'achVerification'
+      @_hash['electronic_verification_results'] =
+        'electronicVerificationResults'
+      @_hash['event_status'] = 'eventStatus'
+      @_hash['system_trace_audit_number'] = 'systemTraceAuditNumber'
+      @_hash['response_code_source'] = 'responseCodeSource'
+      @_hash['payment_account_reference_number'] =
+        'paymentAccountReferenceNumber'
+      @_hash['routing'] = 'routing'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        processor
+        multi_processor_routing
+        transaction_id
+        network_transaction_id
+        retrieval_reference_number
+        response_id
+        approval_code
+        response_code
+        avs
+        card_verification
+        ach_verification
+        electronic_verification_results
+        event_status
+        system_trace_audit_number
+        response_code_source
+        payment_account_reference_number
+        routing
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(processor = SKIP, multi_processor_routing = SKIP,
+                   transaction_id = SKIP, network_transaction_id = SKIP,
+                   retrieval_reference_number = SKIP, response_id = SKIP,
+                   approval_code = SKIP, response_code = SKIP, avs = SKIP,
+                   card_verification = SKIP, ach_verification = SKIP,
+                   electronic_verification_results = SKIP, event_status = SKIP,
+                   system_trace_audit_number = SKIP,
+                   response_code_source = SKIP,
+                   payment_account_reference_number = SKIP, routing = SKIP)
+      @processor = processor unless processor == SKIP
+      @multi_processor_routing = multi_processor_routing unless multi_processor_routing == SKIP
+      @transaction_id = transaction_id unless transaction_id == SKIP
+      @network_transaction_id = network_transaction_id unless network_transaction_id == SKIP
+      unless retrieval_reference_number == SKIP
+        @retrieval_reference_number =
+          retrieval_reference_number
+      end
+      @response_id = response_id unless response_id == SKIP
+      @approval_code = approval_code unless approval_code == SKIP
+      @response_code = response_code unless response_code == SKIP
+      @avs = avs unless avs == SKIP
+      @card_verification = card_verification unless card_verification == SKIP
+      @ach_verification = ach_verification unless ach_verification == SKIP
+      unless electronic_verification_results == SKIP
+        @electronic_verification_results =
+          electronic_verification_results
+      end
+      @event_status = event_status unless event_status == SKIP
+      unless system_trace_audit_number == SKIP
+        @system_trace_audit_number =
+          system_trace_audit_number
+      end
+      @response_code_source = response_code_source unless response_code_source == SKIP
+      unless payment_account_reference_number == SKIP
+        @payment_account_reference_number =
+          payment_account_reference_number
+      end
+      @routing = routing unless routing == 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.
+      processor = Processor.from_hash(hash['processor']) if hash['processor']
+      # Parameter is an array, so we need to iterate through it
+      multi_processor_routing = nil
+      unless hash['multiProcessorRouting'].nil?
+        multi_processor_routing = []
+        hash['multiProcessorRouting'].each do |structure|
+          multi_processor_routing << (MultiProcessorRouting.from_hash(structure) if structure)
+        end
+      end
+
+      multi_processor_routing = SKIP unless hash.key?('multiProcessorRouting')
+      transaction_id = hash.key?('transactionId') ? hash['transactionId'] : SKIP
+      network_transaction_id =
+        hash.key?('networkTransactionId') ? hash['networkTransactionId'] : SKIP
+      retrieval_reference_number =
+        hash.key?('retrievalReferenceNumber') ? hash['retrievalReferenceNumber'] : SKIP
+      response_id = hash.key?('responseId') ? hash['responseId'] : SKIP
+      approval_code = hash.key?('approvalCode') ? hash['approvalCode'] : SKIP
+      response_code = hash.key?('responseCode') ? hash['responseCode'] : SKIP
+      avs = Avs.from_hash(hash['avs']) if hash['avs']
+      card_verification = CardVerification1.from_hash(hash['cardVerification']) if
+        hash['cardVerification']
+      ach_verification = AchVerification.from_hash(hash['achVerification']) if
+        hash['achVerification']
+      if hash['electronicVerificationResults']
+        electronic_verification_results = ElectronicVerificationResults1.from_hash(hash['electronicVerificationResults'])
+      end
+      event_status = hash.key?('eventStatus') ? hash['eventStatus'] : SKIP
+      system_trace_audit_number =
+        hash.key?('systemTraceAuditNumber') ? hash['systemTraceAuditNumber'] : SKIP
+      response_code_source =
+        hash.key?('responseCodeSource') ? hash['responseCodeSource'] : SKIP
+      payment_account_reference_number =
+        hash.key?('paymentAccountReferenceNumber') ? hash['paymentAccountReferenceNumber'] : SKIP
+      routing = Routing.from_hash(hash['routing']) if hash['routing']
+
+      # Create object from extracted values.
+      ProcessorInformation24.new(processor,
+                                 multi_processor_routing,
+                                 transaction_id,
+                                 network_transaction_id,
+                                 retrieval_reference_number,
+                                 response_id,
+                                 approval_code,
+                                 response_code,
+                                 avs,
+                                 card_verification,
+                                 ach_verification,
+                                 electronic_verification_results,
+                                 event_status,
+                                 system_trace_audit_number,
+                                 response_code_source,
+                                 payment_account_reference_number,
+                                 routing)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} processor: #{@processor}, multi_processor_routing:"\
+      " #{@multi_processor_routing}, transaction_id: #{@transaction_id}, network_transaction_id:"\
+      " #{@network_transaction_id}, retrieval_reference_number: #{@retrieval_reference_number},"\
+      " response_id: #{@response_id}, approval_code: #{@approval_code}, response_code:"\
+      " #{@response_code}, avs: #{@avs}, card_verification: #{@card_verification},"\
+      " ach_verification: #{@ach_verification}, electronic_verification_results:"\
+      " #{@electronic_verification_results}, event_status: #{@event_status},"\
+      " system_trace_audit_number: #{@system_trace_audit_number}, response_code_source:"\
+      " #{@response_code_source}, payment_account_reference_number:"\
+      " #{@payment_account_reference_number}, routing: #{@routing}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} processor: #{@processor.inspect}, multi_processor_routing:"\
+      " #{@multi_processor_routing.inspect}, transaction_id: #{@transaction_id.inspect},"\
+      " network_transaction_id: #{@network_transaction_id.inspect}, retrieval_reference_number:"\
+      " #{@retrieval_reference_number.inspect}, response_id: #{@response_id.inspect},"\
+      " approval_code: #{@approval_code.inspect}, response_code: #{@response_code.inspect}, avs:"\
+      " #{@avs.inspect}, card_verification: #{@card_verification.inspect}, ach_verification:"\
+      " #{@ach_verification.inspect}, electronic_verification_results:"\
+      " #{@electronic_verification_results.inspect}, event_status: #{@event_status.inspect},"\
+      " system_trace_audit_number: #{@system_trace_audit_number.inspect}, response_code_source:"\
+      " #{@response_code_source.inspect}, payment_account_reference_number:"\
+      " #{@payment_account_reference_number.inspect}, routing: #{@routing.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/processor_information3.rb

@@ -0,0 +1,64 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # ProcessorInformation3 Model.
+  class ProcessorInformation3 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # This is a token generated by PSP, which is received in response to the
+    # Sessions service. This token should be sent in the following transactions.
+    # @return [String]
+    attr_accessor :pre_approval_token
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['pre_approval_token'] = 'preApprovalToken'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        pre_approval_token
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(pre_approval_token = SKIP)
+      @pre_approval_token = pre_approval_token unless pre_approval_token == 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.
+      pre_approval_token =
+        hash.key?('preApprovalToken') ? hash['preApprovalToken'] : SKIP
+
+      # Create object from extracted values.
+      ProcessorInformation3.new(pre_approval_token)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} pre_approval_token: #{@pre_approval_token}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} pre_approval_token: #{@pre_approval_token.inspect}>"
+    end
+  end
+end