acceptance-api-sdk 0.0.1

data/lib/visa_acceptance_merged_spec/models/emv.rb

@@ -0,0 +1,273 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # Emv Model.
+  class Emv < 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
+
+    # Method that was used to verify the cardholder's identity.
+    # Possible values:
+    #  - `0`: No verification
+    #  - `1`: Signature
+    # This field is supported only on **American Express Direct**.
+    # @return [Integer]
+    attr_accessor :cardholder_verification_method_used
+
+    # Number assigned to a specific card when two or more cards are associated
+    # with the same primary account number.
+    # This value enables issuers to distinguish among multiple cards that are
+    # linked to the same account.
+    # This value can also act as a tracking tool when reissuing cards. 
+    # When this value is available, it is provided by the chip reader. 
+    # When the chip reader does not provide this value, do not include this
+    # field in your request.
+    # When sequence number is not provided via this API field, the value is
+    # extracted from EMV tag 5F34 for Visa and Mastercard transactions. To
+    # enable this feature please call support.
+    # **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 Visa Acceptance through VisaNet
+    # and FDC Nashville Global.
+    # #### Used by
+    # Authorization: Optional
+    # PIN Debit processing: Optional
+    # #### GPX
+    # This field only supports transactions from the following card types:
+    # - Visa
+    # - Mastercard
+    # - AMEX
+    # - Discover
+    # - Diners
+    # - JCB
+    # - Union Pay International
+    # @return [String]
+    attr_accessor :card_sequence_number
+
+    # 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
+
+    # Reason for the EMV fallback transaction. An EMV fallback transaction
+    # occurs when an EMV transaction fails for
+    # one of these reasons:
+    #  - Technical failure: the EMV terminal or EMV card cannot read and process
+    # chip data.
+    #  - Empty candidate list failure: the EMV terminal does not have any
+    # applications in common with the EMV card.
+    #    EMV terminals are coded to determine whether the terminal and EMV card
+    # have any applications in common.
+    #    EMV terminals provide this information to you.
+    # Possible values:
+    #  - `1`: Transaction was initiated with information from a magnetic stripe,
+    # and the previous transaction at the
+    #     EMV terminal either used information from a successful chip read or it
+    # was not a chip transaction.
+    #  - `2`: Transaction was initiated with information from a magnetic stripe,
+    # and the previous transaction at the
+    #     EMV terminal was an EMV fallback transaction because the attempted
+    # chip read was unsuccessful.
+    # This field is supported only on **GPN** and **JCN Gateway**.
+    # **NOTE**: This field is required when an EMV transaction fails for a
+    # technical reason. Do not include this field
+    # when the EMV terminal does not have any applications in common with the
+    # EMV card.
+    # @return [Integer]
+    attr_accessor :fallback_condition
+
+    # #### Visa Platform Connect
+    # Value “true” indicates this transaction is intentionally duplicated . The
+    # field contains value “true” which
+    # indicates that merchant has intentionally duplicated single tap
+    # transaction. Merchant is intentionally sending
+    # a duplicate auth request for a single tap txn because the issuer requested
+    # a PIN.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_repeat
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tags'] = 'tags'
+      @_hash['cardholder_verification_method_used'] =
+        'cardholderVerificationMethodUsed'
+      @_hash['card_sequence_number'] = 'cardSequenceNumber'
+      @_hash['fallback'] = 'fallback'
+      @_hash['fallback_condition'] = 'fallbackCondition'
+      @_hash['is_repeat'] = 'isRepeat'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        tags
+        cardholder_verification_method_used
+        card_sequence_number
+        fallback
+        fallback_condition
+        is_repeat
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(tags: SKIP, cardholder_verification_method_used: SKIP,
+                   card_sequence_number: SKIP, fallback: SKIP,
+                   fallback_condition: SKIP, is_repeat: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @tags = tags unless tags == SKIP
+      unless cardholder_verification_method_used == SKIP
+        @cardholder_verification_method_used =
+          cardholder_verification_method_used
+      end
+      @card_sequence_number = card_sequence_number unless card_sequence_number == SKIP
+      @fallback = fallback unless fallback == SKIP
+      @fallback_condition = fallback_condition unless fallback_condition == SKIP
+      @is_repeat = is_repeat unless is_repeat == 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.
+      tags = hash.key?('tags') ? hash['tags'] : SKIP
+      cardholder_verification_method_used =
+        hash.key?('cardholderVerificationMethodUsed') ? hash['cardholderVerificationMethodUsed'] : SKIP
+      card_sequence_number =
+        hash.key?('cardSequenceNumber') ? hash['cardSequenceNumber'] : SKIP
+      fallback = hash.key?('fallback') ? hash['fallback'] : SKIP
+      fallback_condition =
+        hash.key?('fallbackCondition') ? hash['fallbackCondition'] : SKIP
+      is_repeat = hash.key?('isRepeat') ? hash['isRepeat'] : 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.
+      Emv.new(tags: tags,
+              cardholder_verification_method_used: cardholder_verification_method_used,
+              card_sequence_number: card_sequence_number,
+              fallback: fallback,
+              fallback_condition: fallback_condition,
+              is_repeat: is_repeat,
+              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} tags: #{@tags}, cardholder_verification_method_used:"\
+      " #{@cardholder_verification_method_used}, card_sequence_number: #{@card_sequence_number},"\
+      " fallback: #{@fallback}, fallback_condition: #{@fallback_condition}, is_repeat:"\
+      " #{@is_repeat}, 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} tags: #{@tags.inspect}, cardholder_verification_method_used:"\
+      " #{@cardholder_verification_method_used.inspect}, card_sequence_number:"\
+      " #{@card_sequence_number.inspect}, fallback: #{@fallback.inspect}, fallback_condition:"\
+      " #{@fallback_condition.inspect}, is_repeat: #{@is_repeat.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/emv1.rb

@@ -0,0 +1,197 @@
+# 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, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @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
+      @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.
+      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 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.
+      Emv1.new(tags: tags,
+               chip_validation_type: chip_validation_type,
+               chip_validation_result: chip_validation_result,
+               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} tags: #{@tags}, chip_validation_type: #{@chip_validation_type},"\
+      " chip_validation_result: #{@chip_validation_result}, 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} tags: #{@tags.inspect}, chip_validation_type:"\
+      " #{@chip_validation_type.inspect}, chip_validation_result:"\
+      " #{@chip_validation_result.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/emv2.rb

@@ -0,0 +1,137 @@
+# 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, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @tags = tags unless tags == 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.
+      tags = hash.key?('tags') ? hash['tags'] : 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.
+      Emv2.new(tags: tags,
+               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} tags: #{@tags}, 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} tags: #{@tags.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end