class ActiveMerchant::Billing::MerchantWareVersionFourGateway
Constants
- ACTIONS
- ENV_NAMESPACES
- TX_NAMESPACE
Public Class Methods
Creates a new MerchantWareVersionFourGateway
The gateway requires that a valid login, password, and name be passed in the options
hash.
Options¶ ↑
-
:login
- The MerchantWARE SiteID. -
:password
- The MerchantWARE Key. -
:name
- The MerchantWARE Name.
ActiveMerchant::Billing::Gateway::new
# File lib/active_merchant/billing/gateways/merchant_ware_version_four.rb, line 37 def initialize(options = {}) requires!(options, :login, :password, :name) super end
Public Instance Methods
Capture authorized funds from a credit card.
Parameters¶ ↑
-
money
- The amount to be captured as anInteger value in cents. -
authorization
- The authorization string returned from the initial authorization.
# File lib/active_merchant/billing/gateways/merchant_ware_version_four.rb, line 74 def capture(money, authorization, options = {}) request = build_capture_request(:capture, money, authorization, options) commit(:capture, request) end
Authorize and immediately capture funds from a credit card.
Parameters¶ ↑
-
money
- The amount to be authorized as anInteger value in cents. -
payment_source
- TheCreditCard
details or 'token' from prior transaction -
options
-
:order_id
- A unique reference for this order (required). -
:billing_address
- The billing address for the cardholder.
-
# File lib/active_merchant/billing/gateways/merchant_ware_version_four.rb, line 63 def purchase(money, payment_source, options = {}) action = payment_source.is_a?(String) ? :reference_purchase : :purchase request = build_purchase_request(action, money, payment_source, options) commit(action, request) end
Refund an amount back a cardholder
Parameters¶ ↑
-
money
- The amount to be refunded as an Integer value in cents. -
identification
- The credit card you want to refund or the authorization for the existing transaction you are refunding. -
options
-
:order_id
- A unique reference for this order (required when performing a non-referenced credit)
-
# File lib/active_merchant/billing/gateways/merchant_ware_version_four.rb, line 99 def refund(money, identification, options = {}) reference, options[:order_id] = split_reference(identification) request = soap_request(:refund) do |xml| add_reference_token(xml, reference) add_invoice(xml, options) add_amount(xml, money, 'overrideAmount') end commit(:refund, request) end
# File lib/active_merchant/billing/gateways/merchant_ware_version_four.rb, line 122 def scrub(transcript) transcript. gsub(%r((<merchantKey>).+?(</merchantKey>))i, '\1[FILTERED]\2'). gsub(%r((<cardNumber>).+?(</cardNumber>))i, '\1[FILTERED]\2'). gsub(%r((<cardSecurityCode>).+?(</cardSecurityCode>))i, '\1[FILTERED]\2') end
# File lib/active_merchant/billing/gateways/merchant_ware_version_four.rb, line 118 def supports_scrubbing? true end
# File lib/active_merchant/billing/gateways/merchant_ware_version_four.rb, line 111 def verify(credit_card, options={}) MultiResponse.run(:use_first_response) do |r| r.process { authorize(100, credit_card, options) } r.process(:ignore_result) { void(r.authorization, options) } end end
Void a transaction.
Parameters¶ ↑
-
authorization
- The authorization string returned from the initial authorization or purchase.
# File lib/active_merchant/billing/gateways/merchant_ware_version_four.rb, line 83 def void(authorization, options = {}) reference, options[:order_id] = split_reference(authorization) request = soap_request(:void) do |xml| add_reference_token(xml, reference) end commit(:void, request) end
Private Instance Methods
# File lib/active_merchant/billing/gateways/merchant_ware_version_four.rb, line 180 def add_address(xml, options) address = options[:billing_address] || options[:address] || {} xml.tag! 'avsStreetAddress', address[:address1] xml.tag! 'avsStreetZipCode', address[:zip] end
# File lib/active_merchant/billing/gateways/merchant_ware_version_four.rb, line 172 def add_amount(xml, money, tag = 'amount') xml.tag! tag, amount(money) end
# File lib/active_merchant/billing/gateways/merchant_ware_version_four.rb, line 194 def add_credit_card(xml, credit_card) xml.tag! 'cardNumber', credit_card.number xml.tag! 'expirationDate', expdate(credit_card) xml.tag! 'cardholder', credit_card.name xml.tag! 'cardSecurityCode', credit_card.verification_value if credit_card.verification_value? end
# File lib/active_merchant/billing/gateways/merchant_ware_version_four.rb, line 168 def add_invoice(xml, options) xml.tag! 'invoiceNumber', truncate(options[:order_id].to_s.gsub(/[^\w]/, ''), 8) end
# File lib/active_merchant/billing/gateways/merchant_ware_version_four.rb, line 186 def add_payment_source(xml, source) if source.is_a?(String) add_reference_token(xml, source) else add_credit_card(xml, source) end end
# File lib/active_merchant/billing/gateways/merchant_ware_version_four.rb, line 176 def add_reference_token(xml, reference) xml.tag! 'token', reference end
# File lib/active_merchant/billing/gateways/merchant_ware_version_four.rb, line 158 def build_capture_request(action, money, identification, options) reference, options[:order_id] = split_reference(identification) soap_request(action) do |xml| add_reference_token(xml, reference) add_invoice(xml, options) add_amount(xml, money) end end
# File lib/active_merchant/billing/gateways/merchant_ware_version_four.rb, line 147 def build_purchase_request(action, money, payment_source, options) requires!(options, :order_id) soap_request(action) do |xml| add_invoice(xml, options) add_amount(xml, money) add_payment_source(xml, payment_source) add_address(xml, options) end end
# File lib/active_merchant/billing/gateways/merchant_ware_version_four.rb, line 262 def commit(action, request) begin data = ssl_post(url, request, 'Content-Type' => 'text/xml; charset=utf-8', 'SOAPAction' => soap_action(action) ) response = parse(action, data) rescue ActiveMerchant::ResponseError => e response = parse_error(e.response, action) end Response.new(response[:success], response[:message], response, :test => test?, :authorization => authorization_from(response), :avs_result => { :code => response['AvsResponse'] }, :cvv_result => response['CvResponse'] ) end
# File lib/active_merchant/billing/gateways/merchant_ware_version_four.rb, line 205 def parse(action, data) response = {} xml = REXML::Document.new(data) root = REXML::XPath.first(xml, "//#{ACTIONS[action]}Response/#{ACTIONS[action]}Result") root.elements.each do |element| response[element.name] = element.text end if response['ErrorMessage'].present? response[:message] = response['ErrorMessage'] response[:success] = false else status, code, message = response['ApprovalStatus'].split(';') response[:status] = status if response[:success] = status == 'APPROVED' response[:message] = status else response[:message] = message response[:failure_code] = code end end response end
# File lib/active_merchant/billing/gateways/merchant_ware_version_four.rb, line 233 def parse_error(http_response, action) response = {} response[:http_code] = http_response.code response[:http_message] = http_response.message response[:success] = false document = REXML::Document.new(http_response.body) node = REXML::XPath.first(document, "//#{ACTIONS[action]}Response/#{ACTIONS[action]}Result") node.elements.each do |element| response[element.name] = element.text end response[:message] = response['ErrorMessage'].to_s.gsub("\n", ' ') response rescue REXML::ParseException response[:http_body] = http_response.body response[:message] = 'Failed to parse the failed response' response end
# File lib/active_merchant/billing/gateways/merchant_ware_version_four.rb, line 254 def soap_action(action) "#{TX_NAMESPACE}#{ACTIONS[action]}" end
# File lib/active_merchant/billing/gateways/merchant_ware_version_four.rb, line 131 def soap_request(action) xml = Builder::XmlMarkup.new :indent => 2 xml.instruct! xml.tag! 'soap:Envelope', ENV_NAMESPACES do xml.tag! 'soap:Body' do xml.tag! ACTIONS[action], 'xmlns' => TX_NAMESPACE do xml.tag! 'merchantName', @options[:name] xml.tag! 'merchantSiteId', @options[:login] xml.tag! 'merchantKey', @options[:password] yield xml end end end xml.target! end
# File lib/active_merchant/billing/gateways/merchant_ware_version_four.rb, line 201 def split_reference(reference) reference.to_s.split(';') end
# File lib/active_merchant/billing/gateways/merchant_ware_version_four.rb, line 258 def url test? ? test_url : live_url end