active_accountability_merchant 1.97.1

data/lib/active_merchant/billing/gateways/linkpoint.rb

@@ -0,0 +1,449 @@
+require 'rexml/document'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    # Initialization Options
+    # :login                Your store number
+    # :pem                  The text of your linkpoint PEM file. Note
+    #                       this is not the path to file, but its
+    #                       contents. If you are only using one PEM
+    #                       file on your site you can declare it
+    #                       globally and then you won't need to
+    #                       include this option
+    #
+    #
+    # A valid store number is required. Unfortunately, with LinkPoint
+    # YOU CAN'T JUST USE ANY OLD STORE NUMBER. Also, you can't just
+    # generate your own PEM file. You'll need to use a special PEM file
+    # provided by LinkPoint.
+    #
+    # Go to http://www.linkpoint.com/support/sup_teststore.asp to set up
+    # a test account and obtain your PEM file.
+    #
+    # Declaring PEM file Globally
+    # ActiveMerchant::Billing::LinkpointGateway.pem_file = File.read( File.dirname(__FILE__) + '/../mycert.pem' )
+    #
+    #
+    # Valid Order Options
+    # :result =>
+    #   LIVE                  Production mode
+    #   GOOD                  Approved response in test mode
+    #   DECLINE               Declined response in test mode
+    #   DUPLICATE             Duplicate response in test mode
+    #
+    # :ponumber               Order number
+    #
+    # :transactionorigin =>   Source of the transaction
+    #    ECI                  Email or Internet
+    #    MAIL                 Mail order
+    #    MOTO                 Mail order/Telephone
+    #    TELEPHONE            Telephone
+    #    RETAIL               Face-to-face
+    #
+    # :ordertype =>
+    #    SALE                 Real live sale
+    #    PREAUTH              Authorize only
+    #    POSTAUTH             Forced Ticket or Ticket Only transaction
+    #    VOID
+    #    CREDIT
+    #    CALCSHIPPING         For shipping charges calculations
+    #    CALCTAX              For sales tax calculations
+    #
+    # Recurring Options
+    # :action =>
+    #    SUBMIT
+    #    MODIFY
+    #    CANCEL
+    #
+    # :installments           Identifies how many recurring payments to charge the customer
+    # :startdate              Date to begin charging the recurring payments. Format: YYYYMMDD or "immediate"
+    # :periodicity  =>
+    #     MONTHLY
+    #     BIMONTHLY
+    #     WEEKLY
+    #     BIWEEKLY
+    #     YEARLY
+    #     DAILY
+    # :threshold              Tells how many times to retry the transaction (if it fails) before contacting the merchant.
+    # :comments               Uh... comments
+    #
+    #
+    # For reference:
+    #
+    # https://www.linkpointcentral.com/lpc/docs/Help/APIHelp/lpintguide.htm
+    #
+    #  Entities = {
+    #    :payment => [:subtotal, :tax, :vattax, :shipping, :chargetotal],
+    #    :billing => [:name, :address1, :address2, :city, :state, :zip, :country, :email, :phone, :fax, :addrnum],
+    #    :shipping => [:name, :address1, :address2, :city, :state, :zip, :country, :weight, :items, :carrier, :total],
+    #    :creditcard => [:cardnumber, :cardexpmonth, :cardexpyear, :cvmvalue, :track],
+    #    :telecheck => [:routing, :account, :checknumber, :bankname, :bankstate, :dl, :dlstate, :void, :accounttype, :ssn],
+    #    :transactiondetails => [:transactionorigin, :oid, :ponumber, :taxexempt, :terminaltype, :ip, :reference_number, :recurring, :tdate],
+    #    :periodic => [:action, :installments, :threshold, :startdate, :periodicity, :comments],
+    #    :notes => [:comments, :referred]
+    #    :items => [:item => [:price, :quantity, :description, :id, :options => [:option => [:name, :value]]]]
+    #  }
+    #
+    #
+    # LinkPoint's Items entity is an optional entity that can be attached to orders.
+    # It is entered as :line_items to be consistent with the CyberSource implementation
+    #
+    # The line_item hash goes in the options hash and should look like
+    #
+    #         :line_items => [
+    #           {
+    #             :id => '123456',
+    #             :description => 'Logo T-Shirt',
+    #             :price => '12.00',
+    #             :quantity => '1',
+    #             :options => [
+    #               {
+    #                 :name => 'Color',
+    #                 :value => 'Red'
+    #               },
+    #               {
+    #                 :name => 'Size',
+    #                 :value => 'XL'
+    #               }
+    #             ]
+    #           },
+    #           {
+    #             :id => '111',
+    #             :description => 'keychain',
+    #             :price => '3.00',
+    #             :quantity => '1'
+    #           }
+    #         ]
+    # This functionality is only supported by this particular gateway may
+    # be changed at any time
+    #
+    class LinkpointGateway < Gateway
+      # Your global PEM file. This will be assigned to you by linkpoint
+      #
+      # Example:
+      #
+      # ActiveMerchant::Billing::LinkpointGateway.pem_file = File.read( File.dirname(__FILE__) + '/../mycert.pem' )
+      #
+      cattr_accessor :pem_file
+
+      self.test_url  = 'https://staging.linkpt.net:1129/'
+      self.live_url  = 'https://secure.linkpt.net:1129/'
+
+      self.supported_countries = ['US']
+      self.supported_cardtypes = [:visa, :master, :american_express, :discover, :jcb, :diners_club]
+      self.homepage_url = 'http://www.linkpoint.com/'
+      self.display_name = 'LinkPoint'
+
+      def initialize(options = {})
+        requires!(options, :login)
+
+        @options = {
+          :result => 'LIVE',
+          :pem => LinkpointGateway.pem_file
+        }.update(options)
+
+        raise ArgumentError, "You need to pass in your pem file using the :pem parameter or set it globally using ActiveMerchant::Billing::LinkpointGateway.pem_file = File.read( File.dirname(__FILE__) + '/../mycert.pem' ) or similar" if @options[:pem].blank?
+
+        @options[:pem].strip!
+      end
+
+      # Send a purchase request with periodic options
+      # Recurring Options
+      # :action =>
+      #    SUBMIT
+      #    MODIFY
+      #    CANCEL
+      #
+      # :installments           Identifies how many recurring payments to charge the customer
+      # :startdate              Date to begin charging the recurring payments. Format: YYYYMMDD or "immediate"
+      # :periodicity  =>
+      #     :monthly
+      #     :bimonthly
+      #     :weekly
+      #     :biweekly
+      #     :yearly
+      #     :daily
+      # :threshold              Tells how many times to retry the transaction (if it fails) before contacting the merchant.
+      # :comments               Uh... comments
+      #
+      def recurring(money, creditcard, options={})
+        ActiveMerchant.deprecated RECURRING_DEPRECATION_MESSAGE
+
+        requires!(options, [:periodicity, :bimonthly, :monthly, :biweekly, :weekly, :yearly, :daily], :installments, :order_id)
+
+        options.update(
+          :ordertype => 'SALE',
+          :action => options[:action] || 'SUBMIT',
+          :installments => options[:installments] || 12,
+          :startdate => options[:startdate] || 'immediate',
+          :periodicity => options[:periodicity].to_s || 'monthly',
+          :comments => options[:comments] || nil,
+          :threshold => options[:threshold] || 3
+        )
+        commit(money, creditcard, options)
+      end
+
+      # Buy the thing
+      def purchase(money, creditcard, options={})
+        requires!(options, :order_id)
+        options.update(
+          :ordertype => 'SALE'
+        )
+        commit(money, creditcard, options)
+      end
+
+      #
+      # Authorize the transaction
+      #
+      # Reserves the funds on the customer's credit card, but does not charge the card.
+      #
+      def authorize(money, creditcard, options = {})
+        requires!(options, :order_id)
+        options.update(
+          :ordertype => 'PREAUTH'
+        )
+        commit(money, creditcard, options)
+      end
+
+      #
+      # Post an authorization.
+      #
+      # Captures the funds from an authorized transaction.
+      # Order_id must be a valid order id from a prior authorized transaction.
+      #
+      def capture(money, authorization, options = {})
+        options.update(
+          :order_id => authorization,
+          :ordertype => 'POSTAUTH'
+        )
+        commit(money, nil, options)
+      end
+
+      # Void a previous transaction
+      def void(identification, options = {})
+        options.update(
+          :order_id => identification,
+          :ordertype => 'VOID'
+        )
+        commit(nil, nil, options)
+      end
+
+      #
+      # Refund an order
+      #
+      # identification must be a valid order id previously submitted by SALE
+      #
+      def refund(money, identification, options = {})
+        options.update(
+          :ordertype => 'CREDIT',
+          :order_id => identification
+        )
+        commit(money, nil, options)
+      end
+
+      def credit(money, identification, options = {})
+        ActiveMerchant.deprecated CREDIT_DEPRECATION_MESSAGE
+        refund(money, identification, options)
+      end
+
+      def supports_scrubbing
+        true
+      end
+
+      def scrub(transcript)
+        transcript.
+          gsub(%r((Authorization: Basic )\w+), '\1[FILTERED]').
+          gsub(%r((<cardnumber>)\d+(</cardnumber>))i, '\1[FILTERED]\2').
+          gsub(%r((<cvmvalue>)\d+(</cvmvalue>))i, '\1[FILTERED]\2')
+      end
+
+      private
+
+      # Commit the transaction by posting the XML file to the LinkPoint server
+      def commit(money, creditcard, options = {})
+        response = parse(ssl_post(test? ? self.test_url : self.live_url, post_data(money, creditcard, options)))
+
+        Response.new(successful?(response), response[:message], response,
+          :test => test?,
+          :authorization => response[:ordernum],
+          :avs_result => { :code => response[:avs].to_s[2, 1] },
+          :cvv_result => response[:avs].to_s[3, 1]
+        )
+      end
+
+      def successful?(response)
+        response[:approved] == 'APPROVED'
+      end
+
+      # Build the XML file
+      def post_data(money, creditcard, options)
+        params = parameters(money, creditcard, options)
+
+        xml = REXML::Document.new
+        order = xml.add_element('order')
+
+        # Merchant Info
+        merchantinfo = order.add_element('merchantinfo')
+        merchantinfo.add_element('configfile').text = @options[:login]
+
+        # Loop over the params hash to construct the XML string
+        for key, value in params
+          elem = order.add_element(key.to_s)
+          if key == :items
+            build_items(elem, value)
+          else
+            for k, _ in params[key]
+              elem.add_element(k.to_s).text = params[key][k].to_s if params[key][k]
+            end
+          end
+          # Linkpoint doesn't understand empty elements:
+          order.delete(elem) if elem.size == 0
+        end
+        return xml.to_s
+      end
+
+      # adds LinkPoint's Items entity to the XML.  Called from post_data
+      def build_items(element, items)
+        for item in items
+          item_element = element.add_element('item')
+          for key, value in item
+            if key == :options
+              options_element = item_element.add_element('options')
+              for option in value
+                opt_element = options_element.add_element('option')
+                opt_element.add_element('name').text =  option[:name]   unless option[:name].blank?
+                opt_element.add_element('value').text =  option[:value]   unless option[:value].blank?
+              end
+            else
+              item_element.add_element(key.to_s).text =  item[key].to_s unless item[key].blank?
+            end
+          end
+        end
+      end
+
+      # Set up the parameters hash just once so we don't have to do it
+      # for every action.
+      def parameters(money, creditcard, options = {})
+        params = {
+          :payment => {
+            :subtotal => amount(options[:subtotal]),
+            :tax => amount(options[:tax]),
+            :vattax => amount(options[:vattax]),
+            :shipping => amount(options[:shipping]),
+            :chargetotal => amount(money)
+          },
+          :transactiondetails => {
+            :transactionorigin => options[:transactionorigin] || 'ECI',
+            :oid => options[:order_id],
+            :ponumber => options[:ponumber],
+            :taxexempt => options[:taxexempt],
+            :terminaltype => options[:terminaltype],
+            :ip => options[:ip],
+            :reference_number => options[:reference_number],
+            :recurring => options[:recurring] || 'NO',  # DO NOT USE if you are using the periodic billing option.
+            :tdate => options[:tdate]
+          },
+          :orderoptions => {
+            :ordertype => options[:ordertype],
+            :result => @options[:result]
+          },
+          :periodic => {
+            :action => options[:action],
+            :installments => options[:installments],
+            :threshold => options[:threshold],
+            :startdate => options[:startdate],
+            :periodicity => options[:periodicity],
+            :comments => options[:comments]
+          },
+          :telecheck => {
+            :routing => options[:telecheck_routing],
+            :account => options[:telecheck_account],
+            :checknumber => options[:telecheck_checknumber],
+            :bankname => options[:telecheck_bankname],
+            :dl => options[:telecheck_dl],
+            :dlstate => options[:telecheck_dlstate],
+            :void => options[:telecheck_void],
+            :accounttype => options[:telecheck_accounttype],
+            :ssn => options[:telecheck_ssn],
+          }
+        }
+
+        if creditcard
+          params[:creditcard] = {
+            :cardnumber => creditcard.number,
+            :cardexpmonth => creditcard.month,
+            :cardexpyear => format_creditcard_expiry_year(creditcard.year),
+            :track => nil
+          }
+
+          if creditcard.verification_value?
+            params[:creditcard][:cvmvalue] = creditcard.verification_value
+            params[:creditcard][:cvmindicator] = 'provided'
+          else
+            params[:creditcard][:cvmindicator] = 'not_provided'
+          end
+        end
+
+        if billing_address = options[:billing_address] || options[:address]
+
+          params[:billing] = {}
+          params[:billing][:name]      = billing_address[:name] || (creditcard ? creditcard.name : nil)
+          params[:billing][:address1]  = billing_address[:address1] unless billing_address[:address1].blank?
+          params[:billing][:address2]  = billing_address[:address2] unless billing_address[:address2].blank?
+          params[:billing][:city]      = billing_address[:city]     unless billing_address[:city].blank?
+          params[:billing][:state]     = billing_address[:state]    unless billing_address[:state].blank?
+          params[:billing][:zip]       = billing_address[:zip]      unless billing_address[:zip].blank?
+          params[:billing][:country]   = billing_address[:country]  unless billing_address[:country].blank?
+          params[:billing][:company]   = billing_address[:company]  unless billing_address[:company].blank?
+          params[:billing][:phone]     = billing_address[:phone]  unless billing_address[:phone].blank?
+          params[:billing][:email]     = options[:email] unless options[:email].blank?
+        end
+
+        if shipping_address = options[:shipping_address]
+
+          params[:shipping] = {}
+          params[:shipping][:name]      = shipping_address[:name] || (creditcard ? creditcard.name : nil)
+          params[:shipping][:address1]  = shipping_address[:address1] unless shipping_address[:address1].blank?
+          params[:shipping][:address2]  = shipping_address[:address2] unless shipping_address[:address2].blank?
+          params[:shipping][:city]      = shipping_address[:city]     unless shipping_address[:city].blank?
+          params[:shipping][:state]     = shipping_address[:state]    unless shipping_address[:state].blank?
+          params[:shipping][:zip]       = shipping_address[:zip]      unless shipping_address[:zip].blank?
+          params[:shipping][:country]   = shipping_address[:country]  unless shipping_address[:country].blank?
+        end
+
+        params[:items] = options[:line_items] if options[:line_items]
+
+        return params
+      end
+
+      def parse(xml)
+        # For reference, a typical response...
+        # <r_csp></r_csp>
+        # <r_time></r_time>
+        # <r_ref></r_ref>
+        # <r_error></r_error>
+        # <r_ordernum></r_ordernum>
+        # <r_message>This is a test transaction and will not show up in the Reports</r_message>
+        # <r_code></r_code>
+        # <r_tdate>Thu Feb 2 15:40:21 2006</r_tdate>
+        # <r_score></r_score>
+        # <r_authresponse></r_authresponse>
+        # <r_approved>APPROVED</r_approved>
+        # <r_avs></r_avs>
+
+        response = {:message => 'Global Error Receipt', :complete => false}
+
+        xml = REXML::Document.new("<response>#{xml}</response>")
+        xml.root&.elements&.each do |node|
+          response[node.name.downcase.sub(/^r_/, '').to_sym] = normalize(node.text)
+        end
+
+        response
+      end
+
+      def format_creditcard_expiry_year(year)
+        sprintf('%.4i', year)[-2..-1]
+      end
+    end
+  end
+end

