visa-acceptance-api-sdk 1.0.0

data/lib/visa_acceptance_merged_spec/models/emv1.rb

@@ -0,0 +1,184 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # Emv1 Model.
+  class Emv1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # EMV data that is transmitted from the chip card to the issuer, and from
+    # the issuer to the chip card. The EMV
+    # data is in the tag-length-value format and includes chip card tags,
+    # terminal tags, and transaction detail tags.
+    # For information about the individual tags, see the “Application
+    # Specification” section in the EMV 4.3 Specifications: 
+    # **Note** Card present information about EMV applies only to credit card
+    # processing and PIN debit processing.
+    # All other card present information applies only to credit card processing.
+    # PIN debit processing is available only
+    # on FDC Nashville Global.
+    # **Important** The following tags contain sensitive information and **must
+    # not** be included in this field:
+    #  - `56`: Track 1 equivalent data
+    #  - `57`: Track 2 equivalent data
+    #  - `5A`: Application PAN
+    #  - `5F20`: Cardholder name
+    #  - `5F24`: Application expiration date (This sensitivity has been relaxed
+    # for Credit Mutuel-CIC, American Express Direct, FDC Nashville Global,
+    # First Data Merchant Solutions, and SIX)
+    #  - `99`: Transaction PIN
+    #  - `9F0B`: Cardholder name (extended)
+    #  - `9F1F`: Track 1 discretionary data
+    #  - `9F20`: Track 2 discretionary data
+    # For captures, this field is required for contact EMV transactions.
+    # Otherwise, it is optional.
+    # For credits, this field is required for contact EMV stand-alone credits
+    # and contactless EMV stand-alone credits.
+    # Otherwise, it is optional.
+    # **Important** For contact EMV captures, contact EMV stand-alone credits,
+    # and contactless EMV stand-alone credits,
+    # you must include the following tags in this field. For all other types of
+    # EMV transactions, the following tags
+    # are optional.
+    #  - `95`: Terminal verification results
+    #  - `9F10`: Issuer application data
+    #  - `9F26`: Application cryptogram
+    # #### Visa Acceptance through VisaNet
+    # - In Japan: 199 bytes
+    # - In other countries: String (252)
+    # For Mastercard Transactions, Optionally Tag 9F60 (Authenticated
+    # Application Data) and 
+    # Tag 96 (Kernel Identifier - Terminal) can be included in the Field.
+    # #### GPX
+    # This field only supports transactions from the following card types:
+    # - Visa
+    # - Mastercard
+    # - AMEX
+    # - Discover
+    # - Diners
+    # - JCB
+    # - Union Pay International
+    # #### JCN Gateway
+    # The following tags must be included:
+    # - `4F`: Application identifier
+    # - `84`: Dedicated file name
+    # Data length: 199 bytes
+    # #### All other processors:
+    # String (999)
+    # #### Used by
+    # Authorization: Optional
+    # Authorization Reversal: Optional
+    # Credit: Optional
+    # PIN Debit processing (purchase, credit and reversal): Optional
+    # @return [String]
+    attr_accessor :tags
+
+    # Entity or service that provided the validation results returned in
+    # `chipValidationResult`.
+    # Possible values:
+    #  - `02`: MasterCard on-behalf pre-validation service (The MasterCard
+    # authorization platform validated the M/Chip cryptogram before the
+    # authorization request reached the issuer.)
+    #  - `03`: MasterCard on-behalf stand-in service (The MasterCard
+    # authorization platform validated the M/Chip cryptogram because the issuer
+    # was not available.)
+    #  - `50`: Issuer
+    #  - `90`: Chip fall-back transaction downgrade process (The chip could not
+    # be read.)
+    # This field is returned only for NFC payment network tokenization
+    # transactions with MasterCard.
+    # **Note** No Visa Acceptance through VisaNet acquirers support EMV at this
+    # time.
+    # @return [String]
+    attr_accessor :chip_validation_type
+
+    # Cryptogram validation results returned by the entity or service specified
+    # in `chipValidationType`.
+    # Possible values:
+    # - `A`: Application cryptogram is valid, but the application transaction
+    # counter (ATC) is outside allowed range. (A large jump in ATC values may
+    # indicate data copying or other fraud.)
+    # - `C`: Chip validation was completed successfully.
+    # - `E`: Application cryptogram is valid but the ATC indicates possible
+    # replay fraud.
+    # - `F`: Format error in the chip data.
+    # - `G`: Application cryptogram is valid but is not a valid authorization
+    # request cryptogram (ARQC).
+    # - `I`: Application cryptogram is invalid.
+    # - `T`: Application cryptogram is valid but terminal verification results
+    # (TVR) or card verification results (CVR) are invalid.
+    # - `U`: Application cryptogram could not be validated because of a
+    # technical error.
+    # This field is returned only for NFC payment network tokenization
+    # transactions with MasterCard.
+    # **Note** No Visa Acceptance through VisaNet acquirers support EMV at this
+    # time.
+    # @return [String]
+    attr_accessor :chip_validation_result
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tags'] = 'tags'
+      @_hash['chip_validation_type'] = 'chipValidationType'
+      @_hash['chip_validation_result'] = 'chipValidationResult'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        tags
+        chip_validation_type
+        chip_validation_result
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(tags = SKIP, chip_validation_type = SKIP,
+                   chip_validation_result = SKIP)
+      @tags = tags unless tags == SKIP
+      @chip_validation_type = chip_validation_type unless chip_validation_type == SKIP
+      @chip_validation_result = chip_validation_result unless chip_validation_result == 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.
+      tags = hash.key?('tags') ? hash['tags'] : SKIP
+      chip_validation_type =
+        hash.key?('chipValidationType') ? hash['chipValidationType'] : SKIP
+      chip_validation_result =
+        hash.key?('chipValidationResult') ? hash['chipValidationResult'] : SKIP
+
+      # Create object from extracted values.
+      Emv1.new(tags,
+               chip_validation_type,
+               chip_validation_result)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} tags: #{@tags}, chip_validation_type: #{@chip_validation_type},"\
+      " chip_validation_result: #{@chip_validation_result}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} tags: #{@tags.inspect}, chip_validation_type:"\
+      " #{@chip_validation_type.inspect}, chip_validation_result:"\
+      " #{@chip_validation_result.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/emv2.rb

