Class: ActiveMerchant::Billing::MonerisGateway

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

Overview

To learn more about the Moneris gateway, please contact [email protected] 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.

Constant Summary

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, supported_countries, #supported_countries, supported_countries=, supports?, #supports_network_tokenization?, #test?

Methods included from CreditCardFormatting

#format

Methods included from PostsData

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

Constructor Details

#initialize(options = {}) ⇒ MonerisGateway

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  types at Moneris will allow this.
    Defaults to false.  (optional)
    

32
33
34
35
36
37
38
# File 'lib/active_merchant/billing/gateways/moneris.rb', line 32

def initialize(options = {})
  requires!(options, :login, :password)
  @cvv_enabled = options[:cvv_enabled]
  @avs_enabled = options[:avs_enabled]
  options[:crypt_type] = 7 unless options.has_key?(:crypt_type)
  super
end

Instance Method Details

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

Referred to as “PreAuth” in the Moneris integration guide, this action verifies and locks funds on a customer's card, which then must be captured at a later date.

Pass in order_id and optionally a customer parameter.


45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
# File 'lib/active_merchant/billing/gateways/moneris.rb', line 45

def authorize(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]
  post[:address] = options[:billing_address] || options[:address]
  post[:crypt_type] = options[:crypt_type] || @options[:crypt_type]
  add_stored_credential(post, options)
  action = if post[:cavv]
             'cavv_preauth'
           elsif post[:data_key].blank?
             'preauth'
           else
             'res_preauth_cc'
           end
  commit(action, post)
end

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

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


94
95
96
# File 'lib/active_merchant/billing/gateways/moneris.rb', line 94

def capture(money, authorization, options = {})
  commit 'completion', crediting_params(authorization, comp_amount: amount(money))
end

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

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.)


127
128
129
130
# File 'lib/active_merchant/billing/gateways/moneris.rb', line 127

def credit(money, authorization, options = {})
  ActiveMerchant.deprecated CREDIT_DEPRECATION_MESSAGE
  refund(money, authorization, options)
end

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

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


68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
# File 'lib/active_merchant/billing/gateways/moneris.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]
  post[:address] = options[:billing_address] || options[:address]
  post[:crypt_type] = options[:crypt_type] || @options[:crypt_type]
  add_stored_credential(post, options)
  action = if post[:cavv]
             'cavv_purchase'
           elsif post[:data_key].blank?
             'purchase'
           else
             'res_purchase_cc'
           end
  commit(action, post)
end

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


132
133
134
# File 'lib/active_merchant/billing/gateways/moneris.rb', line 132

def refund(money, authorization, options = {})
  commit 'refund', crediting_params(authorization, amount: amount(money))
end

#scrub(transcript) ⇒ Object


191
192
193
194
195
196
197
198
# File 'lib/active_merchant/billing/gateways/moneris.rb', line 191

def scrub(transcript)
  transcript.
    gsub(%r((<store_id>).+(</store_id>)), '\1[FILTERED]\2').
    gsub(%r((<api_token>).+(</api_token>)), '\1[FILTERED]\2').
    gsub(%r((<pan>).+(</pan>)), '\1[FILTERED]\2').
    gsub(%r((<cvd_value>).+(</cvd_value>)), '\1[FILTERED]\2').
    gsub(%r((<cavv>).+(</cavv>)), '\1[FILTERED]\2')
end

#store(credit_card, options = {}) ⇒ Object

When passing a :duration option (time in seconds) you can create a temporary vault record to avoid incurring Moneris vault storage fees

developer.moneris.com/Documentation/NA/E-Commerce%20Solutions/API/Vault#vaulttokenadd


156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
# File 'lib/active_merchant/billing/gateways/moneris.rb', line 156

def store(credit_card, options = {})
  post = {}
  post[:pan] = credit_card.number
  post[:expdate] = expdate(credit_card)
  post[:address] = options[:billing_address] || options[:address]
  post[:crypt_type] = options[:crypt_type] || @options[:crypt_type]
  add_stored_credential(post, options)

  if options[:duration]
    post[:duration] = options[:duration]
    commit('res_temp_add', post)
  else
    commit('res_add_cc', post)
  end
end

#supports_scrubbing?Boolean

Returns:

  • (Boolean)

187
188
189
# File 'lib/active_merchant/billing/gateways/moneris.rb', line 187

def supports_scrubbing?
  true
end

#unstore(data_key, options = {}) ⇒ Object


172
173
174
175
176
# File 'lib/active_merchant/billing/gateways/moneris.rb', line 172

def unstore(data_key, options = {})
  post = {}
  post[:data_key] = data_key
  commit('res_delete', post)
end

#update(data_key, credit_card, options = {}) ⇒ Object


178
179
180
181
182
183
184
185
# File 'lib/active_merchant/billing/gateways/moneris.rb', line 178

def update(data_key, credit_card, options = {})
  post = {}
  post[:pan] = credit_card.number
  post[:expdate] = expdate(credit_card)
  post[:data_key] = data_key
  post[:crypt_type] = options[:crypt_type] || @options[:crypt_type]
  commit('res_update_cc', post)
end

#verify(credit_card, options = {}) ⇒ Object


136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
# File 'lib/active_merchant/billing/gateways/moneris.rb', line 136

def verify(credit_card, options = {})
  requires!(options, :order_id)
  post = {}
  add_payment_source(post, credit_card, options)
  post[:order_id] = options[:order_id]
  post[:address] = options[:billing_address] || options[:address]
  post[:crypt_type] = options[:crypt_type] || @options[:crypt_type]
  add_stored_credential(post, options)
  action = if post[:data_key].blank?
             'card_verification'
           else
             'res_card_verification_cc'
           end
  commit(action, post)
end

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

Voiding requires the original transaction ID and order ID of some open transaction. Closed transactions must be refunded.

Moneris supports the voiding of an unsettled capture or purchase via its purchasecorrection command. This action can only occur on the same day as the capture/purchase prior to 22:00-23:00 EST. If you want to do this, pass :purchasecorrection => true as an option.

Fun, Historical Trivia: Voiding an authorization in Moneris is a relatively new feature (September, 2011). It is actually done by doing a $0 capture.

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.)


114
115
116
117
118
119
120
# File 'lib/active_merchant/billing/gateways/moneris.rb', line 114

def void(authorization, options = {})
  if options[:purchasecorrection]
    commit 'purchasecorrection', crediting_params(authorization)
  else
    capture(0, authorization, options)
  end
end