data/lib/active_merchant/billing/gateways/litle.rb

@@ -0,0 +1,507 @@
+require 'nokogiri'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class LitleGateway < Gateway
+      SCHEMA_VERSION = '9.14'
+
+      self.test_url = 'https://www.testvantivcnp.com/sandbox/communicator/online'
+      self.live_url = 'https://payments.vantivcnp.com/vap/communicator/online'
+
+      self.supported_countries = ['US']
+      self.default_currency = 'USD'
+      self.supported_cardtypes = [:visa, :master, :american_express, :discover, :diners_club, :jcb]
+
+      self.homepage_url = 'http://www.vantiv.com/'
+      self.display_name = 'Vantiv eCommerce'
+
+      def initialize(options={})
+        requires!(options, :login, :password, :merchant_id)
+        super
+      end
+
+      def purchase(money, payment_method, options={})
+        request = build_xml_request do |doc|
+          add_authentication(doc)
+          if check?(payment_method)
+            doc.echeckSale(transaction_attributes(options)) do
+              add_echeck_purchase_params(doc, money, payment_method, options)
+            end
+          else
+            doc.sale(transaction_attributes(options)) do
+              add_auth_purchase_params(doc, money, payment_method, options)
+            end
+          end
+        end
+        check?(payment_method) ? commit(:echeckSales, request, money) : commit(:sale, request, money)
+      end
+
+      def authorize(money, payment_method, options={})
+        request = build_xml_request do |doc|
+          add_authentication(doc)
+          if check?(payment_method)
+            doc.echeckVerification(transaction_attributes(options)) do
+              add_echeck_purchase_params(doc, money, payment_method, options)
+            end
+          else
+            doc.authorization(transaction_attributes(options)) do
+              add_auth_purchase_params(doc, money, payment_method, options)
+            end
+          end
+        end
+        check?(payment_method) ? commit(:echeckVerification, request, money) : commit(:authorization, request, money)
+      end
+
+      def capture(money, authorization, options={})
+        transaction_id, _, _ = split_authorization(authorization)
+
+        request = build_xml_request do |doc|
+          add_authentication(doc)
+          add_descriptor(doc, options)
+          doc.capture_(transaction_attributes(options)) do
+            doc.litleTxnId(transaction_id)
+            doc.amount(money) if money
+          end
+        end
+
+        commit(:capture, request, money)
+      end
+
+      def credit(money, authorization, options = {})
+        ActiveMerchant.deprecated CREDIT_DEPRECATION_MESSAGE
+        refund(money, authorization, options)
+      end
+
+      def refund(money, payment, options={})
+        request = build_xml_request do |doc|
+          add_authentication(doc)
+          add_descriptor(doc, options)
+          doc.send(refund_type(payment), transaction_attributes(options)) do
+            if payment.is_a?(String)
+              transaction_id, _, _ = split_authorization(payment)
+              doc.litleTxnId(transaction_id)
+              doc.amount(money) if money
+            elsif check?(payment)
+              add_echeck_purchase_params(doc, money, payment, options)
+            else
+              add_auth_purchase_params(doc, money, payment, options)
+            end
+          end
+        end
+
+        commit(refund_type(payment), request)
+      end
+
+      def verify(creditcard, options = {})
+        MultiResponse.run(:use_first_response) do |r|
+          r.process { authorize(0, creditcard, options) }
+          r.process(:ignore_result) { void(r.authorization, options) }
+        end
+      end
+
+      def void(authorization, options={})
+        transaction_id, kind, money = split_authorization(authorization)
+
+        request = build_xml_request do |doc|
+          add_authentication(doc)
+          doc.send(void_type(kind), transaction_attributes(options)) do
+            doc.litleTxnId(transaction_id)
+            doc.amount(money) if void_type(kind) == :authReversal
+          end
+        end
+
+        commit(void_type(kind), request)
+      end
+
+      def store(payment_method, options = {})
+        request = build_xml_request do |doc|
+          add_authentication(doc)
+          doc.registerTokenRequest(transaction_attributes(options)) do
+            doc.orderId(truncate(options[:order_id], 24))
+            if payment_method.is_a?(String)
+              doc.paypageRegistrationId(payment_method)
+            elsif check?(payment_method)
+              doc.echeckForToken do
+                doc.accNum(payment_method.account_number)
+                doc.routingNum(payment_method.routing_number)
+              end
+            else
+              doc.accountNumber(payment_method.number)
+              doc.cardValidationNum(payment_method.verification_value) if payment_method.verification_value
+            end
+          end
+        end
+
+        commit(:registerToken, request)
+      end
+
+      def supports_scrubbing?
+        true
+      end
+
+      def scrub(transcript)
+        transcript.
+          gsub(%r((<user>).+(</user>)), '\1[FILTERED]\2').
+          gsub(%r((<password>).+(</password>)), '\1[FILTERED]\2').
+          gsub(%r((<number>).+(</number>)), '\1[FILTERED]\2').
+          gsub(%r((<accNum>).+(</accNum>)), '\1[FILTERED]\2').
+          gsub(%r((<routingNum>).+(</routingNum>)), '\1[FILTERED]\2').
+          gsub(%r((<cardValidationNum>).+(</cardValidationNum>)), '\1[FILTERED]\2').
+          gsub(%r((<accountNumber>).+(</accountNumber>)), '\1[FILTERED]\2').
+          gsub(%r((<paypageRegistrationId>).+(</paypageRegistrationId>)), '\1[FILTERED]\2').
+          gsub(%r((<authenticationValue>).+(</authenticationValue>)), '\1[FILTERED]\2')
+      end
+
+      private
+
+      CARD_TYPE = {
+        'visa'             => 'VI',
+        'master'           => 'MC',
+        'american_express' => 'AX',
+        'discover'         => 'DI',
+        'jcb'              => 'JC',
+        'diners_club'      => 'DC'
+      }
+
+      AVS_RESPONSE_CODE = {
+          '00' => 'Y',
+          '01' => 'X',
+          '02' => 'D',
+          '10' => 'Z',
+          '11' => 'W',
+          '12' => 'A',
+          '13' => 'A',
+          '14' => 'P',
+          '20' => 'N',
+          '30' => 'S',
+          '31' => 'R',
+          '32' => 'U',
+          '33' => 'R',
+          '34' => 'I',
+          '40' => 'E'
+      }
+
+      def void_type(kind)
+        if kind == 'authorization'
+          :authReversal
+        elsif kind == 'echeckSales'
+          :echeckVoid
+        else
+          :void
+        end
+      end
+
+      def refund_type(payment)
+        _, kind, _ = split_authorization(payment)
+        if check?(payment) || kind  == 'echeckSales'
+          :echeckCredit
+        else
+          :credit
+        end
+      end
+
+      def check?(payment_method)
+        return false if payment_method.is_a?(String)
+        card_brand(payment_method) == 'check'
+      end
+
+      def add_authentication(doc)
+        doc.authentication do
+          doc.user(@options[:login])
+          doc.password(@options[:password])
+        end
+      end
+
+      def add_auth_purchase_params(doc, money, payment_method, options)
+        doc.orderId(truncate(options[:order_id], 24))
+        doc.amount(money)
+        add_order_source(doc, payment_method, options)
+        add_billing_address(doc, payment_method, options)
+        add_shipping_address(doc, payment_method, options)
+        add_payment_method(doc, payment_method, options)
+        add_pos(doc, payment_method)
+        add_descriptor(doc, options)
+        add_merchant_data(doc, options)
+        add_debt_repayment(doc, options)
+        add_stored_credential_params(doc, options)
+      end
+
+      def add_merchant_data(doc, options={})
+        if options[:affiliate] || options[:campaign] || options[:merchant_grouping_id]
+          doc.merchantData do
+            doc.affiliate(options[:affiliate]) if options[:affiliate]
+            doc.campaign(options[:campaign]) if options[:campaign]
+            doc.merchantGroupingId(options[:merchant_grouping_id]) if options[:merchant_grouping_id]
+          end
+        end
+      end
+
+      def add_echeck_purchase_params(doc, money, payment_method, options)
+        doc.orderId(truncate(options[:order_id], 24))
+        doc.amount(money)
+        add_order_source(doc, payment_method, options)
+        add_billing_address(doc, payment_method, options)
+        add_payment_method(doc, payment_method, options)
+        add_descriptor(doc, options)
+      end
+
+      def add_descriptor(doc, options)
+        if options[:descriptor_name] || options[:descriptor_phone]
+          doc.customBilling do
+            doc.phone(options[:descriptor_phone]) if options[:descriptor_phone]
+            doc.descriptor(options[:descriptor_name]) if options[:descriptor_name]
+          end
+        end
+      end
+
+      def add_debt_repayment(doc, options)
+        doc.debtRepayment(true) if options[:debt_repayment] == true
+      end
+
+      def add_payment_method(doc, payment_method, options)
+        if payment_method.is_a?(String)
+          doc.token do
+            doc.litleToken(payment_method)
+          end
+        elsif payment_method.respond_to?(:track_data) && payment_method.track_data.present?
+          doc.card do
+            doc.track(payment_method.track_data)
+          end
+        elsif check?(payment_method)
+          doc.echeck do
+            doc.accType(payment_method.account_type.capitalize)
+            doc.accNum(payment_method.account_number)
+            doc.routingNum(payment_method.routing_number)
+            doc.checkNum(payment_method.number)
+          end
+        else
+          doc.card do
+            doc.type_(CARD_TYPE[payment_method.brand])
+            doc.number(payment_method.number)
+            doc.expDate(exp_date(payment_method))
+            doc.cardValidationNum(payment_method.verification_value)
+          end
+          if payment_method.is_a?(NetworkTokenizationCreditCard)
+            doc.cardholderAuthentication do
+              doc.authenticationValue(payment_method.payment_cryptogram)
+            end
+          elsif options[:order_source]&.start_with?('3ds')
+            doc.cardholderAuthentication do
+              doc.authenticationValue(options[:cavv]) if options[:cavv]
+              doc.authenticationTransactionId(options[:xid]) if options[:xid]
+            end
+          end
+        end
+      end
+
+      def add_stored_credential_params(doc, options={})
+        return unless options[:stored_credential]
+
+        if options[:stored_credential][:initial_transaction]
+          add_stored_credential_params_initial(doc, options)
+        else
+          add_stored_credential_params_used(doc, options)
+        end
+      end
+
+      def add_stored_credential_params_initial(doc, options)
+        case options[:stored_credential][:reason_type]
+        when 'unscheduled'
+          doc.processingType('initialCOF')
+        when 'installment'
+          doc.processingType('initialInstallment')
+        when 'recurring'
+          doc.processingType('initialRecurring')
+        end
+      end
+
+      def add_stored_credential_params_used(doc, options)
+        if options[:stored_credential][:reason_type] == 'unscheduled'
+          if options[:stored_credential][:initiator] == 'merchant'
+            doc.processingType('merchantInitiatedCOF')
+          else
+            doc.processingType('cardholderInitiatedCOF')
+          end
+        end
+        doc.originalNetworkTransactionId(options[:stored_credential][:network_transaction_id])
+      end
+
+      def add_billing_address(doc, payment_method, options)
+        return if payment_method.is_a?(String)
+
+        doc.billToAddress do
+          if check?(payment_method)
+            doc.name(payment_method.name)
+            doc.firstName(payment_method.first_name)
+            doc.lastName(payment_method.last_name)
+          else
+            doc.name(payment_method.name)
+          end
+          doc.email(options[:email]) if options[:email]
+
+          add_address(doc, options[:billing_address])
+        end
+      end
+
+      def add_shipping_address(doc, payment_method, options)
+        return if payment_method.is_a?(String)
+
+        doc.shipToAddress do
+          add_address(doc, options[:shipping_address])
+        end
+      end
+
+      def add_address(doc, address)
+        return unless address
+
+        doc.companyName(address[:company]) unless address[:company].blank?
+        doc.addressLine1(address[:address1]) unless address[:address1].blank?
+        doc.addressLine2(address[:address2]) unless address[:address2].blank?
+        doc.city(address[:city]) unless address[:city].blank?
+        doc.state(address[:state]) unless address[:state].blank?
+        doc.zip(address[:zip]) unless address[:zip].blank?
+        doc.country(address[:country]) unless address[:country].blank?
+        doc.phone(address[:phone]) unless address[:phone].blank?
+      end
+
+      def add_order_source(doc, payment_method, options)
+        order_source = order_source(options)
+        if order_source
+          doc.orderSource(order_source)
+        elsif payment_method.is_a?(NetworkTokenizationCreditCard) && payment_method.source == :apple_pay
+          doc.orderSource('applepay')
+        elsif payment_method.is_a?(NetworkTokenizationCreditCard) && payment_method.source == :android_pay
+          doc.orderSource('androidpay')
+        elsif payment_method.respond_to?(:track_data) && payment_method.track_data.present?
+          doc.orderSource('retail')
+        else
+          doc.orderSource('ecommerce')
+        end
+      end
+
+      def order_source(options={})
+        return options[:order_source] unless options[:stored_credential]
+        order_source = nil
+
+        case options[:stored_credential][:reason_type]
+        when 'unscheduled'
+          if options[:stored_credential][:initiator] == 'merchant'
+            # For merchant-initiated, we should always set order source to
+            # 'ecommerce'
+            order_source = 'ecommerce'
+          else
+            # For cardholder-initiated, we rely on #add_order_source's
+            # default logic to set orderSource appropriately
+            order_source = options[:order_source]
+          end
+        when 'installment'
+          order_source = 'installment'
+        when 'recurring'
+          order_source = 'recurring'
+        end
+
+        order_source
+      end
+
+      def add_pos(doc, payment_method)
+        return unless payment_method.respond_to?(:track_data) && payment_method.track_data.present?
+
+        doc.pos do
+          doc.capability('magstripe')
+          doc.entryMode('completeread')
+          doc.cardholderId('signature')
+        end
+      end
+
+      def exp_date(payment_method)
+        "#{format(payment_method.month, :two_digits)}#{format(payment_method.year, :two_digits)}"
+      end
+
+      def parse(kind, xml)
+        parsed = {}
+
+        doc = Nokogiri::XML(xml).remove_namespaces!
+        doc.xpath("//litleOnlineResponse/#{kind}Response/*").each do |node|
+          if node.elements.empty?
+            parsed[node.name.to_sym] = node.text
+          else
+            node.elements.each do |childnode|
+              name = "#{node.name}_#{childnode.name}"
+              parsed[name.to_sym] = childnode.text
+            end
+          end
+        end
+
+        if parsed.empty?
+          %w(response message).each do |attribute|
+            parsed[attribute.to_sym] = doc.xpath('//litleOnlineResponse').attribute(attribute).value
+          end
+        end
+
+        parsed
+      end
+
+      def commit(kind, request, money=nil)
+        parsed = parse(kind, ssl_post(url, request, headers))
+
+        options = {
+          authorization: authorization_from(kind, parsed, money),
+          test: test?,
+          :avs_result => { :code => AVS_RESPONSE_CODE[parsed[:fraudResult_avsResult]] },
+          :cvv_result => parsed[:fraudResult_cardValidationResult]
+        }
+
+        Response.new(success_from(kind, parsed), parsed[:message], parsed, options)
+      end
+
+      def success_from(kind, parsed)
+        return (parsed[:response] == '000') unless kind == :registerToken
+        %w(000 801 802).include?(parsed[:response])
+      end
+
+      def authorization_from(kind, parsed, money)
+        kind == :registerToken ? parsed[:litleToken] : "#{parsed[:litleTxnId]};#{kind};#{money}"
+      end
+
+      def split_authorization(authorization)
+        transaction_id, kind, money = authorization.to_s.split(';')
+        [transaction_id, kind, money]
+      end
+
+      def transaction_attributes(options)
+        attributes = {}
+        attributes[:id] = truncate(options[:id] || options[:order_id], 24)
+        attributes[:reportGroup] = options[:merchant] || 'Default Report Group'
+        attributes[:customerId] = options[:customer]
+        attributes.delete_if { |key, value| value == nil }
+        attributes
+      end
+
+      def root_attributes
+        {
+          merchantId: @options[:merchant_id],
+          version: SCHEMA_VERSION,
+          xmlns: 'http://www.litle.com/schema'
+        }
+      end
+
+      def build_xml_request
+        builder = Nokogiri::XML::Builder.new
+        builder.__send__('litleOnlineRequest', root_attributes) do |doc|
+          yield(doc)
+        end
+        builder.doc.root.to_xml
+      end
+
+      def url
+        test? ? test_url : live_url
+      end
+
+      def headers
+        {
+          'Content-Type' => 'text/xml'
+        }
+      end
+    end
+  end
+end