@@ -0,0 +1,125 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # Emv2 Model.
+  class Emv2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # EMV data that is transmitted from the chip card to the issuer, and from
+    # the issuer to the chip card. The EMV
+    # data is in the tag-length-value format and includes chip card tags,
+    # terminal tags, and transaction detail tags.
+    # For information about the individual tags, see the “Application
+    # Specification” section in the EMV 4.3 Specifications: 
+    # **Note** Card present information about EMV applies only to credit card
+    # processing and PIN debit processing.
+    # All other card present information applies only to credit card processing.
+    # PIN debit processing is available only
+    # on FDC Nashville Global.
+    # **Important** The following tags contain sensitive information and **must
+    # not** be included in this field:
+    #  - `56`: Track 1 equivalent data
+    #  - `57`: Track 2 equivalent data
+    #  - `5A`: Application PAN
+    #  - `5F20`: Cardholder name
+    #  - `5F24`: Application expiration date (This sensitivity has been relaxed
+    # for Credit Mutuel-CIC, American Express Direct, FDC Nashville Global,
+    # First Data Merchant Solutions, and SIX)
+    #  - `99`: Transaction PIN
+    #  - `9F0B`: Cardholder name (extended)
+    #  - `9F1F`: Track 1 discretionary data
+    #  - `9F20`: Track 2 discretionary data
+    # For captures, this field is required for contact EMV transactions.
+    # Otherwise, it is optional.
+    # For credits, this field is required for contact EMV stand-alone credits
+    # and contactless EMV stand-alone credits.
+    # Otherwise, it is optional.
+    # **Important** For contact EMV captures, contact EMV stand-alone credits,
+    # and contactless EMV stand-alone credits,
+    # you must include the following tags in this field. For all other types of
+    # EMV transactions, the following tags
+    # are optional.
+    #  - `95`: Terminal verification results
+    #  - `9F10`: Issuer application data
+    #  - `9F26`: Application cryptogram
+    # #### Visa Acceptance through VisaNet
+    # - In Japan: 199 bytes
+    # - In other countries: String (252)
+    # For Mastercard Transactions, Optionally Tag 9F60 (Authenticated
+    # Application Data) and 
+    # Tag 96 (Kernel Identifier - Terminal) can be included in the Field.
+    # #### GPX
+    # This field only supports transactions from the following card types:
+    # - Visa
+    # - Mastercard
+    # - AMEX
+    # - Discover
+    # - Diners
+    # - JCB
+    # - Union Pay International
+    # #### JCN Gateway
+    # The following tags must be included:
+    # - `4F`: Application identifier
+    # - `84`: Dedicated file name
+    # Data length: 199 bytes
+    # #### All other processors:
+    # String (999)
+    # #### Used by
+    # Authorization: Optional
+    # Authorization Reversal: Optional
+    # Credit: Optional
+    # PIN Debit processing (purchase, credit and reversal): Optional
+    # @return [String]
+    attr_accessor :tags
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tags'] = 'tags'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        tags
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(tags = SKIP)
+      @tags = tags unless tags == 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.
+      tags = hash.key?('tags') ? hash['tags'] : SKIP
+
+      # Create object from extracted values.
+      Emv2.new(tags)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} tags: #{@tags}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} tags: #{@tags.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/emv6.rb

