CnpOnline 9.14.0 → 11.4.0

data/lib/LitleTransaction.rb

@@ -1,6 +1,5 @@
 =begin
 Copyright (c) 2017 Vantiv eCommerce
-
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation
 files (the "Software"), to deal in the Software without
@@ -9,10 +8,8 @@ copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the
 Software is furnished to do so, subject to the following
 conditions:
-
 The above copyright notice and this permission notice shall be
 included in all copies or substantial portions of the Software.
-
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
@@ -25,7 +22,7 @@ OTHER DEALINGS IN THE SOFTWARE.
 require_relative 'Configuration'
 
 #
-# This class does all the heavy lifting of mapping the Ruby hash into Vantiv eCommerce XML format
+# This class does all the heavy lifting of mapping the Ruby hash into Litle XML format
 # It also handles validation looking for missing or incorrect fields
 # contains the methods to properly create each transaction type
 #
@@ -36,14 +33,16 @@ module LitleOnline
       transaction.secondaryAmount = options['secondaryAmount']
       transaction.surchargeAmount    = options['surchargeAmount']
       transaction.recurringRequest   = RecurringRequest.from_hash(options,'recurringRequest')
-      transaction.debtRepayment	     = options['debtRepayment']
-      transaction.advancedFraudChecks = AdvancedFraudChecks.from_hash(options, 'advancedFraudChecks')
-      add_transaction_info(transaction, options)
-      #9.10
+      transaction.debtRepayment      = options['debtRepayment']
+      transaction.advancedFraudChecks= AdvancedFraudChecks.from_hash(options, 'advancedFraudChecks')
+      #SDK XML 11
       transaction.wallet                            = Wallet.from_hash(options, 'wallet')
       transaction.processingType                    = options['processingType']
       transaction.originalNetworkTransactionId      = options['originalNetworkTransactionId']
       transaction.originalTransactionAmount         = options['originalTransactionAmount']
+      
+      add_transaction_info(transaction, options)
+
       return transaction
     end
 
@@ -160,62 +159,131 @@ module LitleOnline
     def activate_reversal(options)
       transaction = ActivateReversal.new
       transaction.litleTxnId = options['litleTxnId']
+      transaction.card = GiftCardCardType.from_hash(options,'card')
+      transaction.originalRefCode = options['originalRefCode']
+      transaction.originalAmount = options['originalAmount']
+      transaction.originalTxnTime = options['originalTxnTime']
+      transaction.originalSystemTraceId = options['originalSystemTraceId']
+      transaction.originalSequenceNumber = options['originalSequenceNumber']
       return transaction
     end
 
     def deposit_reversal(options)
       transaction = DepositReversal.new
       transaction.litleTxnId = options['litleTxnId']
+      transaction.card = GiftCardCardType.from_hash(options,'card')
+      transaction.originalRefCode = options['originalRefCode']
+      transaction.originalAmount = options['originalAmount']
+      transaction.originalTxnTime = options['originalTxnTime']
+      transaction.originalSystemTraceId = options['originalSystemTraceId']
+      transaction.originalSequenceNumber = options['originalSequenceNumber']
+      return transaction
+    end
+    
+    #XML 11.0
+    
+    def giftCardAuth_reversal(options)
+      transaction = GiftCardAuthReversal.new
+      transaction.litleTxnId = options['litleTxnId']
+      transaction.card = GiftCardCardType.from_hash(options,'card')
+      transaction.originalRefCode = options['originalRefCode']
+      transaction.originalAmount = options['originalAmount']
+      transaction.originalTxnTime = options['originalTxnTime']
+      transaction.originalSystemTraceId = options['originalSystemTraceId']
+      transaction.originalSequenceNumber = options['originalSequenceNumber']
+      return transaction
+    end
+    
+     def giftCardCapture(options)
+      transaction = GiftCardCapture.new
+      transaction.litleTxnId = options['litleTxnId']
+      transaction.captureAmount = options['captureAmount']
+      transaction.card = GiftCardCardType.from_hash(options,'card')
+      transaction.originalRefCode = options['originalRefCode']
+      transaction.originalAmount = options['originalAmount']
+      transaction.originalTxnTime = options['originalTxnTime']
+      transaction.originalSystemTraceId = options['originalSystemTraceId']
+      transaction.originalSequenceNumber = options['originalSequenceNumber']
+      return transaction
+    end
+    
+     def giftCardCredit(options)
+      transaction = GiftCardCredit.new
+      transaction.litleTxnId = options['litleTxnId']
+      transaction.creditAmount = options['creditAmount']
+      transaction.orderId = options['orderId']
+      transaction.orderSource = options['orderSource']
+      transaction.card = GiftCardCardType.from_hash(options,'card')
       return transaction
     end
 
     def refund_reversal(options)
       transaction = RefundReversal.new
       transaction.litleTxnId = options['litleTxnId']
