CnpOnline 8.31.1 → 9.14.0

data/lib/LitleTransaction.rb

@@ -1,5 +1,5 @@
 =begin
-Copyright (c) 2011 Litle & Co.
+Copyright (c) 2017 Vantiv eCommerce
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation
@@ -25,12 +25,11 @@ OTHER DEALINGS IN THE SOFTWARE.
 require_relative 'Configuration'
 
 #
-# This class does all the heavy lifting of mapping the Ruby hash into Litle XML format
+# This class does all the heavy lifting of mapping the Ruby hash into Vantiv eCommerce XML format
 # It also handles validation looking for missing or incorrect fields
 # contains the methods to properly create each transaction type
 #
 module LitleOnline
-
   class LitleTransaction
     def authorization(options)
       transaction = Authorization.new
@@ -39,11 +38,12 @@ module LitleOnline
       transaction.recurringRequest   = RecurringRequest.from_hash(options,'recurringRequest')
       transaction.debtRepayment	     = options['debtRepayment']
       transaction.advancedFraudChecks = AdvancedFraudChecks.from_hash(options, 'advancedFraudChecks')
-      transaction.processingType = options['processingType']
-      transaction.originalNetworkTransactionId = options['originalNetworkTransactionId']
-      transaction.originalTransactionAmount = options['originalTransactionAmount']
       add_transaction_info(transaction, options)
-      
+      #9.10
+      transaction.wallet                            = Wallet.from_hash(options, 'wallet')
+      transaction.processingType                    = options['processingType']
+      transaction.originalNetworkTransactionId      = options['originalNetworkTransactionId']
+      transaction.originalTransactionAmount         = options['originalTransactionAmount']
       return transaction
     end
 
@@ -52,49 +52,49 @@ module LitleOnline
       transaction.subscriptionId = options['subscriptionId']
       return transaction
     end
-   
+
     def activate(options)
-       transaction = Activate.new
-       transaction.orderId = options['orderId']
-       transaction.orderSource = options['orderSource']
-       transaction.amount = options['amount']
-       transaction.card = Card.from_hash(options,'card')
-       transaction.virtualGiftCard = VirtualGiftCard.from_hash(options,'virtualGiftCard')
-       return transaction
-    end	
+      transaction = Activate.new
+      transaction.orderId = options['orderId']
+      transaction.orderSource = options['orderSource']
+      transaction.amount = options['amount']
+      transaction.card = Card.from_hash(options,'card')
+      transaction.virtualGiftCard = VirtualGiftCard.from_hash(options,'virtualGiftCard')
+      return transaction
+    end
 
     def deactivate(options)
-       transaction = Deactivate.new
-       transaction.orderId = options['orderId']
-       transaction.orderSource = options['orderSource']
-       transaction.card = Card.from_hash(options,'card')
-       return transaction
+      transaction = Deactivate.new
+      transaction.orderId = options['orderId']
+      transaction.orderSource = options['orderSource']
+      transaction.card = Card.from_hash(options,'card')
+      return transaction
     end
 
     def load_request(options)
-       transaction = Load.new
-       transaction.orderId = options['orderId']
-       transaction.orderSource = options['orderSource']
-       transaction.amount = options['amount']
-       transaction.card = Card.from_hash(options,'card')
-       return transaction
+      transaction = Load.new
+      transaction.orderId = options['orderId']
+      transaction.orderSource = options['orderSource']
+      transaction.amount = options['amount']
+      transaction.card = Card.from_hash(options,'card')
+      return transaction
     end
 
     def unload_request(options)
-       transaction = Unload.new
-       transaction.orderId = options['orderId']
-       transaction.orderSource = options['orderSource']
-       transaction.amount = options['amount']
-       transaction.card = Card.from_hash(options,'card')
-       return transaction
+      transaction = Unload.new
+      transaction.orderId = options['orderId']
+      transaction.orderSource = options['orderSource']
+      transaction.amount = options['amount']
+      transaction.card = Card.from_hash(options,'card')
+      return transaction
     end
 
     def balance_inquiry(options)
-       transaction = BalanceInquiry.new
-       transaction.orderId = options['orderId']
-       transaction.orderSource = options['orderSource']
-       transaction.card = Card.from_hash(options,'card')
-       return transaction
+      transaction = BalanceInquiry.new
+      transaction.orderId = options['orderId']
+      transaction.orderSource = options['orderSource']
+      transaction.card = Card.from_hash(options,'card')
+      return transaction
     end
 
     def update_subscription(options)
