visa-acceptance-api-sdk 1.0.0

data/lib/visa_acceptance_merged_spec/models/card7.rb

@@ -0,0 +1,310 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # Card7 Model.
+  class Card7 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Two-digit month in which the payment card expires.
+    # Format: `MM`.
+    # Valid values: `01` through `12`. Leading 0 is required.
+    # #### Barclays and Streamline
+    # For Maestro (UK Domestic) and Maestro (International) cards on Barclays
+    # and Streamline, this must be a valid value
+    # (`01` through `12`) but is not required to be a valid expiration date. In
+    # other words, an expiration date that is
+    # in the past does not cause Visa Acceptance to reject your request.
+    # However, an invalid expiration date might cause
+    # the issuer to reject your request.
+    # #### Encoded Account Numbers
+    # For encoded account numbers (_type_=039), if there is no expiration date
+    # on the card, use `12`.
+    # #### FDMS Nashville
+    # Required field.
+    # #### All other processors
+    # Required if `pointOfSaleInformation.entryMode=keyed`. However, this field
+    # is optional if your account is configured
+    # for relaxed requirements for address data and expiration date.
+    # **Important** It is your responsibility to determine
+    # whether a field is required for the transaction you are requesting.
+    # #### Google Pay transactions
+    # For PAN-based Google Pay transactions, this field is returned in the API
+    # response.
+    # @return [String]
+    attr_accessor :expiration_month
+
+    # Four-digit year in which the payment card expires.
+    # Format: `YYYY`.
+    # #### Barclays and Streamline
+    # For Maestro (UK Domestic) and Maestro (International) cards on Barclays
+    # and Streamline, this must be a valid value (`1900` through `3000`) but is
+    # not required to be a valid expiration date. In other words, an expiration
+    # date that is in the past does not cause Visa Acceptance to reject your
+    # request. However, an invalid expiration date might cause the issuer to
+    # reject your request.
+    # #### Encoded Account Numbers
+    # For encoded account numbers (**_type_**`=039`), if there is no expiration
+    # date on the card, use `2021`.
+    # #### FDMS Nashville
+    # Required field.
+    # #### FDC Nashville Global and FDMS South
+    # You can send in 2 digits or 4 digits. If you send in 2 digits, they must
+    # be the last 2 digits of the year.
+    # #### All other processors
+    # Required if `pointOfSaleInformation.entryMode=keyed`. However, this field
+    # is optional if your account is configured
+    # for relaxed requirements for address data and expiration date.
+    # **Important** It is your responsibility to determine
+    # whether a field is required for the transaction you are requesting.
+    # #### Google Pay transactions
+    # For PAN-based Google Pay transactions, this field is returned in the API
+    # response.
+    # @return [String]
+    attr_accessor :expiration_year
+
+    # The customer’s payment card number, also known as the Primary Account
+    # Number (PAN). You can also use this field
+    # for encoded account numbers.
+    # #### FDMS Nashville
+    # Required. String (19)
+    # #### GPX
+    # Required if `pointOfSaleInformation.entryMode=keyed`. However, this field
+    # is optional if your account is configured
+    # for relaxed requirements for address data and expiration date.
+    # **Important** It is your responsibility to determine
+    # whether a field is required for the transaction you are requesting.
+    # #### All other processors
+    # Required if `pointOfSaleInformation.entryMode=keyed`. However, this field
+    # is optional if your account is configured
+    # for relaxed requirements for address data and expiration date.
+    # **Important** It is your responsibility to determine
+    # whether a field is required for the transaction you are requesting.
+    # @return [String]
+    attr_accessor :number
+
+    # Card Verification Number.
+    # #### FDMS Nashville
+    # Required for American Express or if swiped; otherwise, optional.
+    # #### Ingenico ePayments
+    # Do not include this field when `commerceIndicator=recurring`.
+    # **Note** Ingenico ePayments was previously called _Global Collect_.
+    # #### TSYS Acquiring Solutions
+    # Optional if pointOfSaleInformation.entryMode=keyed; otherwise, not used.
+    # #### GPX
+    # Optional.
+    # #### All other processors:
+    # Optional.
+    # @return [String]
+    attr_accessor :security_code
+
+    # Three-digit value that indicates the card type.
+    # **IMPORTANT** It is strongly recommended that you include the card type
+    # field in request messages even if it is
+    # optional for your processor and card type. Omitting the card type can
+    # cause the transaction to be processed with the wrong card type.
+    # Possible values:
+    # - `001`: Visa. Use card type value `001` for Visa Electron.
+    # - `002`: Mastercard, Eurocard[^1], which is a European regional brand of
+    # Mastercard.
+    # - `003`: American Express
+    # - `004`: Discover
+    # - `005`: Diners Club
+    # - `006`: Carte Blanche[^1]
+    # - `007`: JCB[^1]
+    # - `008`: Optima
+    # - `009`: GE Private Label
+    # - `010`: Beneficial Private Label
+    # - `011`: Twinpay Credit Card
+    # - `012`: Twinpay Debit Card
+    # - `013`: WalMart
+    # - `014`: Enroute[^1]
+    # - `015`: Lowe's Consumer
+    # - `016`: Home Depot Consumer
+    # - `017`: MBNA
+    # - `018`: Dick's Sportswear
+    # - `019`: Casual Corner
+    # - `020`: Sears
+    # - `021`: JAL[^1]
+    # - `023`: Disney Card
+    # - `024`: Maestro (UK Domestic)[^1]
+    # - `025`: Sam's Club Consumer
+    # - `026`: Sam's Club Business
+    # - `027`: Nico's
+    # - `028`: Paymentech Bill Me Later
+    # - `029`: Bebe
+    # - `030`: Restoration Hardware
+    # - `031`: Delta Online
+    # - `032`: Solo
+    # - `033`: Visa Electron[^1]. Do not use this value. Use `001` for all Visa
+    # card types.
+    # - `034`: Dankort[^1]
+    # - `035`: Laser
+    # - `036`: Cartes Bancaires[^1,4]
+    # - `037`: Carta Si[^1]
+    # - `038`: Pinless Debit
+    # - `039`: Encoded account number[^1]
+    # - `040`: UATP[^1]
+    # - `041`: HOUSEHOLD
+    # - `042`: Maestro (International)[^1]
+    # - `043`: GE MONEY
+    # - `044`: Korean Cards
+    # - `045`: Style Cards
+    # - `046`: JCrew
+    # - `047`: Payeasecn eWallet
+    # - `048`: Payeasecn Bank Transfer
+    # - `049`: Meijer
+    # - `050`: Hipercard[^2,3]
+    # - `051`: Aura
+    # - `052`: Redecard
+    # - `053`: Orico card
+    # - `054`: Elo[^3]
+    # - `055`: Capitol One Private Label
+    # - `056`: Carnet
+    # - `057`: Costco Private Label
+    # - `058`: Carnet
+    # - `059`: ValueLink
+    # - `060`: MADA
+    # - `061`: RuPay
+    # - `062`: China UnionPay
+    # - `063`: Falabella Private Label
+    # - `064`: Prompt Card
+    # - `065`: Korean Domestic
+    # - `066`: Banricompras
+    # - `067`: MEEZA
+    # - `068`: PayPak
+    # - `070`: EFTPOS
+    # - `071`: Codensa
+    # - `072`: Olimpica
+    # - `073`: Colsubsidio
+    # - `074`: Tuya
+    # - `075`: Sodexo
+    # - `076`: Naranja
+    # - `077`: Cabal
+    # - `078`: DINELCO
+    # - `079`: PANAL
+    # - `080`: EPM
+    # - `081`: Jaywan
+    # [^1]: For this card type, you must include the
+    # `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type`
+    # field in your request for an authorization or a stand-alone credit.
+    # [^2]: For this card type on Cielo 3.0, you must include the
+    # `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type`
+    # field in a request for an authorization or a stand-alone credit. This card
+    # type is not supported on Cielo 1.5.
+    # [^3]: For this card type on Getnet and Rede, you must include the
+    # `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type`
+    # field in a request for an authorization or a stand-alone credit.
+    # [^4]: For this card type, you must include the
+    # `paymentInformation.card.type` in your request for any payer
+    # authentication services.
+    # #### Used by
+    # **Authorization**
+    # Required for Carte Blanche and JCB.
+    # Optional for all other card types.
+    # #### Card Present reply
+    # This field is included in the reply message when the client software that
+    # is installed on the POS terminal uses
+    # the token management service (TMS) to retrieve tokenized payment details.
+    # You must contact customer support to
+    # have your account enabled to receive these fields in the credit reply
+    # message.
+    # Returned by the Credit service.
+    # This reply field is only supported by the following processors:
+    # - American Express Direct
+    # - Credit Mutuel-CIC
+    # - FDC Nashville Global
+    # - OmniPay Direct
+    # - SIX
+    # #### Google Pay transactions
+    # For PAN-based Google Pay transactions, this field is returned in the API
+    # response.
+    # #### GPX
+    # This field only supports transactions from the following card types:
+    # - Visa
+    # - Mastercard
+    # - AMEX
+    # - Discover
+    # - Diners
+    # - JCB
+    # - Union Pay International
+    # @return [String]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['expiration_month'] = 'expirationMonth'
+      @_hash['expiration_year'] = 'expirationYear'
+      @_hash['number'] = 'number'
+      @_hash['security_code'] = 'securityCode'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        expiration_month
+        expiration_year
+        number
+        security_code
+        type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(expiration_month = SKIP, expiration_year = SKIP,
+                   number = SKIP, security_code = SKIP, type = SKIP)
+      @expiration_month = expiration_month unless expiration_month == SKIP
+      @expiration_year = expiration_year unless expiration_year == SKIP
+      @number = number unless number == SKIP
+      @security_code = security_code unless security_code == SKIP
+      @type = type unless type == 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.
+      expiration_month =
+        hash.key?('expirationMonth') ? hash['expirationMonth'] : SKIP
+      expiration_year =
+        hash.key?('expirationYear') ? hash['expirationYear'] : SKIP
+      number = hash.key?('number') ? hash['number'] : SKIP
+      security_code = hash.key?('securityCode') ? hash['securityCode'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+
+      # Create object from extracted values.
+      Card7.new(expiration_month,
+                expiration_year,
+                number,
+                security_code,
+                type)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} expiration_month: #{@expiration_month}, expiration_year:"\
+      " #{@expiration_year}, number: #{@number}, security_code: #{@security_code}, type:"\
+      " #{@type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} expiration_month: #{@expiration_month.inspect}, expiration_year:"\
+      " #{@expiration_year.inspect}, number: #{@number.inspect}, security_code:"\
+      " #{@security_code.inspect}, type: #{@type.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/card_verification.rb

