Class ActiveMerchant::Billing::BeanstreamGateway
In: lib/active_merchant/billing/gateways/beanstream.rb
Parent: Gateway

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

  • Recurring billing is not yet implemented.
  • 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 => 'xiaobozzz@example.com',
    :subtotal => 800,
    :shipping => 100,
    :tax1 => 100,
    :tax2 => 100,
    :custom => 'reference one'
  )

Methods

authorize   delete   interac   purchase   store   unstore   update   void  

Included Modules

BeanstreamCore

Public Instance methods

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

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

unstore(vault_id)

Alias for delete

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

[Validate]