@@ -108,106 +108,114 @@ module LitleOnline
       transaction.token                 = CardToken.from_hash(options,'token')
       transaction.paypage               = CardPaypage.from_hash(options,'paypage')
       if(options['createDiscount'])
-          options['createDiscount'].each_index {| index | transaction.createDiscount << CreateDiscount.from_hash(options, index,'createDiscount')}
-        end
+        options['createDiscount'].each_index {| index | transaction.createDiscount << CreateDiscount.from_hash(options, index,'createDiscount')}
+      end
       if(options['updateDiscount'])
-          options['updateDiscount'].each_index {| index | transaction.updateDiscount << UpdateDiscount.from_hash(options, index,'updateDiscount')}
-        end
+        options['updateDiscount'].each_index {| index | transaction.updateDiscount << UpdateDiscount.from_hash(options, index,'updateDiscount')}
+      end
       if(options['deleteDiscount'])
-          options['deleteDiscount'].each_index {| index | transaction.deleteDiscount << DeleteDiscount.from_hash(options, index,'deleteDiscount')}
-        end
+        options['deleteDiscount'].each_index {| index | transaction.deleteDiscount << DeleteDiscount.from_hash(options, index,'deleteDiscount')}
+      end
       if(options['createAddOn'])
-          options['createAddOn'].each_index {| index | transaction.createAddOn << CreateAddOn.from_hash(options, index,'createAddOn')}
-        end
+        options['createAddOn'].each_index {| index | transaction.createAddOn << CreateAddOn.from_hash(options, index,'createAddOn')}
+      end
       if(options['updateAddOn'])
-          options['updateAddOn'].each_index {| index | transaction.updateAddOn << UpdateAddOn.from_hash(options, index,'updateAddOn')}
-        end
+        options['updateAddOn'].each_index {| index | transaction.updateAddOn << UpdateAddOn.from_hash(options, index,'updateAddOn')}
+      end
       if(options['deleteAddOn'])
-          options['deleteAddOn'].each_index {| index | transaction.deleteAddOn << DeleteAddOn.from_hash(options, index,'deleteAddOn')}
-        end 
+        options['deleteAddOn'].each_index {| index | transaction.deleteAddOn << DeleteAddOn.from_hash(options, index,'deleteAddOn')}
+      end
 
-      return transaction 
+      return transaction
     end
 
     def create_plan(options)
-     transaction = CreatePlan.new
-     transaction.planCode = options['planCode']
-     transaction.name=options['name']
-     transaction.description=options['description']
-     transaction.intervalType=options['intervalType']
-     transaction.amount=options['amount']
-     transaction.numberOfPayments=options['numberOfPayments']
-     transaction.trialNumberOfIntervals=options['trialNumberOfIntervals']
-     transaction.trialIntervalType=options['trialIntervalType']
-     transaction.active=options['active']
-     return transaction 
+      transaction = CreatePlan.new
+      transaction.planCode = options['planCode']
+      transaction.name=options['name']
+      transaction.description=options['description']
+      transaction.intervalType=options['intervalType']
+      transaction.amount=options['amount']
+      transaction.numberOfPayments=options['numberOfPayments']
+      transaction.trialNumberOfIntervals=options['trialNumberOfIntervals']
+      transaction.trialIntervalType=options['trialIntervalType']
+      transaction.active=options['active']
+      return transaction
     end
 
     def update_plan(options)
-     transaction = UpdatePlan.new
-     transaction.planCode = options['planCode']
-     transaction.active=options['active']
-     return transaction 
+      transaction = UpdatePlan.new
+      transaction.planCode = options['planCode']
+      transaction.active=options['active']
+      return transaction
     end
 
     def virtual_giftcard(options)
-     transaction = VirtualGiftCard.new     
-     transaction.accountNumberLength = options['accountNumberLength']     
-     transaction.giftCardBin = options['giftCardBin']
-     return transaction
+      transaction = VirtualGiftCard.new
+      transaction.accountNumberLength = options['accountNumberLength']
+      transaction.giftCardBin = options['giftCardBin']
+      return transaction
     end
-   
+
     def activate_reversal(options)
       transaction = ActivateReversal.new
       transaction.litleTxnId = options['litleTxnId']
       return transaction
-    end 
+    end
 
     def deposit_reversal(options)
       transaction = DepositReversal.new
       transaction.litleTxnId = options['litleTxnId']
       return transaction
-    end 
+    end
 
     def refund_reversal(options)
       transaction = RefundReversal.new
       transaction.litleTxnId = options['litleTxnId']
       return transaction
