archetype2142_activemerchant 1.124.0

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

@@ -0,0 +1,277 @@
+require 'digest/md5'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    # This gateway accepts the following arguments:
+    #   :login    => your PayJunction username
+    #   :password => your PayJunction pass
+    # Example use:
+    #
+    #   gateway = ActiveMerchant::Billing::Base.gateway(:pay_gate_xml).new(
+    #               :login => "my_account",
+    #               :password => "my_pass"
+    #            )
+    #
+    #   # set up credit card obj as in main ActiveMerchant example
+    #   creditcard = ActiveMerchant::Billing::CreditCard.new(
+    #     :type       => 'visa',
+    #     :number     => '4242424242424242',
+    #     :month      => 8,
+    #     :year       => 2009,
+    #     :first_name => 'Bob',
+    #     :last_name  => 'Bobsen'
+    #   )
+    #
+    #   # run request
+    #   response = gateway.purchase(1000, creditcard) # charge 10 dollars
+    #
+    # 1) Check whether the transaction was successful
+    #
+    #   response.success?
+    #
+    # 2) Retrieve the message returned by PayJunction
+    #
+    #   response.message
+    #
+    # 3) Retrieve the unique transaction ID returned by PayGateXML
+    #
+    #   response.authorization
+    #
+    # This gateway has many other features which are not implemented here yet
+    # The basic setup here only supports auth/capture transactions.
+    #
+    # Test Transactions
+    #
+    # PayGateXML has a global test user/pass, but you can also sign up for your own.
+    # The class and the test come equipped with the global test creds
+    #
+    # Usage Details
+    #
+    # Below is a map of only SOME of the values accepted by PayGateXML and how you should submit
+    # each to ActiveMerchant
+    #
+    # PayGateXML Field        ActiveMerchant Use
+    #
+    # pgid                    use :login value to gateway instantiation
+    # pwd                     use :password value to gateway instantiation
+    #
+    # cname                   credit_card.name
+    # cc                      credit_card.number
+    # exp                     credit_card values formatted to YYYYMMDD
+    # budp                    South Africa only - set to 0 if purchase is not on budget
+    # amt                     include as argument to method for your transaction type
+    # ver                     do nothing, always set to current API version
+    #
+    # cref                    provide as :invoice in options, varchar(80)
+    # cur                     3 char field, currently only ZAR
+    # cvv                     credit_card.verification
+    # bno                     batch processing number, i.e. you supply this
+    #
+    # others -- not used in this implementation
+    # nurl, rurl - must remain blank or absent or they will use an alternative authentication mechanism
+    # email, ip  - must remain blank or absent or they will use a PayGate extra service call PayProtector
+    # threed     - must remain blank unless you are using your own 3D Secure server
+    #
+    class PayGateXmlGateway < Gateway
+      self.live_url = 'https://www.paygate.co.za/payxml/process.trans'
+
+      # The countries the gateway supports merchants from as 2 digit ISO country codes
+      self.supported_countries = %w[US ZA]
+
+      # The card types supported by the payment gateway
+      self.supported_cardtypes = %i[visa master american_express diners_club]
+
+      # The homepage URL of the gateway
+      self.homepage_url = 'http://paygate.co.za/'
+
+      # The name of the gateway
+      self.display_name = 'PayGate PayXML'
+
+      # PayGate only supports Rands
+      self.default_currency = 'ZAR'
+
+      # PayGate accepts only lowest denomination
+      self.money_format = :cents
+
+      # PayGateXML public test account - you can get a private one too
+      TEST_ID_3DSECURE  = '10011013800'
+      TEST_ID           = '10011021600'
+      TEST_PWD          = 'test'
+
+      API_VERSION = '4.0'
+
+      DECLINE_CODES = {
+        # Credit Card Errors - These RESULT_CODEs are returned if the transaction cannot be authorized due to a problem with the card.  The TRANSACTION_STATUS will be 2
+        900001  => 'Call for Approval',
+        900002  => 'Card Expired',
+        900003  => 'Insufficient Funds',
+        900004  => 'Invalid Card Number',
+        900005  => 'Bank Interface Timeout', # indicates a communications failure between the banks systems
+        900006  => 'Invalid Card',
+        900007  => 'Declined',
+        900009  => 'Lost Card',
+        900010  => 'Invalid Card Length',
+        900011  => 'Suspected Fraud',
+        900012  => 'Card Reported As Stolen',
+        900013  => 'Restricted Card',
+        900014  => 'Excessive Card Usage',
+        900015  => 'Card Blacklisted',
+
+        900207  => 'Declined; authentication failed', # indicates the cardholder did not enter their MasterCard SecureCode / Verified by Visa password correctly
+
+        990020  => 'Auth Declined',
+
+        991001  => 'Invalid expiry date',
+        991002  => 'Invalid amount',
+
+        # Communication Errors - These RESULT_CODEs are returned if the transaction cannot be completed due to an unexpected error.  TRANSACTION_STATUS will be 0.
+        900205  => 'Unexpected authentication result (phase 1)',
+        900206  => 'Unexpected authentication result (phase 1)',
+
+        990001  => 'Could not insert into Database',
+
+        990022  => 'Bank not available',
+
+        990053  => 'Error processing transaction',
+
+        # Miscellaneous - Unless otherwise noted, the TRANSACTION_STATUS will be 0.
+        900209  => 'Transaction verification failed (phase 2)', # Indicates the verification data returned from MasterCard SecureCode / Verified by Visa has been altered
+        900210  => 'Authentication complete; transaction must be restarted', # Indicates that the MasterCard SecuerCode / Verified by Visa transaction has already been completed.  Most likely caused by the customer clicking the refresh button
+
+        990024  => 'Duplicate Transaction Detected.  Please check before submitting',
+
+        990028  => 'Transaction cancelled' # Customer clicks the 'Cancel' button on the payment page
+      }
+
+      SUCCESS_CODES = %w(990004 990005 990017 990012 990018 990031)
+
+      TRANSACTION_CODES = {
+        0 => 'Not Done',
+        1 => 'Approved',
+        2 => 'Declined',
+        3 => 'Paid',
+        4 => 'Refunded',
+        5 => 'Received by PayGate',
+        6 => 'Replied to Client'
+      }
+
+      def initialize(options = {})
+        requires!(options, :login, :password)
+        super
+      end
+
+      def purchase(money, creditcard, options = {})
+        MultiResponse.run do |r|
+          r.process { authorize(money, creditcard, options) }
+          r.process { capture(money, r.authorization, options) }
+        end
+      end
+
+      def authorize(money, creditcard, options = {})
+        action = 'authtx'
+
+        options[:money] = money
+        options[:creditcard] = creditcard
+        commit(action, build_request(action, options))
+      end
+
+      def capture(money, authorization, options = {})
+        action = 'settletx'
+
+        options[:money] = money
+        options[:authorization] = authorization
+        commit(action, build_request(action, options), authorization)
+      end
+
+      def refund(money, authorization, options = {})
+        action = 'refundtx'
+
+        options[:money] = money
+        options[:authorization] = authorization
+        commit(action, build_request(action, options))
+      end
+
+      private
+
+      def successful?(response)
+        SUCCESS_CODES.include?(response[:res])
+      end
+
+      def build_request(action, options = {})
+        xml = Builder::XmlMarkup.new
+        xml.instruct!
+
+        xml.tag! 'protocol', ver: API_VERSION, pgid: (test? ? TEST_ID : @options[:login]), pwd: @options[:password] do |protocol|
+          money         = options.delete(:money)
+          authorization = options.delete(:authorization)
+          creditcard    = options.delete(:creditcard)
+          case action
+          when 'authtx'
+            build_authorization(protocol, money, creditcard, options)
+          when 'settletx'
+            build_capture(protocol, money, authorization, options)
+          when 'refundtx'
+            build_refund(protocol, money, authorization, options)
+          else
+            raise 'no action specified for build_request'
+          end
+        end
+
+        xml.target!
+      end
+
+      def build_authorization(xml, money, creditcard, options = {})
+        xml.tag! 'authtx', {
+          cref: options[:order_id],
+          cname: creditcard.name,
+          cc: creditcard.number,
+          exp: "#{format(creditcard.month, :two_digits)}#{format(creditcard.year, :four_digits)}",
+          budp: 0,
+          amt: amount(money),
+          cur: (options[:currency] || currency(money)),
+          cvv: creditcard.verification_value,
+          email: options[:email],
+          ip: options[:ip]
+        }
+      end
+
+      def build_capture(xml, money, authorization, options = {})
+        xml.tag! 'settletx', {
+          tid: authorization
+        }
+      end
+
+      def build_refund(xml, money, authorization, options = {})
+        xml.tag! 'refundtx', {
+          tid: authorization,
+          amt: amount(money)
+        }
+      end
+
+      def parse(action, body)
+        hash  = {}
+        xml   = REXML::Document.new(body)
+
+        response_action = action.gsub(/tx/, 'rx')
+        root  = REXML::XPath.first(xml.root, response_action)
+        # we might have gotten an error
+        root  = REXML::XPath.first(xml.root, 'errorrx') if root.nil?
+        root.attributes.each do |name, value|
+          hash[name.to_sym] = value
+        end
+        hash
+      end
+
+      def commit(action, request, authorization = nil)
+        response = parse(action, ssl_post(self.live_url, request))
+        Response.new(successful?(response), message_from(response), response,
+          test: test?,
+          authorization: authorization || response[:tid])
+      end
+
+      def message_from(response)
+        (response[:rdesc] || response[:edesc])
+      end
+    end
+  end
+end

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

