Active Merchant is a simple payment abstraction library used in and sponsored by Shopify. It is written by Tobias Luetke, Cody Fauser, and contributors. The aim of the project is to feel natural to Ruby users and to abstract as many parts as possible away from the user to offer a consistent interface across all supported gateways.
Ruby
Pull request Compare This branch is 2 commits ahead, 2707 commits behind activemerchant:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
generators Removes trailing spaces from generator templates May 9, 2012
lib Use PP in build_request Jul 19, 2012
rails Add rails/init.rb for gem campatability in Rails Mar 28, 2011
script Update project to use Rubigen Nov 30, 2007
test Replace X-PP with X-PAYPAL Jul 19, 2012
.gitignore Revert "ignore *.orig files" Jul 6, 2012
.travis.yml Also run CI against 1.9.3. Apr 10, 2012
.yardopts Add a GettingStarted file Aug 5, 2011
CHANGELOG Packaging for release 1.26.0 Jul 6, 2012
CONTRIBUTORS Add PayWay gateway Jul 6, 2012
Gemfile Updating LitleOnline requirement to 8.13.2 to take advantage of bette… Jun 28, 2012
Gemfile_rails30
Gemfile_rails31 Rename gemfiles. Feb 3, 2012
Gemfile_rails32 Rename gemfiles. Feb 3, 2012
GettingStarted.md Add a GettingStarted file Aug 5, 2011
MIT-LICENSE
README.md Add PayWay gateway Jul 6, 2012
RELEASING Add release instructions for the project Sep 13, 2010
Rakefile Some Rakefile cleanup. Apr 25, 2012
activemerchant.gemspec Update to fixed Mocha version. Apr 25, 2012
gem-public_cert.pem Add code to sign the gem Feb 22, 2007
init.rb Don't setup logger by default May 13, 2009

README.md

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.

Supported Offsite Payment Gateways

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.

Build Status