start_activemerchant 1.50.0

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

@@ -0,0 +1,207 @@
+module ActiveMerchant
+  module Billing
+    class PaywayGateway < Gateway
+      self.live_url = self.test_url = 'https://ccapi.client.qvalent.com/payway/ccapi'
+
+      self.supported_countries = [ 'AU' ]
+      self.supported_cardtypes = [ :visa, :master, :diners_club, :american_express, :bankcard ]
+      self.display_name        = 'Pay Way'
+      self.homepage_url        = 'http://www.payway.com.au'
+      self.default_currency    = 'AUD'
+      self.money_format        = :cents
+
+      SUMMARY_CODES = {
+        '0' => 'Approved',
+        '1' => 'Declined',
+        '2' => 'Erred',
+        '3' => 'Rejected'
+      }
+
+      RESPONSE_CODES= {
+        '00' => 'Completed Successfully',
+        '01' => 'Refer to card issuer',
+        '03' => 'Invalid merchant',
+        '04' => 'Pick-up card',
+        '05' => 'Do not honour',
+        '08' => 'Honour only with identification',
+        '12' => 'Invalid transaction',
+        '13' => 'Invalid amount',
+        '14' => 'Invalid card number (no such number)',
+        '30' => 'Format error',
+        '36' => 'Restricted card',
+        '41' => 'Lost card',
+        '42' => 'No universal card',
+        '43' => 'Stolen card',
+        '51' => 'Not sufficient funds',
+        '54' => 'Expired card',
+        '61' => 'Exceeds withdrawal amount limits',
+        '62' => 'Restricted card',
+        '65' => 'Exceeds withdrawal frequency limit',
+        '91' => 'Issuer or switch is inoperative',
+        '92' => 'Financial institution or intermediate network facility cannot be found for routing',
+        '94' => 'Duplicate transmission',
+        'Q1' => 'Unknown Buyer',
+        'Q2' => 'Transaction Pending',
+        'Q3' => 'Payment Gateway Connection Error',
+        'Q4' => 'Payment Gateway Unavailable',
+        'Q5' => 'Invalid Transaction',
+        'Q6' => 'Duplicate Transaction - requery to determine status',
+        'QA' => 'Invalid parameters or Initialisation failed',
+        'QB' => 'Order type not currently supported',
+        'QC' => 'Invalid Order Type',
+        'QD' => 'Invalid Payment Amount - Payment amount less than minimum/exceeds maximum allowed limit',
+        'QE' => 'Internal Error',
+        'QF' => 'Transaction Failed',
+        'QG' => 'Unknown Customer Order Number',
+        'QH' => 'Unknown Customer Username or Password',
+        'QI' => 'Transaction incomplete - contact Westpac to confirm reconciliation',
+        'QJ' => 'Invalid Client Certificate',
+        'QK' => 'Unknown Customer Merchant',
+        'QL' => 'Business Group not configured for customer',
+        'QM' => 'Payment Instrument not configured for customer',
+        'QN' => 'Configuration Error',
+        'QO' => 'Missing Payment Instrument',
+        'QP' => 'Missing Supplier Account',
+        'QQ' => 'Invalid Credit Card Verification Number',
+        'QR' => 'Transaction Retry',
+        'QS' => 'Transaction Successful',
+        'QT' => 'Invalid currency',
+        'QU' => 'Unknown Customer IP Address',
+        'QV' => 'Invalid Original Order Number specified for Refund, Refund amount exceeds capture amount, or Previous capture was not approved',
+        'QW' => 'Invalid Reference Number',
+        'QX' => 'Network Error has occurred',
+        'QY' => 'Card Type Not Accepted',
+        'QZ' => 'Zero value transaction'
+      }
+
+      TRANSACTIONS  = {
+        :authorize  => 'preauth',
+        :purchase   => 'capture',
+        :capture    => 'captureWithoutAuth',
+        :status     => 'query',
+        :refund     => 'refund',
+        :store      => 'registerAccount'
+      }
+
+      def initialize(options={})
+        @options = options
+
+        @options[:merchant] ||= 'TEST' if test?
+        requires!(options, :username, :password, :merchant, :pem)
+
+        @options[:eci] ||= 'SSL'
+      end
+
+      def authorize(amount, payment_method, options={})
+        requires!(options, :order_id)
+
+        post = {}
+        add_payment_method(post, payment_method)
+        add_order(post, amount, options)
+        commit(:authorize, post)
+      end
+
+      def capture(amount, authorization, options={})
+        requires!(options, :order_id)
+
+        post = {}
+        add_reference(post, authorization)
+        add_order(post, amount, options)
+        commit(:capture, post)
+      end
+
+      def purchase(amount, payment_method, options={})
+        requires!(options, :order_id)
+
+        post = {}
+        add_payment_method(post, payment_method)
+        add_order(post, amount, options)
+        commit(:purchase, post)
+      end
+
+      def refund(amount, authorization, options={})
+        requires!(options, :order_id)
+
+        post = {}
+        add_reference(post, authorization)
+        add_order(post, amount, options)
+        commit(:refund, post)
+      end
+
+      def store(credit_card, options={})
+        requires!(options, :billing_id)
+
+        post = {}
+        add_payment_method(post, credit_card)
+        add_payment_method(post, options[:billing_id])
+        commit(:store, post)
+      end
+
+      def status(options={})
+        requires!(options, :order_id)
+
+        commit(:status, 'customer.orderNumber' => options[:order_id])
+      end
+
+      private
+
+      def add_payment_method(post, payment_method)
+        if payment_method.respond_to?(:number)
+          post['card.cardHolderName'] = "#{payment_method.first_name} #{payment_method.last_name}"
+          post['card.PAN']            = payment_method.number
+          post['card.CVN']            = payment_method.verification_value
+          post['card.expiryYear']     = payment_method.year.to_s[-2,2]
+          post['card.expiryMonth']    = sprintf('%02d', payment_method.month)
+        else
+          post['customer.customerReferenceNumber'] = payment_method
+        end
+      end
+
+      def add_reference(post, reference)
+        post['customer.originalOrderNumber'] = reference
+      end
+
+      def add_order(post, amount, options)
+        post['order.ECI']            = @options[:eci]
+        post['order.amount']         = amount
+        post['card.currency']        = (options[:currency] || currency(amount))
+        post['customer.orderNumber'] = options[:order_id][0...20]
+      end
+
+      def add_auth(post)
+        post['customer.username'] = @options[:username]
+        post['customer.password'] = @options[:password]
+        post['customer.merchant'] = @options[:merchant]
+      end
+
+      # Creates the request and returns the summarized result
+      def commit(action, post)
+        add_auth(post)
+        post.merge!('order.type' => TRANSACTIONS[action])
+
+        request = post.map { |k, v| "#{k}=#{CGI.escape(v.to_s)}" }.join("&")
+        response = ssl_post(self.live_url, request)
+
+        params = {}
+        CGI.parse(response).each_pair do |key, value|
+          actual_key = key.split(".").last
+          params[actual_key.underscore.to_sym] = value[0]
+        end
+
+        message = "#{SUMMARY_CODES[params[:summary_code]]} - #{RESPONSE_CODES[params[:response_code]]}"
+
+        success = (params[:summary_code] ? (params[:summary_code] == "0") : (params[:response_code] == "00"))
+
+        Response.new(success, message, params,
+          :test => (@options[:merchant].to_s == "TEST"),
+          :authorization => post[:order_number]
+        )
+      rescue ActiveMerchant::ResponseError => e
+        raise unless e.response.code == '403'
+        return Response.new(false, "Invalid credentials", {}, :test => test?)
+      rescue ActiveMerchant::ClientCertificateError
+        return Response.new(false, "Invalid certificate", {}, :test => test?)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,207 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class PinGateway < Gateway
+      self.test_url = 'https://test-api.pin.net.au/1'
+      self.live_url = 'https://api.pin.net.au/1'
+
+      self.default_currency = 'AUD'
+      self.money_format = :cents
+      self.supported_countries = ['AU']
+      self.supported_cardtypes = [:visa, :master, :american_express]
+      self.homepage_url = 'http://www.pin.net.au/'
+      self.display_name = 'Pin Payments'
+
+      def initialize(options = {})
+        requires!(options, :api_key)
+        super
+      end
+
+      # Create a charge using a credit card, card token or customer token
+      #
+      # To charge a credit card: purchase([money], [creditcard hash], ...)
+      # To charge a customer: purchase([money], [token], ...)
+      def purchase(money, creditcard, options = {})
+        post = {}
+
+        add_amount(post, money, options)
+        add_customer_data(post, options)
+        add_invoice(post, options)
+        add_creditcard(post, creditcard)
+        add_address(post, creditcard, options)
+        add_capture(post, options)
+
+        commit(:post, 'charges', post, options)
+      end
+
+      # Create a customer and associated credit card. The token that is returned
+      # can be used instead of a credit card parameter in the purchase method
+      def store(creditcard, options = {})
+        post = {}
+
+        add_creditcard(post, creditcard)
+        add_customer_data(post, options)
+        add_address(post, creditcard, options)
+        commit(:post, 'customers', post, options)
+      end
+
+      # Refund a transaction, note that the money attribute is ignored at the
+      # moment as the API does not support partial refunds. The parameter is
+      # kept for compatibility reasons
+      def refund(money, token, options = {})
+        commit(:post, "charges/#{CGI.escape(token)}/refunds", { :amount => amount(money) }, options)
+      end
+
+      # Authorize an amount on a credit card. Once authorized, you can later
+      # capture this charge using the charge token that is returned.
+      def authorize(money, creditcard, options = {})
+        options[:capture] = false
+
+        purchase(money, creditcard, options)
+      end
+
+      # Captures a previously authorized charge. Capturing only part of the original
+      # authorization is currently not supported.
+      def capture(money, token, options = {})
+        commit(:put, "charges/#{CGI.escape(token)}/capture", { :amount => amount(money) }, options)
+      end
+
+      # Updates the credit card for the customer.
+      def update(token, creditcard, options = {})
+        post = {}
+
+        add_creditcard(post, creditcard)
+        add_customer_data(post, options)
+        add_address(post, creditcard, options)
+        commit(:put, "customers/#{CGI.escape(token)}", post, options)
+      end
+
+      private
+
+      def add_amount(post, money, options)
+        post[:amount] = amount(money)
+        post[:currency] = (options[:currency] || currency(money))
+        post[:currency] = post[:currency].upcase if post[:currency]
+      end
+
+      def add_customer_data(post, options)
+        post[:email] = options[:email] if options[:email]
+        post[:ip_address] = options[:ip] if options[:ip]
+      end
+
+      def add_address(post, creditcard, options)
+        return if creditcard.kind_of?(String)
+        address = (options[:billing_address] || options[:address])
+        return unless address
+
+        post[:card] ||= {}
+        post[:card].merge!(
+          :address_line1 => address[:address1],
+          :address_city => address[:city],
+          :address_postcode => address[:zip],
+          :address_state => address[:state],
+          :address_country => address[:country]
+        )
+      end
+
+      def add_invoice(post, options)
+        post[:description] = options[:description] || "Active Merchant Purchase"
+      end
+
+      def add_capture(post, options)
+        capture = options[:capture]
+
+        post[:capture] = capture == false ? false : true
+      end
+
+      def add_creditcard(post, creditcard)
+        if creditcard.respond_to?(:number)
+          post[:card] ||= {}
+
+          post[:card].merge!(
+            :number => creditcard.number,
+            :expiry_month => creditcard.month,
+            :expiry_year => creditcard.year,
+            :cvc => creditcard.verification_value,
+            :name => creditcard.name
+          )
+        elsif creditcard.kind_of?(String)
+          if creditcard =~ /^card_/
+            post[:card_token] = creditcard
+          else
+            post[:customer_token] = creditcard
+          end
+        end
+      end
+
+      def headers(params = {})
+        result = {
+          "Content-Type" => "application/json",
+          "Authorization" => "Basic #{Base64.strict_encode64(options[:api_key] + ':').strip}"
+        }
+
+        result['X-Partner-Key'] = params[:partner_key] if params[:partner_key]
+        result['X-Safe-Card'] = params[:safe_card] if params[:safe_card]
+        result
+      end
+
+      def commit(method, action, params, options)
+        url = "#{test? ? test_url : live_url}/#{action}"
+
+        begin
+          raw_response = ssl_request(method, url, post_data(params), headers(options))
+          body = parse(raw_response)
+        rescue ResponseError => e
+          body = parse(e.response.body)
+        end
+
+        if body["response"]
+          success_response(body)
+        elsif body["error"]
+          error_response(body)
+        end
+
+      rescue JSON::ParserError
+        return unparsable_response(raw_response)
+      end
+
+      def success_response(body)
+        response = body["response"]
+        Response.new(
+          true,
+          response['status_message'],
+          body,
+          :authorization => token(response),
+          :test => test?
+        )
+      end
+
+      def error_response(body)
+        Response.new(
+          false,
+          body['error_description'],
+          body,
+          :authorization => nil,
+          :test => test?
+        )
+      end
+
+      def unparsable_response(raw_response)
+        message = "Invalid JSON response received from Pin Payments. Please contact support@pin.net.au if you continue to receive this message."
+        message += " (The raw response returned by the API was #{raw_response.inspect})"
+        return Response.new(false, message)
+      end
+
+      def token(response)
+        response['token']
+      end
+
+      def parse(body)
+        JSON.parse(body)
+      end
+
+      def post_data(parameters = {})
+        parameters.to_json
+      end
+    end
+  end
+end

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