+      transaction.card = GiftCardCardType.from_hash(options,'card')
+      transaction.originalRefCode = options['originalRefCode']
+      transaction.originalAmount = options['originalAmount']
+      transaction.originalTxnTime = options['originalTxnTime']
+      transaction.originalSystemTraceId = options['originalSystemTraceId']
+      transaction.originalSequenceNumber = options['originalSequenceNumber']
       return transaction
     end
 
     def deactivate_reversal(options)
       transaction = DeactivateReversal.new
       transaction.litleTxnId = options['litleTxnId']
+      transaction.card = GiftCardCardType.from_hash(options,'card')
+      transaction.originalRefCode = options['originalRefCode']
+      transaction.originalAmount = options['originalAmount']
+      transaction.originalTxnTime = options['originalTxnTime']
+      transaction.originalSystemTraceId = options['originalSystemTraceId']
+      transaction.originalSequenceNumber = options['originalSequenceNumber']
       return transaction
     end
 
     def load_reversal(options)
       transaction = LoadReversal.new
       transaction.litleTxnId = options['litleTxnId']
+      transaction.card = GiftCardCardType.from_hash(options,'card')
+      transaction.originalRefCode = options['originalRefCode']
+      transaction.originalAmount = options['originalAmount']
+      transaction.originalTxnTime = options['originalTxnTime']
+      transaction.originalSystemTraceId = options['originalSystemTraceId']
+      transaction.originalSequenceNumber = options['originalSequenceNumber']
       return transaction
     end
 
     def unload_reversal(options)
       transaction = UnloadReversal.new
       transaction.litleTxnId = options['litleTxnId']
+      transaction.card = GiftCardCardType.from_hash(options,'card')
+      transaction.originalRefCode = options['originalRefCode']
+      transaction.originalAmount = options['originalAmount']
+      transaction.originalTxnTime = options['originalTxnTime']
+      transaction.originalSystemTraceId = options['originalSystemTraceId']
+      transaction.originalSequenceNumber = options['originalSequenceNumber']
       return transaction
     end
 
     def sale(options)
       transaction = Sale.new
       add_transaction_info(transaction, options)