@@ -0,0 +1,76 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # CardVerification Model.
+  class CardVerification < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # CVN result code.
+    # @return [String]
+    attr_accessor :result_code
+
+    # CVN result code sent directly from the processor. Returned only when the
+    # processor returns this value.
+    # **Important** Do not use this field to evaluate the result of card
+    # verification. Use for debugging purposes only.
+    # @return [String]
+    attr_accessor :result_code_raw
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['result_code'] = 'resultCode'
+      @_hash['result_code_raw'] = 'resultCodeRaw'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        result_code
+        result_code_raw
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(result_code = SKIP, result_code_raw = SKIP)
+      @result_code = result_code unless result_code == SKIP
+      @result_code_raw = result_code_raw unless result_code_raw == 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.
+      result_code = hash.key?('resultCode') ? hash['resultCode'] : SKIP
+      result_code_raw =
+        hash.key?('resultCodeRaw') ? hash['resultCodeRaw'] : SKIP
+
+      # Create object from extracted values.
+      CardVerification.new(result_code,
+                           result_code_raw)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} result_code: #{@result_code}, result_code_raw: #{@result_code_raw}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} result_code: #{@result_code.inspect}, result_code_raw:"\
+      " #{@result_code_raw.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/card_verification1.rb

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

data/lib/visa_acceptance_merged_spec/models/client_reference_information.rb

