Active Merchant
Active Merchant is an extraction from the e-commerce system Shopify. Shopify's requirements for a simple and unified API to access dozens of different payment gateways with very different internal APIs was the chief principle in designing the library.
Active Merchant has been in production use since June 2006 and is now used in most modern Ruby applications which deal with financial transactions.
It was developed for usage in Ruby on Rails web applications and integrates seamlessly as a plugin but it also works excellently as a stand alone library.
See {file:GettingStarted.md} if you want to learn more about using Active Merchant in your applications.
Installation
From Git
You can check out the latest source from git:
git clone git://github.com/Shopify/active_merchant.git
As a Rails plugin
ActiveMerchant includes an init.rb file. This means that Rails will automatically load ActiveMerchant on startup. Run the following command from the root directory of your Rails project to install ActiveMerchant as a Rails plugin:
script/plugin install git://github.com/Shopify/active_merchant.git
From RubyGems
Installation from RubyGems
gem install activemerchant
Alternatively, add the following to your Gemfile
gem 'activemerchant', :require => 'active_merchant'
Usage
This simple example demonstrates how a purchase can be made using a person's credit card details.
require 'rubygems'
require 'active_merchant'
# Use the TrustCommerce test servers
ActiveMerchant::Billing::Base.mode = :test
gateway = ActiveMerchant::Billing::TrustCommerceGateway.new(
:login => 'TestMerchant',
:password => 'password')
# ActiveMerchant accepts all amounts as Integer values in cents
amount = 1000 # $10.00
# The card verification value is also known as CVV2, CVC2, or CID
credit_card = ActiveMerchant::Billing::CreditCard.new(
:first_name => 'Bob',
:last_name => 'Bobsen',
:number => '4242424242424242',
:month => '8',
:year => '2012',
:verification_value => '123')
# Validating the card automatically detects the card type
if credit_card.valid?
# Capture $10 from the credit card
response = gateway.purchase(amount, credit_card)
if response.success?
puts "Successfully charged $#{sprintf("%.2f", amount / 100)} to the credit card #{credit_card.display_number}"
else
raise StandardError, response.message
end
end
For more in-depth documentation and tutorials, see {file:GettingStarted.md} and the API documentation.
Supported Direct Payment Gateways
The ActiveMerchant Wiki contains a table of features supported by each gateway.
- Authorize.Net - US
- Authorize.Net CIM - US
- Barclays ePDQ - UK
- Beanstream.com - CA
- BluePay - US
- Braintree - US
- CardStream - UK
- CertoDirect - BE, BG, CZ, DK, DE, EE, IE, EL, ES, FR, IT, CY, LV, LT, LU, HU, MT, NL, AT, PL, PT, RO, SI, SK, FI, SE, UK
- CyberSource - US
- DataCash - UK
- Efsnet - US
- Elavon MyVirtualMerchant - US, CA
- ePay - DK, SE, NO
- eWAY - AU
- E-xact - CA, US
- Fat Zebra - AU
- Federated Canada - CA
- FirstPay - US
- Garanti Sanal POS - US, TR
- Inspire - US
- InstaPay - US
- Iridium - UK, ES
- iTransact - US
- JetPay - US
- LinkPoint - US
- Litle - US
- Merchant e-Solutions - US
- MerchantWare - US
- MasterCard Internet Gateway Service (MiGS) - AU, AE, BD, BN, EG, HK, ID, IN, JO, KW, LB, LK, MU, MV, MY, NZ, OM, PH, QA, SA, SG, TT, VN
- Modern Payments - US
- Moneris - CA
- Moneris US - US
- NABTransact - AU
- NELiX TransaX Gateway - US
- Netaxept - NO, DK, SE, FI
- NETbilling - US
- NetRegistry - AU
- NMI - US
- Ogone DirectLink - BE, DE, FR, NL, AT, CH
- Optimal Payments - CA, US, UK
- Orbital Paymentech - CA, US
- PayBox Direct - FR
- PayGate PayXML - US, ZA
- PayJunction - US
- PaymentExpress - AU, MY, NZ, SG, ZA, UK, US
- PayPal Express Checkout - US, CA, SG, AU
- PayPal Payflow Pro - US, CA, SG, AU
- PayPal Website Payments Pro (UK) - UK
- PayPal Website Payments Pro (CA) - CA
- PayPal Express Checkout - US
- PayPal Website Payments Pro (US) - US
- PaySecure - AU
- PayWay - AU
- Plug'n Pay - US
- Psigate - CA
- PSL Payment Solutions - UK
- Quantum - US
- QuickBooks Merchant Services - US
- Quickpay - DK, SE
- Rabobank Nederland - NL
- Realex - IE, UK
- SagePay - UK
- Sage Payment Solutions - US, CA
- Sallie Mae - US
- SecureNet - US
- SecurePay - AU
- SecurePay - US
- SecurePayTech - NZ
- SkipJack - US, CA
- Stripe - US
- TransFirst - US
- TrustCommerce - US
- USA ePay - US
- Verifi - US
- ViaKLIX - US
- Vindica - US, CA, UK, AU, MX, BR, DE, KR, CN, HK
- Wirecard - DE
- WorldPay - AU, HK, UK, US
Supported Offsite Payment Gateways
- 2 Checkout
- Authorize.Net SIM - US
- Banca Sella GestPay
- Chronopay
- DirecPay
- Direct-eBanking / sofortueberweisung.de by Payment-Networks AG - DE, AT, CH, BE, UK, NL
- Dotpay
- Dwolla
- ePay
- HiTRUST
- Moneybookers
- Nochex
- PayPal Website Payments Standard
- Robokassa
- SagePay Form
- Valitor - IS
- Verkkomaksut - FI
- WorldPay
Contributing
The source code is hosted at GitHub, and can be fetched using:
git clone git://github.com/Shopify/active_merchant.git
Please see the ActiveMerchant Guide to Contributing for information on adding a new gateway to ActiveMerchant.
Please don't touch the CHANGELOG in your pull requests, we'll add the appropriate CHANGELOG entries at release time.