-      transaction.secondaryAmount                   = options['secondaryAmount']
-      transaction.surchargeAmount                   = options['surchargeAmount']
-      transaction.fraudCheck                        = FraudCheck.from_hash(options,'fraudCheck')
-      transaction.payPalOrderComplete               = options['payPalOrderComplete']
-      transaction.payPalNotes                       = options['payPalNotes']
-      transaction.recurringRequest                  = RecurringRequest.from_hash(options,'recurringRequest')
-      transaction.litleInternalRecurringRequest     = LitleInternalRecurringRequest.from_hash(options,'litleInternalRecurringRequest')
-      transaction.debtRepayment	                    = options['debtRepayment']
-      transaction.advancedFraudChecks               = AdvancedFraudChecks.from_hash(options, 'advancedFraudChecks')
-      #9.10
+      transaction.secondaryAmount     = options['secondaryAmount']
+      transaction.surchargeAmount     = options['surchargeAmount']
+      transaction.fraudCheck          = FraudCheck.from_hash(options,'fraudCheck')
+      transaction.payPalOrderComplete = options['payPalOrderComplete']
+      transaction.payPalNotes         = options['payPalNotes']
+      transaction.recurringRequest    = RecurringRequest.from_hash(options,'recurringRequest')
+      transaction.litleInternalRecurringRequest = LitleInternalRecurringRequest.from_hash(options,'litleInternalRecurringRequest')
+      transaction.debtRepayment      = options['debtRepayment']
+      transaction.advancedFraudChecks = AdvancedFraudChecks.from_hash(options, 'advancedFraudChecks')
+      #SDK XML 11
       transaction.wallet                            = Wallet.from_hash(options, 'wallet')
       transaction.processingType                    = options['processingType']
       transaction.originalNetworkTransactionId      = options['originalNetworkTransactionId']
       transaction.originalTransactionAmount         = options['originalTransactionAmount']
-      #9.12
-      transaction.sepaDirectDebit                   = SepaDirectDebitType.from_hash(options,'sepaDirectDebit')
-      transaction.ideal                             = IdealType.from_hash(options,'ideal')
-      #9.14
-      transaction.giropay                            = GiropayType.from_hash(options,'giropay')
-      transaction.sofort                             = SofortType.from_hash(options,'sofort')
+      transaction.sepaDirectDebit                   = SepaDirectDebit.from_hash(options,'sepaDirectDebit')
+          
       return transaction
     end
 
@@ -240,13 +308,12 @@ module LitleOnline
       transaction.enhancedData            = EnhancedData.from_hash(options)
       transaction.processingInstructions  = ProcessingInstructions.from_hash(options)
       transaction.pos                     = Pos.from_hash(options)
-      #9.10
-      transaction.pin                     = options['pin']
-      #9.10 end 
       transaction.billMeLaterRequest      = BillMeLaterRequest.from_hash(options)
       transaction.payPalNotes             = options['payPalNotes']
       transaction.actionReason            = options['actionReason']
       transaction.paypal                  = CreditPayPal.from_hash(options,'paypal')
+      #SDK XML 11
+      transaction.pin                     = options['pin']
 
       add_account_info(transaction, options)
       return transaction
@@ -293,12 +360,13 @@ module LitleOnline
 
     def force_capture(options)
       transaction = ForceCapture.new
-      transaction.secondaryAmount    = options['secondaryAmount']
+      transaction.secondaryAmount = options['secondaryAmount']
       transaction.surchargeAmount    = options['surchargeAmount']
       transaction.customBilling      = CustomBilling.from_hash(options)
-      transaction.debtRepayment	     = options['debtRepayment']
-      #9.10
-      transaction.processingType     = options['processingType']
+      transaction.debtRepayment      = options['debtRepayment']
+      #SDK XML 11
+      transaction.processingType                    = options['processingType']
+      
       add_order_info(transaction, options)
 
       return transaction
@@ -315,7 +383,7 @@ module LitleOnline
       transaction.processingInstructions  = ProcessingInstructions.from_hash(options)
       transaction.payPalOrderComplete     = options['payPalOrderComplete']
       transaction.payPalNotes             = options['payPalNotes']
-      #9.10
+      #SDK XML 11
       transaction.customBilling           = CustomBilling.from_hash(options)
       transaction.pin                     = options['pin']
       
@@ -326,14 +394,14 @@ module LitleOnline
     def capture_given_auth(options)
       transaction = CaptureGivenAuth.new
       add_order_info(transaction, options)
