Class: ActiveMerchant::Billing::MonerisUsGateway
- Defined in:
- lib/active_merchant/billing/gateways/moneris_us.rb
Overview
To learn more about the Moneris (US) 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::CURRENCIES_WITHOUT_FRACTIONS, Gateway::DEBIT_CARDS, Gateway::RECURRING_DEPRECATION_MESSAGE, Gateway::STANDARD_ERROR_CODE
Instance Attribute Summary
Attributes inherited from Gateway
Instance Method Summary collapse
-
#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.
-
#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.
-
#credit(money, authorization, options = {}) ⇒ Object
Performs a refund.
-
#initialize(options = {}) ⇒ MonerisUsGateway
constructor
Initialize the Gateway.
-
#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.
- #refund(money, authorization, options = {}) ⇒ Object
- #store(credit_card, options = {}) ⇒ Object
- #unstore(data_key, options = {}) ⇒ Object
- #update(data_key, credit_card, options = {}) ⇒ Object
-
#void(authorization, options = {}) ⇒ Object
Voiding requires the original transaction ID and order ID of some open transaction.
Methods inherited from Gateway
#card_brand, card_brand, #generate_unique_id, inherited, non_fractional_currency?, #supported_countries, supported_countries, supported_countries=, supports?, #test?
Methods included from CreditCardFormatting
Constructor Details
#initialize(options = {}) ⇒ MonerisUsGateway
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)
33 34 35 36 37 38 39 |
# File 'lib/active_merchant/billing/gateways/moneris_us.rb', line 33 def initialize( = {}) requires!(, :login, :password) @cvv_enabled = [:cvv_enabled] @avs_enabled = [:avs_enabled] = { :crypt_type => 7 }.merge() 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.
46 47 48 49 50 51 52 53 54 55 56 |
# File 'lib/active_merchant/billing/gateways/moneris_us.rb', line 46 def (money, creditcard_or_datakey, = {}) requires!(, :order_id) post = {} add_payment_source(post, creditcard_or_datakey, ) post[:amount] = amount(money) post[:order_id] = [:order_id] post[:address] = [:billing_address] || [:address] post[:crypt_type] = [:crypt_type] || @options[:crypt_type] action = (post[:data_key].blank?) ? 'us_preauth' : 'us_res_preauth_cc' 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
81 82 83 |
# File 'lib/active_merchant/billing/gateways/moneris_us.rb', line 81 def capture(money, , = {}) commit 'us_completion', crediting_params(, :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.)
101 102 103 104 |
# File 'lib/active_merchant/billing/gateways/moneris_us.rb', line 101 def credit(money, , = {}) ActiveMerchant.deprecated CREDIT_DEPRECATION_MESSAGE refund(money, , ) 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
62 63 64 65 66 67 68 69 70 71 72 |
# File 'lib/active_merchant/billing/gateways/moneris_us.rb', line 62 def purchase(money, creditcard_or_datakey, = {}) requires!(, :order_id) post = {} add_payment_source(post, creditcard_or_datakey, ) post[:amount] = amount(money) post[:order_id] = [:order_id] post[:address] = [:billing_address] || [:address] post[:crypt_type] = [:crypt_type] || @options[:crypt_type] action = (post[:data_key].blank?) ? 'us_purchase' : 'us_res_purchase_cc' commit(action, post) end |
#refund(money, authorization, options = {}) ⇒ Object
106 107 108 |
# File 'lib/active_merchant/billing/gateways/moneris_us.rb', line 106 def refund(money, , = {}) commit 'us_refund', crediting_params(, :amount => amount(money)) end |
#store(credit_card, options = {}) ⇒ Object
110 111 112 113 114 115 116 |
# File 'lib/active_merchant/billing/gateways/moneris_us.rb', line 110 def store(credit_card, = {}) post = {} post[:pan] = credit_card.number post[:expdate] = expdate(credit_card) post[:crypt_type] = [:crypt_type] || @options[:crypt_type] commit('us_res_add_cc', post) end |
#unstore(data_key, options = {}) ⇒ Object
118 119 120 121 122 |
# File 'lib/active_merchant/billing/gateways/moneris_us.rb', line 118 def unstore(data_key, = {}) post = {} post[:data_key] = data_key commit('us_res_delete', post) end |
#update(data_key, credit_card, options = {}) ⇒ Object
124 125 126 127 128 129 130 131 |
# File 'lib/active_merchant/billing/gateways/moneris_us.rb', line 124 def update(data_key, credit_card, = {}) post = {} post[:pan] = credit_card.number post[:expdate] = expdate(credit_card) post[:data_key] = data_key post[:crypt_type] = [:crypt_type] || @options[:crypt_type] commit('us_res_update_cc', post) end |
#void(authorization, options = {}) ⇒ Object
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.)
92 93 94 |
# File 'lib/active_merchant/billing/gateways/moneris_us.rb', line 92 def void(, = {}) commit 'us_purchasecorrection', crediting_params() end |