@@ -0,0 +1,191 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # ClientReferenceInformation Model.
+  class ClientReferenceInformation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Merchant-generated order reference or tracking number. It is recommended
+    # that you send a unique value for each
+    # transaction so that you can perform meaningful searches for the
+    # transaction.
+    # #### Used by
+    # **Authorization**
+    # Required field.
+    # #### PIN Debit
+    # Requests for PIN debit reversals need to use the same merchant reference
+    # number that was used in the transaction that is being
+    # reversed.
+    # Required field for all PIN Debit requests (purchase, credit, and
+    # reversal).
+    # #### FDC Nashville Global
+    # Certain circumstances can cause the processor to truncate this value to 15
+    # or 17 characters for Level II and Level III processing, which can cause a
+    # discrepancy between the value you submit and the value included in some
+    # processor reports.
+    # @return [String]
+    attr_accessor :code
+
+    # Reference number for the transaction.
+    # Depending on how your Visa Acceptance account is configured, this value
+    # could either be provided in the API request or generated by Visa
+    # Acceptance.
+    # The actual value used in the request to the processor is provided back to
+    # you by Visa Acceptance in the response.
+    # @return [String]
+    attr_accessor :reconciliation_id
+
+    # Used to resume a transaction that was paused for an order modification
+    # rule to allow for payer authentication to complete. To resume and continue
+    # with the authorization/decision service flow, call the services and
+    # include the request id from the prior decision call.
+    # @return [String]
+    attr_accessor :paused_request_id
+
+    # Identifier that you assign to the transaction. Normally generated by a
+    # client server to identify a unique API request.
+    # **Note** Use this field only if you want to support merchant-initiated
+    # reversal and void operations.
+    # #### Used by
+    # **Authorization, Authorization Reversal, Capture, Credit, and Void**
+    # Optional field.
+    # #### PIN Debit
+    # For a PIN debit reversal, your request must include a request ID or a
+    # merchant transaction identifier.
+    # Optional field for PIN debit purchase or credit requests.
+    # @return [String]
+    attr_accessor :transaction_id
+
+    # Brief description of the order or any comment you wish to add to the
+    # order.
+    # @return [String]
+    attr_accessor :comments
+
+    # Brief description of the order or any comment you wish to add to the
+    # order.
+    # @return [Partner]
+    attr_accessor :partner
+
+    # The name of the Connection Method client (such as Virtual Terminal or SOAP
+    # Toolkit API) that the merchant uses to send a transaction request to Visa
+    # Acceptance.
+    # @return [String]
+    attr_accessor :application_name
+
+    # Version of the Visa Acceptance application or integration used for a
+    # transaction.
+    # @return [String]
+    attr_accessor :application_version
+
+    # The entity that is responsible for running the transaction and submitting
+    # the processing request to Visa Acceptance. This could be a person, a
+    # system, or a connection method.
+    # @return [String]
+    attr_accessor :application_user
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['code'] = 'code'
+      @_hash['reconciliation_id'] = 'reconciliationId'
+      @_hash['paused_request_id'] = 'pausedRequestId'
+      @_hash['transaction_id'] = 'transactionId'
+      @_hash['comments'] = 'comments'
+      @_hash['partner'] = 'partner'
+      @_hash['application_name'] = 'applicationName'
+      @_hash['application_version'] = 'applicationVersion'
+      @_hash['application_user'] = 'applicationUser'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        code
+        reconciliation_id
+        paused_request_id
+        transaction_id
+        comments
+        partner
+        application_name
+        application_version
+        application_user
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(code = SKIP, reconciliation_id = SKIP,
+                   paused_request_id = SKIP, transaction_id = SKIP,
+                   comments = SKIP, partner = SKIP, application_name = SKIP,
+                   application_version = SKIP, application_user = SKIP)
+      @code = code unless code == SKIP
+      @reconciliation_id = reconciliation_id unless reconciliation_id == SKIP
+      @paused_request_id = paused_request_id unless paused_request_id == SKIP
+      @transaction_id = transaction_id unless transaction_id == SKIP
+      @comments = comments unless comments == SKIP
+      @partner = partner unless partner == SKIP
+      @application_name = application_name unless application_name == SKIP
+      @application_version = application_version unless application_version == SKIP
+      @application_user = application_user unless application_user == 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.
+      code = hash.key?('code') ? hash['code'] : SKIP
+      reconciliation_id =
+        hash.key?('reconciliationId') ? hash['reconciliationId'] : SKIP
+      paused_request_id =
+        hash.key?('pausedRequestId') ? hash['pausedRequestId'] : SKIP
+      transaction_id = hash.key?('transactionId') ? hash['transactionId'] : SKIP
+      comments = hash.key?('comments') ? hash['comments'] : SKIP
+      partner = Partner.from_hash(hash['partner']) if hash['partner']
+      application_name =
+        hash.key?('applicationName') ? hash['applicationName'] : SKIP
+      application_version =
+        hash.key?('applicationVersion') ? hash['applicationVersion'] : SKIP
+      application_user =
+        hash.key?('applicationUser') ? hash['applicationUser'] : SKIP
+
+      # Create object from extracted values.
+      ClientReferenceInformation.new(code,
+                                     reconciliation_id,
+                                     paused_request_id,
+                                     transaction_id,
+                                     comments,
+                                     partner,
+                                     application_name,
+                                     application_version,
+                                     application_user)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} code: #{@code}, reconciliation_id: #{@reconciliation_id},"\
+      " paused_request_id: #{@paused_request_id}, transaction_id: #{@transaction_id}, comments:"\
+      " #{@comments}, partner: #{@partner}, application_name: #{@application_name},"\
+      " application_version: #{@application_version}, application_user: #{@application_user}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} code: #{@code.inspect}, reconciliation_id: #{@reconciliation_id.inspect},"\
+      " paused_request_id: #{@paused_request_id.inspect}, transaction_id:"\
+      " #{@transaction_id.inspect}, comments: #{@comments.inspect}, partner: #{@partner.inspect},"\
+      " application_name: #{@application_name.inspect}, application_version:"\
+      " #{@application_version.inspect}, application_user: #{@application_user.inspect}>"
+    end
+  end
+end