@@ -0,0 +1,283 @@
+module ActiveMerchant
+  module Billing
+    class PlugnpayGateway < Gateway
+      class PlugnpayPostData < PostData
+        # Fields that will be sent even if they are blank
+        self.required_fields = [ :publisher_name, :publisher_password,
+          :card_amount, :card_name, :card_number, :card_exp, :orderID ]
+      end
+      self.live_url = self.test_url = 'https://pay1.plugnpay.com/payment/pnpremote.cgi'
+
+      CARD_CODE_MESSAGES = {
+        "M" => "Card verification number matched",
+        "N" => "Card verification number didn't match",
+        "P" => "Card verification number was not processed",
+        "S" => "Card verification number should be on card but was not indicated",
+        "U" => "Issuer was not certified for card verification"
+      }
+
+      CARD_CODE_ERRORS = %w( N S )
+
+      AVS_MESSAGES = {
+        "A" => "Street address matches billing information, zip/postal code does not",
+        "B" => "Address information not provided for address verification check",
+        "E" => "Address verification service error",
+        "G" => "Non-U.S. card-issuing bank",
+        "N" => "Neither street address nor zip/postal match billing information",
+        "P" => "Address verification not applicable for this transaction",
+        "R" => "Payment gateway was unavailable or timed out",
+        "S" => "Address verification service not supported by issuer",
+        "U" => "Address information is unavailable",
+        "W" => "9-digit zip/postal code matches billing information, street address does not",
+        "X" => "Street address and 9-digit zip/postal code matches billing information",
+        "Y" => "Street address and 5-digit zip/postal code matches billing information",
+        "Z" => "5-digit zip/postal code matches billing information, street address does not",
+      }
+
+      AVS_ERRORS = %w( A E N R W Z )
+
+      PAYMENT_GATEWAY_RESPONSES = {
+        "P01" => "AVS Mismatch Failure",
+        "P02" => "CVV2 Mismatch Failure",
+        "P21" => "Transaction may not be marked",
+        "P30" => "Test Tran. Bad Card",
+        "P35" => "Test Tran. Problem",
+        "P40" => "Username already exists",
+        "P41" => "Username is blank",
+        "P50" => "Fraud Screen Failure",
+        "P51" => "Missing PIN Code",
+        "P52" => "Invalid Bank Acct. No.",
+        "P53" => "Invalid Bank Routing No.",
+        "P54" => "Invalid/Missing Check No.",
+        "P55" => "Invalid Credit Card No.",
+        "P56" => "Invalid CVV2/CVC2 No.",
+        "P57" => "Expired. CC Exp. Date",
+        "P58" => "Missing Data",
+        "P59" => "Missing Email Address",
+        "P60" => "Zip Code does not match Billing State.",
+        "P61" => "Invalid Billing Zip Code",
+        "P62" => "Zip Code does not match Shipping State.",
+        "P63" => "Invalid Shipping Zip Code",
+        "P64" => "Invalid Credit Card CVV2/CVC2 Format.",
+        "P65" => "Maximum number of attempts has been exceeded.",
+        "P66" => "Credit Card number has been flagged and can not be used to access this service.",
+        "P67" => "IP Address is on Blocked List.",
+        "P68" => "Billing country does not match ipaddress country.",
+        "P69" => "US based ipaddresses are currently blocked.",
+        "P70" => "Credit Cards issued from this bank are currently not being accepted.",
+        "P71" => "Credit Cards issued from this bank are currently not being accepted.",
+        "P72" => "Daily volume exceeded.",
+        "P73" => "Too many transactions within allotted time.",
+        "P91" => "Missing/incorrect password",
+        "P92" => "Account not configured for mobil administration",
+        "P93" => "IP Not registered to username.",
+        "P94" => "Mode not permitted for this account.",
+        "P95" => "Currently Blank",
+        "P96" => "Currently Blank",
+        "P97" => "Processor not responding",
+        "P98" => "Missing merchant/publisher name",
+        "P99" => "Currently Blank"
+      }
+
+      TRANSACTIONS = {
+        :authorization => 'auth',
+        :purchase => 'auth',
+        :capture => 'mark',
+        :void => 'void',
+        :refund => 'return',
+        :credit => 'newreturn'
+      }
+
+      SUCCESS_CODES = [ 'pending', 'success' ]
+      FAILURE_CODES = [ 'badcard', 'fraud' ]
+
+      self.default_currency = 'USD'
+      self.supported_countries = ['US']
+      self.supported_cardtypes = [:visa, :master, :american_express, :discover]
+      self.homepage_url = 'http://www.plugnpay.com/'
+      self.display_name = "Plug'n Pay"
+
+      def initialize(options = {})
+        requires!(options, :login, :password)
+        super
+      end
+
+      def purchase(money, creditcard, options = {})
+        post = PlugnpayPostData.new
+
+        add_amount(post, money, options)
+        add_creditcard(post, creditcard)
+        add_addresses(post, options)
+        add_invoice_data(post, options)
+        add_customer_data(post, options)
+
+        post[:authtype] = 'authpostauth'
+        commit(:authorization, post)
+      end
+
+      def authorize(money, creditcard, options = {})
+        post = PlugnpayPostData.new
+
+        add_amount(post, money, options)
+        add_creditcard(post, creditcard)
+        add_addresses(post, options)
+        add_invoice_data(post, options)
+        add_customer_data(post, options)
+
+        post[:authtype] = 'authonly'
+        commit(:authorization, post)
+      end
+
+      def capture(money, authorization, options = {})
+        post = PlugnpayPostData.new
+
+        post[:orderID] = authorization
+
+        add_amount(post, money, options)
+        add_customer_data(post, options)
+
+        commit(:capture, post)
+      end
+
+      def void(authorization, options = {})
+        post = PlugnpayPostData.new
+
+        post[:orderID] = authorization
+        post[:txn_type] = 'auth'
+
+        commit(:void, post)
+      end
+
+      def credit(money, identification_or_creditcard, options = {})
+        post = PlugnpayPostData.new
+        add_amount(post, money, options)
+
+        if identification_or_creditcard.is_a?(String)
+          ActiveMerchant.deprecated CREDIT_DEPRECATION_MESSAGE
+          refund(money, identification_or_creditcard, options)
+        else
+          add_creditcard(post, identification_or_creditcard)
+          add_addresses(post, options)
+          add_customer_data(post, options)
+
+          commit(:credit, post)
+        end
+      end
+
+      def refund(money, reference, options = {})
+        post = PlugnpayPostData.new
+        add_amount(post, money, options)
+        post[:orderID] = reference
+        commit(:refund, post)
+      end
+
+      private
+      def commit(action, post)
+        response = parse( ssl_post(self.live_url, post_data(action, post)) )
+        success = SUCCESS_CODES.include?(response[:finalstatus])
+        message = success ? 'Success' : message_from(response)
+
+        Response.new(success, message, response,
+          :test => test?,
+          :authorization => response[:orderid],
+          :avs_result => { :code => response[:avs_code] },
+          :cvv_result => response[:cvvresp]
+        )
+      end
+
+      def parse(body)
+        body = CGI.unescape(body)
+        results = {}
+        body.split('&').collect { |e| e.split('=') }.each do |key,value|
+          results[key.downcase.to_sym] = normalize(value.to_s.strip)
+        end
+
+        results.delete(:publisher_password)
+        results[:avs_message] = AVS_MESSAGES[results[:avs_code]] if results[:avs_code]
+        results[:card_code_message] = CARD_CODE_MESSAGES[results[:cvvresp]] if results[:cvvresp]
+
+        results
+      end
+
+      def post_data(action, post)
+        post[:mode]               = TRANSACTIONS[action]
+        post[:convert]            = 'underscores'
+        post[:app_level]          = 0
+        post[:publisher_name]     = @options[:login]
+        post[:publisher_password] = @options[:password]
+
+        post.to_s
+      end
+
+      def add_creditcard(post, creditcard)
+        post[:card_number]  = creditcard.number
+        post[:card_cvv]     = creditcard.verification_value
+        post[:card_exp]     = expdate(creditcard)
+        post[:card_name]    = creditcard.name.slice(0..38)
+      end
+
+      def add_customer_data(post, options)
+        post[:email] = options[:email]
+        post[:dontsndmail]        = 'yes' unless options[:send_email_confirmation]
+        post[:ipaddress] = options[:ip]
+      end
+
+      def add_invoice_data(post, options)
+        post[:shipping] = amount(options[:shipping]) unless options[:shipping].blank?
+        post[:tax] = amount(options[:tax]) unless options[:tax].blank?
+      end
+
+      def add_addresses(post, options)
+        if address = options[:billing_address] || options[:address]
+          post[:card_address1] = address[:address1]
+          post[:card_zip]      = address[:zip]
+          post[:card_city]     = address[:city]
+          post[:card_country]  = address[:country]
+          post[:phone]         = address[:phone]
+
+          case address[:country]
+          when 'US', 'CA'
+            post[:card_state] = address[:state]
+          else
+            post[:card_state] = 'ZZ'
+            post[:card_prov]  = address[:state]
+          end
+        end
+
+        if shipping_address = options[:shipping_address] || address
+          post[:shipname] = shipping_address[:name]
+          post[:address1] = shipping_address[:address1]
+          post[:address2] = shipping_address[:address2]
+          post[:city] = shipping_address[:city]
+
+          case shipping_address[:country]
+          when 'US', 'CA'
+            post[:state] = shipping_address[:state]
+          else
+            post[:state] = 'ZZ'
+            post[:province]  = shipping_address[:state]
+          end
+
+          post[:country] = shipping_address[:country]
+          post[:zip] = shipping_address[:zip]
+        end
+      end
+
+      def add_amount(post, money, options)
+        post[:card_amount] = amount(money)
+        post[:currency] = options[:currency] || currency(money)
+      end
+
+      def message_from(results)
+        PAYMENT_GATEWAY_RESPONSES[results[:resp_code]]
+      end
+
+      def expdate(creditcard)
+        year  = sprintf("%.4i", creditcard.year)
+        month = sprintf("%.2i", creditcard.month)
+
+        "#{month}/#{year[-2..-1]}"
+      end
+    end
+  end
+end