@@ -0,0 +1,147 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # Emv6 Model.
+  class Emv6 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # EMV data that is transmitted from the chip card to the issuer, and from
+    # the issuer to the chip card. The EMV
+    # data is in the tag-length-value format and includes chip card tags,
+    # terminal tags, and transaction detail tags.
+    # For information about the individual tags, see the “Application
+    # Specification” section in the EMV 4.3 Specifications: 
+    # **Note** Card present information about EMV applies only to credit card
+    # processing and PIN debit processing.
+    # All other card present information applies only to credit card processing.
+    # PIN debit processing is available only
+    # on FDC Nashville Global.
+    # **Important** The following tags contain sensitive information and **must
+    # not** be included in this field:
+    #  - `56`: Track 1 equivalent data
+    #  - `57`: Track 2 equivalent data
+    #  - `5A`: Application PAN
+    #  - `5F20`: Cardholder name
+    #  - `5F24`: Application expiration date (This sensitivity has been relaxed
+    # for Credit Mutuel-CIC, American Express Direct, FDC Nashville Global,
+    # First Data Merchant Solutions, and SIX)
+    #  - `99`: Transaction PIN
+    #  - `9F0B`: Cardholder name (extended)
+    #  - `9F1F`: Track 1 discretionary data
+    #  - `9F20`: Track 2 discretionary data
+    # For captures, this field is required for contact EMV transactions.
+    # Otherwise, it is optional.
+    # For credits, this field is required for contact EMV stand-alone credits
+    # and contactless EMV stand-alone credits.
+    # Otherwise, it is optional.
+    # **Important** For contact EMV captures, contact EMV stand-alone credits,
+    # and contactless EMV stand-alone credits,
+    # you must include the following tags in this field. For all other types of
+    # EMV transactions, the following tags
+    # are optional.
+    #  - `95`: Terminal verification results
+    #  - `9F10`: Issuer application data
+    #  - `9F26`: Application cryptogram
+    # #### Visa Acceptance through VisaNet
+    # - In Japan: 199 bytes
+    # - In other countries: String (252)
+    # For Mastercard Transactions, Optionally Tag 9F60 (Authenticated
+    # Application Data) and 
+    # Tag 96 (Kernel Identifier - Terminal) can be included in the Field.
+    # #### GPX
+    # This field only supports transactions from the following card types:
+    # - Visa
+    # - Mastercard
+    # - AMEX
+    # - Discover
+    # - Diners
+    # - JCB
+    # - Union Pay International
+    # #### JCN Gateway
+    # The following tags must be included:
+    # - `4F`: Application identifier
+    # - `84`: Dedicated file name
+    # Data length: 199 bytes
+    # #### All other processors:
+    # String (999)
+    # #### Used by
+    # Authorization: Optional
+    # Authorization Reversal: Optional
+    # Credit: Optional
+    # PIN Debit processing (purchase, credit and reversal): Optional
+    # @return [String]
+    attr_accessor :tags
+
+    # Indicates whether a fallback method was used to enter credit card
+    # information into the POS terminal. When a
+    # technical problem prevents a successful exchange of information between a
+    # chip card and a chip-capable terminal:
+    #  1. Swipe the card or key the credit card information into the POS
+    # terminal.
+    #  2. Use the pointOfSaleInformation.entryMode field to indicate whether the
+    # information was swiped or keyed.
+    # Possible values:
+    # - `true`: Fallback method was used.
+    # - `false` (default): Fallback method was not used.
+    # This field is supported only on American Express Direct, Chase Paymentech
+    # Solutions, Visa Acceptance through VisaNet,
+    # FDC Nashville Global, GPN, JCN Gateway, OmniPay Direct, and SIX.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :fallback
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tags'] = 'tags'
+      @_hash['fallback'] = 'fallback'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        tags
+        fallback
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(tags = SKIP, fallback = SKIP)
+      @tags = tags unless tags == SKIP
+      @fallback = fallback unless fallback == 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.
+      tags = hash.key?('tags') ? hash['tags'] : SKIP
+      fallback = hash.key?('fallback') ? hash['fallback'] : SKIP
+
+      # Create object from extracted values.
+      Emv6.new(tags,
+               fallback)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} tags: #{@tags}, fallback: #{@fallback}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} tags: #{@tags.inspect}, fallback: #{@fallback.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/error.rb

