class ActiveMerchant::Billing::MonerisUsGateway
To learn more about the Moneris (US) gateway, please contact ussales@moneris.com for a copy of their integration guide. For information on remote testing, please see “Test Environment Penny Value Response
Table”, and “Test Environment eFraud (AVS and CVD) Penny Response
Values”, available at Moneris' eSelect Plus Documentation Centre.
Public Class Methods
Initialize the Gateway
The gateway requires that a valid login and password be passed in the options
hash.
Options¶ ↑
-
:login
– Your Store ID -
:password
– Your API Token -
:cvv_enabled
– Specify that you would like the CVV passed to the gateway.Only particular account types at Moneris will allow this. Defaults to false. (optional)
ActiveMerchant::Billing::Gateway::new
# File lib/active_merchant/billing/gateways/moneris_us.rb, line 32 def initialize(options = {}) requires!(options, :login, :password) @cvv_enabled = options[:cvv_enabled] @avs_enabled = options[:avs_enabled] options = { :crypt_type => 7 }.merge(options) super end
Public Instance Methods
This method retrieves locked funds from a customer's account (from a PreAuth) and prepares them for deposit in a merchant's account.
Note: Moneris requires both the order_id and the transaction number of the original authorization. To maintain the same interface as the other gateways the two numbers are concatenated together with a ; separator as the authorization number returned by authorization
# File lib/active_merchant/billing/gateways/moneris_us.rb, line 93 def capture(money, authorization, options = {}) commit 'us_completion', crediting_params(authorization, :comp_amount => amount(money)) end
Performs a refund. This method requires that the original transaction number and order number be included. Concatenate your transaction number and order_id by using a semicolon (';'). This is to keep the Moneris interface consistent with other gateways. (See capture
for details.)
# File lib/active_merchant/billing/gateways/moneris_us.rb, line 113 def credit(money, authorization, options = {}) ActiveMerchant.deprecated CREDIT_DEPRECATION_MESSAGE refund(money, authorization, options) end
This action verifies funding on a customer's card and readies them for deposit in a merchant's account.
Pass in order_id
and optionally a customer
parameter
# File lib/active_merchant/billing/gateways/moneris_us.rb, line 68 def purchase(money, creditcard_or_datakey, options = {}) requires!(options, :order_id) post = {} add_payment_source(post, creditcard_or_datakey, options) post[:amount] = amount(money) post[:order_id] = options[:order_id] add_address(post, creditcard_or_datakey, options) post[:crypt_type] = options[:crypt_type] || @options[:crypt_type] action = if creditcard_or_datakey.is_a?(String) 'us_res_purchase_cc' elsif card_brand(creditcard_or_datakey) == 'check' 'us_ach_debit' elsif post[:data_key].blank? 'us_purchase' end commit(action, post) end
# File lib/active_merchant/billing/gateways/moneris_us.rb, line 118 def refund(money, authorization, options = {}) commit 'us_refund', crediting_params(authorization, :amount => amount(money)) end
# File lib/active_merchant/billing/gateways/moneris_us.rb, line 146 def scrub(transcript) transcript. gsub(%r((<pan>)[^<]*(</pan>))i, '\1[FILTERED]\2'). gsub(%r((<api_token>)[^<]*(</api_token>))i, '\1[FILTERED]\2'). gsub(%r((<cvd_value>)[^<]*(</cvd_value>))i, '\1[FILTERED]\2') end
# File lib/active_merchant/billing/gateways/moneris_us.rb, line 122 def store(payment_source, options = {}) post = {} add_payment_source(post, payment_source, options) post[:crypt_type] = options[:crypt_type] || @options[:crypt_type] card_brand(payment_source) == 'check' ? commit('us_res_add_ach', post) : commit('us_res_add_cc', post) end
# File lib/active_merchant/billing/gateways/moneris_us.rb, line 142 def supports_scrubbing? true end
# File lib/active_merchant/billing/gateways/moneris_us.rb, line 129 def unstore(data_key, options = {}) post = {} post[:data_key] = data_key commit('us_res_delete', post) end
# File lib/active_merchant/billing/gateways/moneris_us.rb, line 135 def update(data_key, payment_source, options = {}) post = {} add_payment_source(post, payment_source, options) post[:data_key] = data_key card_brand(payment_source) == 'check' ? commit('us_res_update_ach', post) : commit('us_res_update_cc', post) end
# File lib/active_merchant/billing/gateways/moneris_us.rb, line 40 def verify(creditcard_or_datakey, options = {}) MultiResponse.run(:use_first_response) do |r| r.process { authorize(100, creditcard_or_datakey, options) } r.process(:ignore_result) { capture(0, r.authorization) } end end
Voiding requires the original transaction ID and order ID of some open transaction. Closed transactions must be refunded. Note that the only methods which may be voided are capture
and purchase
.
Concatenate your transaction number and order_id by using a semicolon (';'). This is to keep the Moneris interface consistent with other gateways. (See capture
for details.)
# File lib/active_merchant/billing/gateways/moneris_us.rb, line 104 def void(authorization, options = {}) commit 'us_purchasecorrection', crediting_params(authorization) end