-      transaction.secondaryAmount                   = options['secondaryAmount']
-      transaction.surchargeAmount                   = options['surchargeAmount']
-      transaction.authInformation                   = AuthInformation.from_hash(options)
-      transaction.shipToAddress                     = Contact.from_hash(options,'shipToAddress')
-      transaction.customBilling                     = CustomBilling.from_hash(options)
-      transaction.billMeLaterRequest                = BillMeLaterRequest.from_hash(options)
-      transaction.debtRepayment	                    = options['debtRepayment']
-      #9.10
+      transaction.secondaryAmount    = options['secondaryAmount']
+      transaction.surchargeAmount    = options['surchargeAmount']
+      transaction.authInformation    = AuthInformation.from_hash(options)
+      transaction.shipToAddress      = Contact.from_hash(options,'shipToAddress')
+      transaction.customBilling      = CustomBilling.from_hash(options)
+      transaction.billMeLaterRequest = BillMeLaterRequest.from_hash(options)
+      transaction.debtRepayment      = options['debtRepayment']
+      #SDK XML 11
       transaction.processingType                    = options['processingType']
       transaction.originalNetworkTransactionId      = options['originalNetworkTransactionId']
       transaction.originalTransactionAmount         = options['originalTransactionAmount']
@@ -354,9 +422,9 @@ module LitleOnline
       transaction = EcheckRedeposit.new
       add_echeck(transaction, options)
 
-      transaction.litleTxnId = options['litleTxnId']
-      transaction.merchantData              = MerchantData.from_hash(options)
-
+      transaction.litleTxnId        = options['litleTxnId']
+      transaction.merchantData      = MerchantData.from_hash(options)
+      transaction.customIdentifier  = options['customIdentifier']
       return transaction
     end
 
@@ -380,16 +448,18 @@ module LitleOnline
       transaction.billToAddress = Contact.from_hash(options,'billToAddress')
       add_account_info(transaction, options)
       transaction.merchantData              = MerchantData.from_hash(options)
+      
 
       return transaction
     end
 
     def submerchant_credit(options)
       transaction = SubmerchantCredit.new
-      transaction.fundingSubmerchantId       = options['fundingSubmerchantId']
-      transaction.submerchantName       = options['submerchantName']
-      transaction.fundsTransferId   = options['fundsTransferId']
-      transaction.amount   = options['amount']
+      transaction.fundingSubmerchantId    = options['fundingSubmerchantId']
+      transaction.submerchantName         = options['submerchantName']
+      transaction.fundsTransferId         = options['fundsTransferId']
+      transaction.amount                  = options['amount']
+      transaction.customIdentifier        = options['customIdentifier']
       transaction.accountInfo = Echeck.from_hash(options,'accountInfo')
       add_account_info(transaction, options)
 
@@ -398,10 +468,11 @@ module LitleOnline
 
     def vendor_credit(options)
       transaction = VendorCredit.new
-      transaction.fundingSubmerchantId       = options['fundingSubmerchantId']
-      transaction.vendorName       = options['vendorName']
-      transaction.fundsTransferId   = options['fundsTransferId']
-      transaction.amount   = options['amount']
+      transaction.fundingSubmerchantId    = options['fundingSubmerchantId']
+      transaction.vendorName              = options['vendorName']
+      transaction.fundsTransferId         = options['fundsTransferId']
+      transaction.amount                  = options['amount']
+      
       transaction.accountInfo = Echeck.from_hash(options,'accountInfo')
       add_account_info(transaction, options)
 
@@ -410,9 +481,10 @@ module LitleOnline
 
     def payFac_credit(options)
       transaction = PayFacCredit.new
-      transaction.fundingSubmerchantId       = options['fundingSubmerchantId']
-      transaction.fundsTransferId   = options['fundsTransferId']
-      transaction.amount   = options['amount']
+      transaction.fundingSubmerchantId    = options['fundingSubmerchantId']
+      transaction.fundsTransferId         = options['fundsTransferId']
+      transaction.amount                  = options['amount']
+      
       add_account_info(transaction, options)
 
       return transaction
@@ -420,9 +492,10 @@ module LitleOnline
 
     def reserve_credit(options)
       transaction = ReserveCredit.new
