Class: ActiveMerchant::Billing::MerchantWareGateway

Inherits:
Gateway
  • Object
show all
Defined in:
lib/active_merchant/billing/gateways/merchant_ware.rb

Constant Summary collapse

ENV_NAMESPACES = 
{ 'xmlns:xsi'  => 'http://www.w3.org/2001/XMLSchema-instance',
'xmlns:xsd'  => 'http://www.w3.org/2001/XMLSchema',
'xmlns:env' => 'http://schemas.xmlsoap.org/soap/envelope/' }
ENV_NAMESPACES_V4 = 
{ 'xmlns:xsi'  => 'http://www.w3.org/2001/XMLSchema-instance',
'xmlns:xsd'  => 'http://www.w3.org/2001/XMLSchema',
'xmlns:soap' => 'http://schemas.xmlsoap.org/soap/envelope/' }
TX_NAMESPACE = 
'http://merchantwarehouse.com/MerchantWARE/Client/TransactionRetail'
TX_NAMESPACE_V4 = 
'http://schemas.merchantwarehouse.com/merchantware/40/Credit/'
ACTIONS = 
{
  purchase: 'IssueKeyedSale',
  authorize: 'IssueKeyedPreAuth',
  capture: 'IssuePostAuth',
  void: 'VoidPreAuthorization',
  credit: 'IssueKeyedRefund',
  reference_credit: 'IssueRefundByReference'
}

Constants inherited from Gateway

Gateway::CREDIT_DEPRECATION_MESSAGE, Gateway::RECURRING_DEPRECATION_MESSAGE, Gateway::STANDARD_ERROR_CODE

Instance Attribute Summary

Attributes inherited from Gateway

#options

Instance Method Summary collapse

Methods inherited from Gateway

#add_field_to_post_if_present, #add_fields_to_post_if_present, card_brand, #card_brand, #generate_unique_id, inherited, #scrub, supported_countries, #supported_countries, supported_countries=, supports?, #supports_network_tokenization?, #supports_scrubbing?, #test?

Methods included from CreditCardFormatting

#expdate, #format

Methods included from PostsData

included, #raw_ssl_request, #ssl_get, #ssl_post, #ssl_request

Constructor Details

#initialize(options = {}) ⇒ MerchantWareGateway

Creates a new MerchantWareGateway

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.



43
44
45
46
 
# File 'lib/active_merchant/billing/gateways/merchant_ware.rb', line 43

def initialize(options = {})
  requires!(options, :login, :password, :name)
  super
end

Instance Method Details

#authorize(money, credit_card, options = {}) ⇒ Object

Authorize a credit card for a given amount.

Parameters

  • money - The amount to be authorized as an Integer value in cents.

  • credit_card - The CreditCard details for the transaction.

  • options

    • :order_id - A unique reference for this order (required).

    • :billing_address - The billing address for the cardholder.



56
57
58
59
 
# File 'lib/active_merchant/billing/gateways/merchant_ware.rb', line 56

def authorize(money, credit_card, options = {})
  request = build_purchase_request(:authorize, money, credit_card, options)
  commit(:authorize, request)
end

#capture(money, authorization, options = {}) ⇒ Object

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.



79
80
81
82
 
# File 'lib/active_merchant/billing/gateways/merchant_ware.rb', line 79

def capture(money, authorization, options = {})
  request = build_capture_request(:capture, money, authorization, options)
  commit(:capture, request)
end

#credit(money, identification, options = {}) ⇒ Object

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)



104
105
106
107
108
109
110
111
 
# File 'lib/active_merchant/billing/gateways/merchant_ware.rb', line 104

def credit(money, identification, options = {})
  if identification.is_a?(String)
    ActiveMerchant.deprecated CREDIT_DEPRECATION_MESSAGE
    refund(money, identification, options)
  else
    perform_credit(money, identification, options)
  end
end

#purchase(money, credit_card, options = {}) ⇒ Object

Authorize and immediately capture funds from a credit card.

Parameters

  • money - The amount to be authorized as anInteger value in cents.

  • credit_card - The CreditCard details for the transaction.

  • options

    • :order_id - A unique reference for this order (required).

    • :billing_address - The billing address for the cardholder.



69
70
71
72
 
# File 'lib/active_merchant/billing/gateways/merchant_ware.rb', line 69

def purchase(money, credit_card, options = {})
  request = build_purchase_request(:purchase, money, credit_card, options)
  commit(:purchase, request)
end

#refund(money, reference, options = {}) ⇒ Object 



113
114
115
 
# File 'lib/active_merchant/billing/gateways/merchant_ware.rb', line 113

def refund(money, reference, options = {})
  perform_reference_credit(money, reference, options)
end

#void(authorization, options = {}) ⇒ Object

Void a transaction.

Parameters

  • authorization - The authorization string returned from the initial authorization or purchase.



88
89
90
91
92
93
94
 
# File 'lib/active_merchant/billing/gateways/merchant_ware.rb', line 88

def void(authorization, options = {})
  reference, options[:order_id] = split_reference(authorization)
  request = v4_soap_request(:void) do |xml|
    add_reference_token(xml, reference)
  end
  commit(:void, request, true)
end