Class: ActiveMerchant::Billing::BeanstreamGateway
- 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, documentation can be found at developer.beanstream.com/documentation/classic-apis
To store a credit card using Beanstream’s Legato Javascript Library (developer.beanstream.com/documentation/legato) you must pass the singleUseToken in the store method’s option parameter. Example: @gateway.store(“gt6-0c78c25b-3637-4ba0-90e2-26105287f198”)
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, Gateway::RECURRING_DEPRECATION_MESSAGE, Gateway::STANDARD_ERROR_CODE
Instance Attribute Summary
Attributes inherited from Gateway
Instance Method Summary collapse
- #authorize(money, source, options = {}) ⇒ Object
- #cancel_recurring(options = {}) ⇒ Object
-
#delete(vault_id) ⇒ Object
(also: #unstore)
can’t actually delete a secure profile with the supplicated API.
- #interac ⇒ Object
- #purchase(money, source, options = {}) ⇒ Object
- #recurring(money, source, options = {}) ⇒ Object
-
#store(payment_method, options = {}) ⇒ Object
To match the other stored-value gateways, like TrustCommerce, store and unstore need to be defined.
-
#update(vault_id, payment_method, options = {}) ⇒ Object
Update the values (such as CC expiration) stored at the gateway.
- #update_recurring(amount, source, options = {}) ⇒ Object
- #void(authorization, options = {}) ⇒ Object
Methods included from BeanstreamCore
#capture, #credit, included, #initialize, #refund
Methods inherited from Gateway
#card_brand, card_brand, #generate_unique_id, inherited, #initialize, non_fractional_currency?, supported_countries, #supported_countries, supported_countries=, supports?, #test?
Methods included from CreditCardFormatting
Instance Method Details
#authorize(money, source, options = {}) ⇒ Object
70 71 72 73 74 75 76 77 78 79 |
# File 'lib/active_merchant/billing/gateways/beanstream.rb', line 70 def (money, source, = {}) post = {} add_amount(post, money) add_invoice(post, ) add_source(post, source) add_address(post, ) add_transaction_type(post, :authorization) add_customer_ip(post, ) commit(post) end |
#cancel_recurring(options = {}) ⇒ Object
128 129 130 131 132 133 134 135 |
# File 'lib/active_merchant/billing/gateways/beanstream.rb', line 128 def cancel_recurring( = {}) ActiveMerchant.deprecated RECURRING_DEPRECATION_MESSAGE post = {} add_recurring_operation_type(post, :cancel) add_recurring_service(post, ) recurring_commit(post) end |
#delete(vault_id) ⇒ Object Also known as: unstore
can’t actually delete a secure profile with the supplicated API. This function sets the status of the profile to closed ©. Closed profiles will have to removed manually.
159 160 161 |
# File 'lib/active_merchant/billing/gateways/beanstream.rb', line 159 def delete(vault_id) update(vault_id, false, {:status => "C"}) end |
#interac ⇒ Object
137 138 139 |
# File 'lib/active_merchant/billing/gateways/beanstream.rb', line 137 def interac @interac ||= BeanstreamInteracGateway.new(@options) end |
#purchase(money, source, options = {}) ⇒ Object
81 82 83 84 85 86 87 88 89 90 |
# File 'lib/active_merchant/billing/gateways/beanstream.rb', line 81 def purchase(money, source, = {}) post = {} add_amount(post, money) add_invoice(post, ) add_source(post, source) add_address(post, ) add_transaction_type(post, purchase_action(source)) add_customer_ip(post, ) commit(post) end |
#recurring(money, source, options = {}) ⇒ Object
102 103 104 105 106 107 108 109 110 111 112 113 |
# File 'lib/active_merchant/billing/gateways/beanstream.rb', line 102 def recurring(money, source, = {}) ActiveMerchant.deprecated RECURRING_DEPRECATION_MESSAGE post = {} add_amount(post, money) add_invoice(post, ) add_credit_card(post, source) add_address(post, ) add_transaction_type(post, purchase_action(source)) add_recurring_type(post, ) commit(post) end |
#store(payment_method, options = {}) ⇒ Object
To match the other stored-value gateways, like TrustCommerce, store and unstore need to be defined
143 144 145 146 147 148 149 150 151 152 153 154 155 |
# File 'lib/active_merchant/billing/gateways/beanstream.rb', line 143 def store(payment_method, = {}) post = {} add_address(post, ) if payment_method.respond_to?(:number) add_credit_card(post, payment_method) else post[:singleUseToken] = payment_method end add_secure_profile_variables(post, ) commit(post, true) end |
#update(vault_id, payment_method, options = {}) ⇒ Object
Update the values (such as CC expiration) stored at the gateway. The CC number must be supplied in the CreditCard object.
168 169 170 171 172 173 174 175 176 177 178 179 |
# File 'lib/active_merchant/billing/gateways/beanstream.rb', line 168 def update(vault_id, payment_method, = {}) post = {} add_address(post, ) if payment_method.respond_to?(:number) add_credit_card(post, payment_method) else post[:singleUseToken] = payment_method end .merge!({:vault_id => vault_id, :operation => secure_profile_action(:modify)}) add_secure_profile_variables(post,) commit(post, true) end |
#update_recurring(amount, source, options = {}) ⇒ Object
115 116 117 118 119 120 121 122 123 124 125 126 |
# File 'lib/active_merchant/billing/gateways/beanstream.rb', line 115 def update_recurring(amount, source, = {}) ActiveMerchant.deprecated RECURRING_DEPRECATION_MESSAGE post = {} add_recurring_amount(post, amount) add_recurring_invoice(post, ) add_credit_card(post, source) add_address(post, ) add_recurring_operation_type(post, :update) add_recurring_service(post, ) recurring_commit(post) end |
#void(authorization, options = {}) ⇒ Object
92 93 94 95 96 97 98 99 100 |
# File 'lib/active_merchant/billing/gateways/beanstream.rb', line 92 def void(, = {}) reference, amount, type = split_auth() post = {} add_reference(post, reference) add_original_amount(post, amount) add_transaction_type(post, void_action(type)) commit(post) end |