-    end 
+    end
 
     def deactivate_reversal(options)
       transaction = DeactivateReversal.new
       transaction.litleTxnId = options['litleTxnId']
       return transaction
-    end 
+    end
 
     def load_reversal(options)
       transaction = LoadReversal.new
       transaction.litleTxnId = options['litleTxnId']
       return transaction
-    end 
+    end
 
     def unload_reversal(options)
       transaction = UnloadReversal.new
       transaction.litleTxnId = options['litleTxnId']
       return transaction
-    end 
+    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')
-      transaction.processingType = options['processingType']
-      transaction.originalNetworkTransactionId = options['originalNetworkTransactionId']
-      transaction.originalTransactionAmount = options['originalTransactionAmount']
+      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.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')
       return transaction
     end
 
@@ -223,7 +231,7 @@ module LitleOnline
         transaction.card                  = Card.from_hash(options)
         transaction.token                 = CardToken.from_hash(options,'token')
         transaction.paypage               = CardPaypage.from_hash(options,'paypage')
-        transaction.mpos                  = Mpos.from_hash(options,'mpos') 
+        transaction.mpos                  = Mpos.from_hash(options,'mpos')
       end
       transaction.amount                  = options['amount']
       transaction.secondaryAmount         = options['secondaryAmount']
@@ -232,15 +240,18 @@ 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')
-      
+
       add_account_info(transaction, options)
       return transaction
     end
-    
+
     def auth_reversal(options)
       transaction = AuthReversal.new
 
@@ -249,7 +260,7 @@ module LitleOnline
       transaction.surchargeAmount = options['surchargeAmount']
       transaction.payPalNotes     = options['payPalNotes']
       transaction.actionReason    = options['actionReason']
-      
+
       add_account_info(transaction, options)
       return transaction
     end
@@ -265,28 +276,29 @@ module LitleOnline
       add_account_info(transaction, options)
       return transaction
     end
-    
+
     def update_card_validation_num_on_token(options)
       transaction = UpdateCardValidationNumOnToken.new
-      
+
       transaction.orderId               = options['orderId']
       transaction.litleToken            = options['litleToken']
       transaction.cardValidationNum     = options['cardValidationNum']
-      
+
       SchemaValidation.validate_length(transaction.litleToken, true, 13, 25, "updateCardValidationNumOnToken", "litleToken")
       SchemaValidation.validate_length(transaction.cardValidationNum, true, 1, 4, "updateCardValidationNumOnToken", "cardValidationNum")
-      
+
       add_account_info(transaction, options)
       return transaction
     end
 
     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']
-      transaction.processingType	     = options['processingType']
+      #9.10
+      transaction.processingType     = options['processingType']
       add_order_info(transaction, options)
 
       return transaction
@@ -303,8 +315,10 @@ module LitleOnline
       transaction.processingInstructions  = ProcessingInstructions.from_hash(options)
       transaction.payPalOrderComplete     = options['payPalOrderComplete']
       transaction.payPalNotes             = options['payPalNotes']
-      transaction.customBilling           = options['customBilling']
-
+      #9.10
+      transaction.customBilling           = CustomBilling.from_hash(options)
+      transaction.pin                     = options['pin']
+      
       add_account_info(transaction, options)
       return transaction
     end
@@ -312,16 +326,17 @@ 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']
-      transaction.processingType = options['processingType']
-      transaction.originalNetworkTransactionId = options['originalNetworkTransactionId']
-      transaction.originalTransactionAmount = options['originalTransactionAmount']
+      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.processingType                    = options['processingType']
+      transaction.originalNetworkTransactionId      = options['originalNetworkTransactionId']
+      transaction.originalTransactionAmount         = options['originalTransactionAmount']
       return transaction
     end
 
@@ -330,7 +345,7 @@ module LitleOnline
 
       transaction.litleTxnId             = options['litleTxnId']
       transaction.processingInstructions = ProcessingInstructions.from_hash(options)
-      
+
       add_account_info(transaction, options)
       return transaction
     end
@@ -345,6 +360,138 @@ module LitleOnline
       return transaction
     end
 
