Class: ActiveMerchant::Billing::BeanstreamGateway

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

Overview

This class implements the Canadian Beanstream payment gateway. It is also named TD Canada Trust Online Mart payment gateway. To learn more about the specification of Beanstream gateway, please read the OM_Direct_Interface_API.pdf, which you can get from your Beanstream account or get from me by email.

Supported transaction types by Beanstream:

  • P - Purchase

  • PA - Pre Authorization

  • PAC - Pre Authorization Completion

Secure Payment Profiles:

BeanStream supports payment profiles (vaults). This allows you to store cc information with BeanStream and process subsequent transactions with a customer id. Secure Payment Profiles must be enabled on your account (must be done over the phone). Your API Access Passcode must be set in Administration => account settings => order settings. To learn more about storing credit cards with the Beanstream gateway, please read the BEAN_Payment_Profiles.pdf (I had to phone BeanStream to request it.)

Notes

  • Adding of order products information is not implemented.

  • Ensure that country and province data is provided as a code such as “CA”, “US”, “QC”.

  • login is the Beanstream merchant ID, username and password should be enabled in your Beanstream account and passed in using the :user and :password options.

  • Test your app with your true merchant id and test credit card information provided in the api pdf document.

  • Beanstream does not allow Payment Profiles to be deleted with their API. The accounts are ‘closed’, but have to be deleted manually.

Example authorization (Beanstream PA transaction type):

 twenty = 2000
 gateway = BeanstreamGateway.new(
   :login => '100200000',
   :user => 'xiaobozz',
   :password => 'password'
 )

 credit_card = CreditCard.new(
   :number => '4030000010001234',
   :month => 8,
   :year => 2011,
   :first_name => 'xiaobo',
   :last_name => 'zzz',
   :verification_value => 137
 )
 response = gateway.authorize(twenty, credit_card,
   :order_id => '1234',
   :billing_address => {
     :name => 'xiaobo zzz',
     :phone => '555-555-5555',
     :address1 => '1234 Levesque St.',
     :address2 => 'Apt B',
     :city => 'Montreal',
     :state => 'QC',
     :country => 'CA',
     :zip => 'H2C1X8'
   },
   :email => '[email protected]',
   :subtotal => 800,
   :shipping => 100,
   :tax1 => 100,
   :tax2 => 100,
   :custom => 'reference one'
 )

Constant Summary

Constants included from BeanstreamCore

ActiveMerchant::Billing::BeanstreamCore::AVS_CODES, ActiveMerchant::Billing::BeanstreamCore::CVD_CODES, ActiveMerchant::Billing::BeanstreamCore::PERIODICITIES, ActiveMerchant::Billing::BeanstreamCore::PERIODS, ActiveMerchant::Billing::BeanstreamCore::PROFILE_OPERATIONS, ActiveMerchant::Billing::BeanstreamCore::RECURRING_OPERATION, ActiveMerchant::Billing::BeanstreamCore::RECURRING_URL, ActiveMerchant::Billing::BeanstreamCore::SECURE_PROFILE_URL, ActiveMerchant::Billing::BeanstreamCore::SP_SERVICE_VERSION, ActiveMerchant::Billing::BeanstreamCore::TRANSACTIONS

Constants inherited from Gateway

Gateway::CREDIT_DEPRECATION_MESSAGE, Gateway::CURRENCIES_WITHOUT_FRACTIONS, Gateway::DEBIT_CARDS

Instance Attribute Summary

Attributes inherited from Gateway

#options

Instance Method Summary collapse

Methods included from BeanstreamCore

#capture, #credit, included, #initialize, #refund

Methods inherited from Gateway

#card_brand, card_brand, inherited, #initialize, supports?, #test?

Methods included from CreditCardFormatting

#format

Instance Method Details

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



67
68
69
70
71
72
73
74
75
76
 
# File 'lib/active_merchant/billing/gateways/beanstream.rb', line 67

def authorize(money, source, options = {})
  post = {}
  add_amount(post, money)
  add_invoice(post, options)
  add_source(post, source)
  add_address(post, options)
  add_transaction_type(post, :authorization)
  add_customer_ip(post, options)
  commit(post)
end

#cancel_recurring(options = {}) ⇒ Object 



121
122
123
124
125
126
 
# File 'lib/active_merchant/billing/gateways/beanstream.rb', line 121

def cancel_recurring(options = {})
  post = {}
  add_recurring_operation_type(post, :cancel)
  add_recurring_service(post, options)
  recurring_commit(post)
end

#delete(vault_id) ⇒ Object Also known as: unstore

can’t actually delete a secure profile with the supplicaed API. This function sets the status of the profile to closed ©. Closed profiles will have to removed manually.



144
145
146
 
# File 'lib/active_merchant/billing/gateways/beanstream.rb', line 144

def delete(vault_id)
  update(vault_id, false, {:status => "C"})
end

#interac ⇒ Object 



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

def interac
  @interac ||= BeanstreamInteracGateway.new(@options)
end

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



78
79
80
81
82
83
84
85
86
87
 
# File 'lib/active_merchant/billing/gateways/beanstream.rb', line 78

def purchase(money, source, options = {})
  post = {}
  add_amount(post, money)
  add_invoice(post, options)
  add_source(post, source)
  add_address(post, options)
  add_transaction_type(post, purchase_action(source))
  add_customer_ip(post, options)
  commit(post)
end

#recurring(money, source, options = {}) ⇒ Object 



99
100
101
102
103
104
105
106
107
108
 
# File 'lib/active_merchant/billing/gateways/beanstream.rb', line 99

def recurring(money, source, options = {})
  post = {}
  add_amount(post, money)
  add_invoice(post, options)
  add_credit_card(post, source)
  add_address(post, options)
  add_transaction_type(post, purchase_action(source))
  add_recurring_type(post, options)
  commit(post)
end

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

To match the other stored-value gateways, like TrustCommerce, store and unstore need to be defined



134
135
136
137
138
139
140
 
# File 'lib/active_merchant/billing/gateways/beanstream.rb', line 134

def store(credit_card, options = {})
  post = {}
  add_address(post, options)
  add_credit_card(post, credit_card)
  add_secure_profile_variables(post,options)
  commit(post, true)
end

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

Update the values (such as CC expiration) stored at the gateway. The CC number must be supplied in the CreditCard object.



153
154
155
156
157
158
159
160
 
# File 'lib/active_merchant/billing/gateways/beanstream.rb', line 153

def update(vault_id, credit_card, options = {})
  post = {}
  add_address(post, options)
  add_credit_card(post, credit_card)
  options.merge!({:vault_id => vault_id, :operation => secure_profile_action(:modify)})
  add_secure_profile_variables(post,options)
  commit(post, true)
end

#update_recurring(amount, source, options = {}) ⇒ Object 



110
111
112
113
114
115
116
117
118
119
 
# File 'lib/active_merchant/billing/gateways/beanstream.rb', line 110

def update_recurring(amount, source, options = {})
  post = {}
  add_recurring_amount(post, amount)
  add_recurring_invoice(post, options)
  add_credit_card(post, source)
  add_address(post, options)
  add_recurring_operation_type(post, :update)
  add_recurring_service(post, options)
  recurring_commit(post)
end

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



89
90
91
92
93
94
95
96
97
 
# File 'lib/active_merchant/billing/gateways/beanstream.rb', line 89

def void(authorization, options = {})
  reference, amount, type = split_auth(authorization)

  post = {}
  add_reference(post, reference)
  add_original_amount(post, amount)
  add_transaction_type(post, void_action(type))
  commit(post)
end