@@ -0,0 +1,213 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class PayHubGateway < Gateway
+      self.live_url = 'https://checkout.payhub.com/transaction/api'
+
+      self.supported_countries = ['US']
+      self.default_currency = 'USD'
+      self.supported_cardtypes = %i[visa master american_express discover]
+
+      self.homepage_url = 'http://www.payhub.com/'
+      self.display_name = 'PayHub'
+
+      CVV_CODE_TRANSLATOR = {
+        'M' => 'CVV matches',
+        'N' => 'CVV does not match',
+        'P' => 'CVV not processed',
+        'S' => 'CVV should have been present',
+        'U' => 'CVV request unable to be processed by issuer'
+      }
+
+      AVS_CODE_TRANSLATOR = {
+        '0' =>  'Approved, Address verification was not requested.',
+        'A' =>  'Approved, Address matches only.',
+        'B' =>  'Address Match. Street Address math for international transaction Postal Code not verified because of incompatible formats (Acquirer sent both street address and Postal Code)',
+        'C' =>  'Serv Unavailable. Street address and Postal Code not verified for international transaction because of incompatible formats (Acquirer sent both street and Postal Code).',
+        'D' =>  'Exact Match, Street Address and Postal Code match for international transaction.',
+        'F' =>  'Exact Match, Street Address and Postal Code match. Applies to UK only.',
+        'G' =>  'Ver Unavailable, Non-U.S. Issuer does not participate.',
+        'I' =>  'Ver Unavailable, Address information not verified for international transaction',
+        'M' =>  'Exact Match, Street Address and Postal Code match for international transaction',
+        'N' =>  'No - Address and ZIP Code does not match',
+        'P' =>  'Zip Match, Postal Codes match for international transaction Street address not verified because of incompatible formats (Acquirer sent both street address and Postal Code).',
+        'R' =>  'Retry - Issuer system unavailable',
+        'S' =>  'Serv Unavailable, Service not supported',
+        'U' =>  'Ver Unavailable, Address unavailable.',
+        'W' =>  'ZIP match - Nine character numeric ZIP match only.',
+        'X' =>  'Exact match, Address and nine-character ZIP match.',
+        'Y' =>  'Exact Match, Address and five character ZIP match.',
+        'Z' =>  'Zip Match, Five character numeric ZIP match only.',
+        '1' =>  'Cardholder name and ZIP match AMEX only.',
+        '2' =>  'Cardholder name, address, and ZIP match AMEX only.',
+        '3' =>  'Cardholder name and address match AMEX only.',
+        '4' =>  'Cardholder name match AMEX only.',
+        '5' =>  'Cardholder name incorrect, ZIP match AMEX only.',
+        '6' =>  'Cardholder name incorrect, address and ZIP match AMEX only.',
+        '7' =>  'Cardholder name incorrect, address match AMEX only.',
+        '8' =>  'Cardholder, all do not match AMEX only.'
+      }
+
+      STANDARD_ERROR_CODE_MAPPING = {
+        '14' => STANDARD_ERROR_CODE[:invalid_number],
+        '80' => STANDARD_ERROR_CODE[:invalid_expiry_date],
+        '82' => STANDARD_ERROR_CODE[:invalid_cvc],
+        '54' => STANDARD_ERROR_CODE[:expired_card],
+        '51' => STANDARD_ERROR_CODE[:card_declined],
+        '05' => STANDARD_ERROR_CODE[:card_declined],
+        '61' => STANDARD_ERROR_CODE[:card_declined],
+        '62' => STANDARD_ERROR_CODE[:card_declined],
+        '65' => STANDARD_ERROR_CODE[:card_declined],
+        '93' => STANDARD_ERROR_CODE[:card_declined],
+        '01' => STANDARD_ERROR_CODE[:call_issuer],
+        '02' => STANDARD_ERROR_CODE[:call_issuer],
+        '04' => STANDARD_ERROR_CODE[:pickup_card],
+        '07' => STANDARD_ERROR_CODE[:pickup_card],
+        '41' => STANDARD_ERROR_CODE[:pickup_card],
+        '43' => STANDARD_ERROR_CODE[:pickup_card]
+      }
+
+      def initialize(options = {})
+        requires!(options, :orgid, :username, :password, :tid)
+
+        super
+      end
+
+      def authorize(amount, creditcard, options = {})
+        post = setup_post('auth')
+        add_creditcard(post, creditcard)
+        add_amount(post, amount)
+        add_address(post, (options[:address] || options[:billing_address]))
+        add_customer_data(post, options)
+
+        commit(post)
+      end
+
+      def purchase(amount, creditcard, options = {})
+        post = setup_post('sale')
+        add_creditcard(post, creditcard)
+        add_amount(post, amount)
+        add_address(post, (options[:address] || options[:billing_address]))
+        add_customer_data(post, options)
+
+        commit(post)
+      end
+
+      def refund(amount, trans_id, options = {})
+        # Attempt a void in case the transaction is unsettled
+        post = setup_post('void')
+        add_reference(post, trans_id)
+        response = commit(post)
+        return response if response.success?
+
+        post = setup_post('refund')
+        add_reference(post, trans_id)
+        commit(post)
+      end
+
+      def capture(amount, trans_id, options = {})
+        post = setup_post('capture')
+
+        add_reference(post, trans_id)
+        add_amount(post, amount)
+
+        commit(post)
+      end
+
+      # No void, as PayHub's void does not work on authorizations
+
+      def verify(creditcard, options = {})
+        authorize(100, creditcard, options)
+      end
+
+      private
+
+      def setup_post(action)
+        post = {}
+        post[:orgid] = @options[:orgid]
+        post[:tid] = @options[:tid]
+        post[:username] = @options[:username]
+        post[:password] = @options[:password]
+        post[:mode] = (test? ? 'demo' : 'live')
+        post[:trans_type] = action
+        post
+      end
+
+      def add_reference(post, trans_id)
+        post[:trans_id] = trans_id
+      end
+
+      def add_customer_data(post, options = {})
+        post[:first_name] = options[:first_name]
+        post[:last_name] = options[:last_name]
+        post[:phone] = options[:phone]
+        post[:email] = options[:email]
+      end
+
+      def add_address(post, address)
+        return unless address
+
+        post[:address1] = address[:address1]
+        post[:address2] = address[:address2]
+        post[:zip] = address[:zip]
+        post[:state] = address[:state]
+        post[:city] = address[:city]
+      end
+
+      def add_amount(post, amount)
+        post[:amount] = amount(amount)
+      end
+
+      def add_creditcard(post, creditcard)
+        post[:cc] = creditcard.number
+        post[:month] = creditcard.month.to_s
+        post[:year] = creditcard.year.to_s
+        post[:cvv] = creditcard.verification_value
+      end
+
+      def parse(body)
+        JSON.parse(body)
+      end
+
+      def commit(post)
+        success = false
+
+        begin
+          raw_response = ssl_post(live_url, post.to_json, { 'Content-Type' => 'application/json' })
+          response = parse(raw_response)
+          success = (response['RESPONSE_CODE'] == '00')
+        rescue ResponseError => e
+          raw_response = e.response.body
+          response = response_error(raw_response)
+        rescue JSON::ParserError
+          response = json_error(raw_response)
+        end
+
+        Response.new(success,
+          response_message(response),
+          response,
+          test: test?,
+          avs_result: { code: response['AVS_RESULT_CODE'] },
+          cvv_result: response['VERIFICATION_RESULT_CODE'],
+          error_code: (success ? nil : STANDARD_ERROR_CODE_MAPPING[response['RESPONSE_CODE']]),
+          authorization: response['TRANSACTION_ID'])
+      end
+
+      def response_error(raw_response)
+        parse(raw_response)
+      rescue JSON::ParserError
+        json_error(raw_response)
+      end
+
+      def json_error(raw_response)
+        {
+          error_message: 'Invalid response received from the Payhub API.  Please contact wecare@payhub.com if you continue to receive this message.' \
+            "  (The raw response returned by the API was #{raw_response.inspect})"
+        }
+      end
+
+      def response_message(response)
+        (response['RESPONSE_TEXT'] || response['RESPONSE_CODE'] || response[:error_message])
+      end
+    end
+  end
+end