+    def echeck_pre_note_sale(options)
+      transaction = EcheckPreNoteSale.new
+      transaction.echeck = Echeck.from_hash(options)
+      transaction.orderId       = options['orderId']
+      transaction.orderSource   = options['orderSource']
+      transaction.billToAddress = Contact.from_hash(options,'billToAddress')
+      add_account_info(transaction, options)
+      transaction.merchantData              = MerchantData.from_hash(options)
+
+      return transaction
+    end
+
+    def echeck_pre_note_credit(options)
+      transaction = EcheckPreNoteCredit.new
+      transaction.echeck = Echeck.from_hash(options)
+      transaction.orderId       = options['orderId']
+      transaction.orderSource   = options['orderSource']
+      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.accountInfo = Echeck.from_hash(options,'accountInfo')
+      add_account_info(transaction, options)
+
+      return transaction
+    end
+
+    def vendor_credit(options)
+      transaction = VendorCredit.new
+      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)
+
+      return transaction
+    end
+
+    def payFac_credit(options)
+      transaction = PayFacCredit.new
+      transaction.fundingSubmerchantId       = options['fundingSubmerchantId']
+      transaction.fundsTransferId   = options['fundsTransferId']
+      transaction.amount   = options['amount']
+      add_account_info(transaction, options)
+
+      return transaction
+    end
+
+    def reserve_credit(options)
+      transaction = ReserveCredit.new
+      transaction.fundingSubmerchantId       = options['fundingSubmerchantId']
+      transaction.fundsTransferId   = options['fundsTransferId']
+      transaction.amount   = options['amount']
+      add_account_info(transaction, options)
+
+      return transaction
+    end
+
+    def physical_check_credit(options)
+      transaction = PhysicalCheckCredit.new
+      transaction.fundingSubmerchantId       = options['fundingSubmerchantId']
+      transaction.fundsTransferId   = options['fundsTransferId']
+      transaction.amount   = options['amount']
+      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.accountInfo = Echeck.from_hash(options,'accountInfo')
+      add_account_info(transaction, options)
+
+      return transaction
+    end
+
+    def vendor_debit(options)
+      transaction = VendorDebit.new
+      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)
+
+      return transaction
+    end
+
+    def payFac_debit(options)
+      transaction = PayFacDebit.new
+      transaction.fundingSubmerchantId       = options['fundingSubmerchantId']
+      transaction.fundsTransferId   = options['fundsTransferId']
+      transaction.amount   = options['amount']
+      add_account_info(transaction, options)
+
+      return transaction
+    end
+
+    def reserve_debit(options)
+      transaction = ReserveDebit.new
+      transaction.fundingSubmerchantId       = options['fundingSubmerchantId']
+      transaction.fundsTransferId   = options['fundsTransferId']
+      transaction.amount   = options['amount']
+      add_account_info(transaction, options)
+
+      return transaction
+    end
+
+    def physical_check_debit(options)
+      transaction = PhysicalCheckDebit.new
+      transaction.fundingSubmerchantId       = options['fundingSubmerchantId']
+      transaction.fundsTransferId   = options['fundsTransferId']
+      transaction.amount   = options['amount']
+      add_account_info(transaction, options)
+
+      return transaction
+    end
+
     def echeck_sale(options)
       transaction = EcheckSale.new
       add_echeck(transaction, options)
@@ -380,30 +527,40 @@ module LitleOnline
     def echeck_void(options)
       transaction = EcheckVoid.new
       transaction.litleTxnId = options['litleTxnId']
-      
+
       add_account_info(transaction, options)
       return transaction
     end
-    
+
     def account_update(options)
       transaction = AccountUpdate.new
       transaction.card = Card.from_hash(options)
       transaction.token = CardToken.from_hash(options,'token')
       transaction.orderId = options['orderId']
-      
+
       add_account_info(transaction, options)
-      
+
       return transaction
     end
-    
+
+    def fraud_check_request(options)
+      transaction = FraudCheckRequest.new
+      transaction.advancedFraudChecks = AdvancedFraudChecks.from_hash(options,'advancedFraudChecks')
+      transaction.transactionId = options["id"]
+
+      add_account_info(transaction, options)
+
+      return transaction
+    end
+
     private
-    
+
     def add_account_info(transaction, options)
       transaction.reportGroup   = get_report_group(options)
       transaction.transactionId = options['id']
       transaction.customerId    = options['customerId']
     end
-    
+
     def add_transaction_info(transaction, options)
       transaction.litleTxnId                = options['litleTxnId']
       transaction.customerInfo              = CustomerInfo.from_hash(options)
@@ -451,13 +608,13 @@ module LitleOnline
     def add_echeck(transaction, options)
       transaction.echeck      = Echeck.from_hash(options)
       transaction.echeckToken = EcheckToken.from_hash(options)
-      
+
       add_account_info(transaction, options)
     end
-    
+
     def get_report_group(options)
       #options['reportGroup'] || @config_hash['default_report_group']
       options['reportGroup']
     end
-  end    
+  end
 end