-      transaction.fundingSubmerchantId       = options['fundingSubmerchantId']
-      transaction.fundsTransferId   = options['fundsTransferId']
-      transaction.amount   = options['amount']
+      transaction.fundingSubmerchantId    = options['fundingSubmerchantId']
+      transaction.fundsTransferId         = options['fundsTransferId']
+      transaction.amount                  = options['amount']
+      
       add_account_info(transaction, options)
 
       return transaction
@@ -430,20 +503,46 @@ module LitleOnline
 
     def physical_check_credit(options)
       transaction = PhysicalCheckCredit.new
-      transaction.fundingSubmerchantId       = options['fundingSubmerchantId']
-      transaction.fundsTransferId   = options['fundsTransferId']
-      transaction.amount   = options['amount']
+      transaction.fundingSubmerchantId    = options['fundingSubmerchantId']
+      transaction.fundsTransferId         = options['fundsTransferId']
+      transaction.amount                  = options['amount']
+    
       add_account_info(transaction, options)
 
       return transaction
     end
+    
+    #SDK XML 10
+    
+    def funding_txn_void(options)
+      transaction = FundingInstructionVoid.new
+      transaction.litleTxnId = options['litleTxnId']
+      add_account_info(transaction, options)
+              
+      return transaction
+    end
+    
+    #SDK XML 10
+    def query_Transaction(options)
+      transaction = QueryTransaction.new
+      transaction.origId = options['origId']
+      transaction.origActionType = options['origActionType']
+      transaction.origLitleTxnId = options['origLitleTxnId']
+     # transaction.origOrderId = options['origOrderId']
+     # transaction.origAccountNumber = options['origAccountNumber']
+      add_account_info(transaction, options)
+         
+      return transaction
+    end 
+  
 
     def submerchant_debit(options)
       transaction = SubmerchantDebit.new
-      transaction.fundingSubmerchantId       = options['fundingSubmerchantId']
-      transaction.submerchantName       = options['submerchantName']
-      transaction.fundsTransferId   = options['fundsTransferId']
-      transaction.amount   = options['amount']
+      transaction.fundingSubmerchantId    = options['fundingSubmerchantId']
+      transaction.submerchantName         = options['submerchantName']
+      transaction.fundsTransferId         = options['fundsTransferId']
+      transaction.amount                  = options['amount']
+      transaction.customIdentifier        = options['customIdentifier']
       transaction.accountInfo = Echeck.from_hash(options,'accountInfo')
       add_account_info(transaction, options)
 
@@ -452,10 +551,11 @@ module LitleOnline
 
     def vendor_debit(options)
       transaction = VendorDebit.new
-      transaction.fundingSubmerchantId       = options['fundingSubmerchantId']
-      transaction.vendorName       = options['vendorName']
-      transaction.fundsTransferId   = options['fundsTransferId']
-      transaction.amount   = options['amount']
+      transaction.fundingSubmerchantId    = options['fundingSubmerchantId']
+      transaction.vendorName              = options['vendorName']
+      transaction.fundsTransferId         = options['fundsTransferId']
+      transaction.amount                  = options['amount']
+     
       transaction.accountInfo = Echeck.from_hash(options,'accountInfo')
       add_account_info(transaction, options)
 
@@ -464,9 +564,10 @@ module LitleOnline
 
     def payFac_debit(options)
       transaction = PayFacDebit.new
-      transaction.fundingSubmerchantId       = options['fundingSubmerchantId']
-      transaction.fundsTransferId   = options['fundsTransferId']
-      transaction.amount   = options['amount']
+      transaction.fundingSubmerchantId    = options['fundingSubmerchantId']
+      transaction.fundsTransferId         = options['fundsTransferId']
+      transaction.amount                  = options['amount']
+      
       add_account_info(transaction, options)
 
       return transaction
@@ -474,9 +575,10 @@ module LitleOnline
 
     def reserve_debit(options)
       transaction = ReserveDebit.new
