visa-acceptance-api-sdk 1.0.0

data/lib/visa_acceptance_merged_spec/models/tokenized_card.rb

@@ -0,0 +1,428 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # TokenizedCard Model.
+  class TokenizedCard < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Customer’s payment network token value.
+    # @return [String]
+    attr_accessor :number
+
+    # One of two possible meanings:
+    # - The two-digit month in which a token expires.
+    # - The two-digit month in which a card expires.
+    # Format: `MM`
+    # Possible values: `01` through `12`
+    # **NOTE** The meaning of this field is dependent on the payment processor
+    # that is returning the value in an authorization reply. Please see the
+    # processor-specific details below.
+    # #### 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 (`card_type=039`), if there is no expiration
+    # date on the card, use `12`.\
+    # **Important** It is your responsibility to determine whether a field is
+    # required for the transaction you are requesting.
+    # #### Samsung Pay and Apple Pay
+    # Month in which the token expires. Visa Acceptance includes this field in
+    # the reply message when it decrypts the payment blob for the tokenized
+    # transaction.
+    # @return [String]
+    attr_accessor :expiration_month
+
+    # One of two possible meanings:
+    # - The four-digit year in which a token expires.
+    # - The four-digit year in which a card expires.
+    # Format: `YYYY`
+    # Possible values: `1900` through `3000`
+    # Data type: Non-negative integer
+    # **NOTE** The meaning of this field is dependent on the payment processor
+    # that is returning the value in an authorization reply. Please see the
+    # processor-specific details below.
+    # #### 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 (`card_ type=039`), if there is no expiration
+    # date on the card, use `2021`.
+    # #### FDC Nashville Global and FDMS South
+    # You can send in 2 digits or 4 digits. When you send in 2 digits, they must
+    # be the last 2 digits of
+    # the year.
+    # #### Samsung Pay and Apple Pay
+    # Year in which the token expires. Visa Acceptance includes this field in
+    # the reply message when it decrypts the payment blob for the tokenized
+    # transaction.
+    # **Important** It is your responsibility to determine whether a field is
+    # required for the transaction
+    # you are requesting.
+    # @return [String]
+    attr_accessor :expiration_year
+
+    # 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
+
+    # This field contains token information.
+    # @return [String]
+    attr_accessor :cryptogram
+
+    # Value that identifies your business and indicates that the cardholder’s
+    # account number is tokenized. This value
+    # is assigned by the token service provider and is unique within the token
+    # service provider’s database.
+    # **Note** This field is supported only for **Visa Acceptance through
+    # VisaNet** and **FDC Nashville Global**.
+    # #### PIN debit
+    # Optional field for PIN debit credit or PIN debit purchase transactions
+    # that use payment network tokens; otherwise, not used.
+    # @return [String]
+    attr_accessor :requestor_id
+
+    # Type of transaction that provided the token data. This value does not
+    # specify the token service provider; it specifies the entity that
+    # provided you with information about the token.
+    # Possible value:
+    # - `2`: Near-field communication (NFC) transaction. The customer’s mobile
+    # device provided the token data for a contactless EMV transaction. For
+    # recurring
+    # transactions, use this value if the original transaction was a contactless
+    # EMV transaction.
+    # #### Visa Platform Connect
+    # - `1`: For Rupay and In App tokenization. Example: InApp apple pay.
+    # - `3`: Card/Credential On File Tokenization.
+    # **NOTE** No Visa Acceptance through VisaNet acquirers support EMV at this
+    # time.
+    # Required field for PIN debit credit or PIN debit purchase transactions
+    # that use payment network tokens; otherwise, not used.
+    # #### Rupay
+    # - `3`: Card/Credential On File Tokenization.
+    # - `4`: Tokenizined Transaction. Should be used for Guest Checkout
+    # transactions with token.
+    # @return [String]
+    attr_accessor :transaction_type
+
+    # Confidence level of the tokenization. This value is assigned by the token
+    # service provider.
+    # **Note** This field is supported only for **Visa Acceptance through
+    # VisaNet** and **FDC Nashville Global**.
+    # Returned by PIN debit credit or PIN debit purchase.
+    # **Note** Merchants supported for **Visa Acceptance through
+    # VisaNet**/**Visa Platform Connect** are advised not to use this field.
+    # @return [String]
+    attr_accessor :assurance_level
+
+    # Type of technology used in the device to store token data. Possible
+    # values:
+    # - `001`: Secure Element (SE). Smart card or memory with restricted access
+    # and encryption to prevent data tampering. For storing payment
+    #    credentials, a SE is tested against a set of requirements defined by
+    # the payment networks.
+    #    **Note** This field is supported only for _FDC Compass_.
+    # - 002: Host Card Emulation (HCE). Emulation of a smart card by using
+    # software to create a virtual and exact representation of the card.
+    # Sensitive data is stored in a database that is hosted in the cloud. For
+    # storing payment credentials, a database
+    # must meet very stringent security requirements that exceed PCI DSS.
+    # **Note** This field is supported only for _FDC Compass_.
+    # @return [String]
+    attr_accessor :storage_method
+
+    # Card Verification Number (CVN).
+    # #### Ingenico ePayments
+    # Do not include this field when **commerceIndicator=recurring**.
+    # **Note** Ingenico ePayments was previously called _Global Collect_.
+    # @return [String]
+    attr_accessor :security_code
+
+    # Indicates whether a CVN code was sent. Possible values:
+    #  - `0` (default): CVN service not requested. This default value is used
+    # when you do not include
+    #      `securityCode` field in the request.
+    #  - `1` (default): CVN service requested and supported. This default value
+    # is used when you include
+    #      `securityCode` field in the request.
+    #  - `2`: CVN on credit card is illegible.
+    #  - `9`: CVN was not imprinted on credit card.
+    # #### FDMS Nashville
+    # Required for American Express cards; otherwise, optional.
+    # #### TSYS Acquiring Solutions
+    # Optional if `pointOfSaleInformation.entryMode=keyed`; otherwise, not used.
+    # #### All other processors
+    # Optional.
+    # @return [String]
+    attr_accessor :security_code_indicator
+
+    # Confidence level of the tokenization. This value is assigned by the token
+    # service provider.
+    # **Note** This field is supported only for **Visa Platform Connect**
+    # @return [String]
+    attr_accessor :assurance_method
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['number'] = 'number'
+      @_hash['expiration_month'] = 'expirationMonth'
+      @_hash['expiration_year'] = 'expirationYear'
+      @_hash['type'] = 'type'
+      @_hash['cryptogram'] = 'cryptogram'
+      @_hash['requestor_id'] = 'requestorId'
+      @_hash['transaction_type'] = 'transactionType'
+      @_hash['assurance_level'] = 'assuranceLevel'
+      @_hash['storage_method'] = 'storageMethod'
+      @_hash['security_code'] = 'securityCode'
+      @_hash['security_code_indicator'] = 'securityCodeIndicator'
+      @_hash['assurance_method'] = 'assuranceMethod'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        number
+        expiration_month
+        expiration_year
+        type
+        cryptogram
+        requestor_id
+        transaction_type
+        assurance_level
+        storage_method
+        security_code
+        security_code_indicator
+        assurance_method
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(number = SKIP, expiration_month = SKIP,
+                   expiration_year = SKIP, type = SKIP, cryptogram = SKIP,
+                   requestor_id = SKIP, transaction_type = SKIP,
+                   assurance_level = SKIP, storage_method = SKIP,
+                   security_code = SKIP, security_code_indicator = SKIP,
+                   assurance_method = SKIP)
+      @number = number unless number == SKIP
+      @expiration_month = expiration_month unless expiration_month == SKIP
+      @expiration_year = expiration_year unless expiration_year == SKIP
+      @type = type unless type == SKIP
+      @cryptogram = cryptogram unless cryptogram == SKIP
+      @requestor_id = requestor_id unless requestor_id == SKIP
+      @transaction_type = transaction_type unless transaction_type == SKIP
+      @assurance_level = assurance_level unless assurance_level == SKIP
+      @storage_method = storage_method unless storage_method == SKIP
+      @security_code = security_code unless security_code == SKIP
+      @security_code_indicator = security_code_indicator unless security_code_indicator == SKIP
+      @assurance_method = assurance_method unless assurance_method == 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.
+      number = hash.key?('number') ? hash['number'] : SKIP
+      expiration_month =
+        hash.key?('expirationMonth') ? hash['expirationMonth'] : SKIP
+      expiration_year =
+        hash.key?('expirationYear') ? hash['expirationYear'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      cryptogram = hash.key?('cryptogram') ? hash['cryptogram'] : SKIP
+      requestor_id = hash.key?('requestorId') ? hash['requestorId'] : SKIP
+      transaction_type =
+        hash.key?('transactionType') ? hash['transactionType'] : SKIP
+      assurance_level =
+        hash.key?('assuranceLevel') ? hash['assuranceLevel'] : SKIP
+      storage_method = hash.key?('storageMethod') ? hash['storageMethod'] : SKIP
+      security_code = hash.key?('securityCode') ? hash['securityCode'] : SKIP
+      security_code_indicator =
+        hash.key?('securityCodeIndicator') ? hash['securityCodeIndicator'] : SKIP
+      assurance_method =
+        hash.key?('assuranceMethod') ? hash['assuranceMethod'] : SKIP
+
+      # Create object from extracted values.
+      TokenizedCard.new(number,
+                        expiration_month,
+                        expiration_year,
+                        type,
+                        cryptogram,
+                        requestor_id,
+                        transaction_type,
+                        assurance_level,
+                        storage_method,
+                        security_code,
+                        security_code_indicator,
+                        assurance_method)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} number: #{@number}, expiration_month: #{@expiration_month},"\
+      " expiration_year: #{@expiration_year}, type: #{@type}, cryptogram: #{@cryptogram},"\
+      " requestor_id: #{@requestor_id}, transaction_type: #{@transaction_type}, assurance_level:"\
+      " #{@assurance_level}, storage_method: #{@storage_method}, security_code: #{@security_code},"\
+      " security_code_indicator: #{@security_code_indicator}, assurance_method:"\
+      " #{@assurance_method}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} number: #{@number.inspect}, expiration_month: #{@expiration_month.inspect},"\
+      " expiration_year: #{@expiration_year.inspect}, type: #{@type.inspect}, cryptogram:"\
+      " #{@cryptogram.inspect}, requestor_id: #{@requestor_id.inspect}, transaction_type:"\
+      " #{@transaction_type.inspect}, assurance_level: #{@assurance_level.inspect},"\
+      " storage_method: #{@storage_method.inspect}, security_code: #{@security_code.inspect},"\
+      " security_code_indicator: #{@security_code_indicator.inspect}, assurance_method:"\
+      " #{@assurance_method.inspect}>"
+    end
+  end
+end