@@ -0,0 +1,97 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # Error Model.
+  class Error < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The type of error.
+    # Possible Values:
+    #   - invalidHeaders
+    #   - missingHeaders
+    #   - invalidFields
+    #   - missingFields
+    #   - unsupportedPaymentMethodModification
+    #   - invalidCombination
+    # @return [String]
+    attr_accessor :type
+
+    # The detailed message related to the type.
+    # @return [String]
+    attr_accessor :message
+
+    # The detailed message related to the type.
+    # @return [Array[Detail40]]
+    attr_accessor :details
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['message'] = 'message'
+      @_hash['details'] = 'details'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+        message
+        details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type = SKIP, message = SKIP, details = SKIP)
+      @type = type unless type == SKIP
+      @message = message unless message == SKIP
+      @details = details unless details == 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.
+      type = hash.key?('type') ? hash['type'] : SKIP
+      message = hash.key?('message') ? hash['message'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      details = nil
+      unless hash['details'].nil?
+        details = []
+        hash['details'].each do |structure|
+          details << (Detail40.from_hash(structure) if structure)
+        end
+      end
+
+      details = SKIP unless hash.key?('details')
+
+      # Create object from extracted values.
+      Error.new(type,
+                message,
+                details)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type}, message: #{@message}, details: #{@details}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type.inspect}, message: #{@message.inspect}, details:"\
+      " #{@details.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/error1.rb

@@ -0,0 +1,73 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # Error1 Model.
+  class Error1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The type of error.
+    # Possible Values:
+    #   - forbidden
+    # @return [String]
+    attr_accessor :type
+
+    # The detailed message related to the type.
+    # @return [String]
+    attr_accessor :message
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['message'] = 'message'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+        message
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type = SKIP, message = SKIP)
+      @type = type unless type == SKIP
+      @message = message unless message == 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.
+      type = hash.key?('type') ? hash['type'] : SKIP
+      message = hash.key?('message') ? hash['message'] : SKIP
+
+      # Create object from extracted values.
+      Error1.new(type,
+                 message)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type}, message: #{@message}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type.inspect}, message: #{@message.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/error15.rb

@@ -0,0 +1,73 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # Error15 Model.
+  class Error15 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The type of error.
+    # Possible Values:
+    #   - conflict
+    # @return [String]
+    attr_accessor :type
+
+    # The detailed message related to the type.
+    # @return [String]
+    attr_accessor :message
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['message'] = 'message'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+        message
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type = SKIP, message = SKIP)
+      @type = type unless type == SKIP
+      @message = message unless message == 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.
+      type = hash.key?('type') ? hash['type'] : SKIP
+      message = hash.key?('message') ? hash['message'] : SKIP
+
+      # Create object from extracted values.
+      Error15.new(type,
+                  message)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type}, message: #{@message}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type.inspect}, message: #{@message.inspect}>"
+    end
+  end
+end