-      transaction.fundingSubmerchantId       = options['fundingSubmerchantId']
-      transaction.fundsTransferId   = options['fundsTransferId']
-      transaction.amount   = options['amount']
+      transaction.fundingSubmerchantId    = options['fundingSubmerchantId']
+      transaction.fundsTransferId         = options['fundsTransferId']
+      transaction.amount                  = options['amount']
+      
       add_account_info(transaction, options)
 
       return transaction
@@ -484,9 +586,10 @@ module LitleOnline
 
     def physical_check_debit(options)
       transaction = PhysicalCheckDebit.new
-      transaction.fundingSubmerchantId       = options['fundingSubmerchantId']
-      transaction.fundsTransferId   = options['fundsTransferId']
-      transaction.amount   = options['amount']
+      transaction.fundingSubmerchantId    = options['fundingSubmerchantId']
+      transaction.fundsTransferId         = options['fundsTransferId']
+      transaction.amount                  = options['amount']
+      
       add_account_info(transaction, options)
 
       return transaction
@@ -500,27 +603,26 @@ module LitleOnline
       transaction.verify        = options['verify']
       transaction.shipToAddress = Contact.from_hash(options,'shipToAddress')
       transaction.customBilling = CustomBilling.from_hash(options)
-
+      transaction.customIdentifier = options['customIdentifier']
       return transaction
     end
 
     def echeck_credit(options)
       transaction = EcheckCredit.new
       transaction.customBilling = CustomBilling.from_hash(options)
+      transaction.litleTxnId    = options['litleTxnId']
       transaction.secondaryAmount = options['secondaryAmount']
+      transaction.customIdentifier = options['customIdentifier']
       add_echeck_order_info(transaction, options)
       add_echeck(transaction, options)
-
       return transaction
     end
 
     def echeck_verification(options)
       transaction = EcheckVerification.new
-
       add_echeck_order_info(transaction, options)
       add_echeck(transaction, options)
       transaction.merchantData = MerchantData.from_hash(options)
-
       return transaction
     end
 
@@ -552,6 +654,27 @@ module LitleOnline
 
       return transaction
     end
+    #11.4 Begin
+
+    def fast_access_funding(options)
+      transaction = FastAccessFunding.new
+      transaction.reportGroup = get_report_group(options)
+      transaction.transactionId = options['id']
+      transaction.customerId = options['customerId']
+
+      transaction.fundingSubmerchantId    = options['fundingSubmerchantId']
+      transaction.submerchantName         = options['submerchantName']
+      transaction.fundsTransferId         = options['fundsTransferId']
+      transaction.amount                  = options['amount']
+
+      transaction.card                    = Card.from_hash(options)
+      transaction.token                   = CardToken.from_hash(options,'token')
+      transaction.paypage                 = CardPaypage.from_hash(options,'paypage')
+
+      return transaction
+    end
+
+    # 11.4 End
 
     private
 
@@ -575,10 +698,14 @@ module LitleOnline
       transaction.fraudFilterOverride       = options['fraudFilterOverride']
       transaction.customBilling             = CustomBilling.from_hash(options)
       transaction.paypal                    = PayPal.from_hash(options,'paypal')
-      transaction.applepay                  = Applepay.from_hash(options,'applepay')
-
+      transaction.applepay                  = Applepay.from_hash(options,'applepay') 
+      
+      
+      #SDK Ruby XML 10
+      transaction.wallet                    = Wallet.from_hash(options, 'wallet')
+      
       add_order_info(transaction, options)
-    end
+    end 
 
     def add_order_info(transaction, options)
       transaction.amount                  = options['amount']
@@ -598,7 +725,7 @@ module LitleOnline
     end
 
     def add_echeck_order_info(transaction, options)
-      transaction.litleTxnId    = options['litleTxnId']
+      #transaction.litleTxnId    = options['litleTxnId']
       transaction.orderId       = options['orderId']
       transaction.amount        = options['amount']
       transaction.orderSource   = options['orderSource']