Active Merchant is a simple payment abstraction library extracted from Shopify. 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.
Latest commit 100b936 Dec 2, 2016 @shasum shasum committed with davidsantoso Pass through `header_email_receipt`
Modify `header_email_receipt` to be a pass through field

Closes #2274
Failed to load latest commit information.
generators Fix variables in generated remote gateway tests Nov 23, 2015
lib Pass through `header_email_receipt` Dec 2, 2016
script Extract integrations into an offsite_payments gem Jun 4, 2014
test Pass through `header_email_receipt` Dec 2, 2016
.gitignore Ignore .ruby-version Feb 1, 2016
.travis.yml Remove payments-dev from the travis build email notifications Jul 11, 2016
.yardopts Fix yard doc ignoring README Feb 12, 2014
CHANGELOG Pass through `header_email_receipt` Dec 2, 2016 More prominant links to contribution docs Feb 2, 2016
CONTRIBUTORS Add Cardknox gateway Nov 10, 2015
Gemfile Braintree: switch gem dependency to an official release (2.50.0) Nov 2, 2015
Gemfile.rails32 Braintree: switch gem dependency to an official release (2.50.0) Nov 2, 2015
Gemfile.rails40 Braintree: switch gem dependency to an official release (2.50.0) Nov 2, 2015
Gemfile.rails41 Braintree: switch gem dependency to an official release (2.50.0) Nov 2, 2015
Gemfile.rails42 Braintree: switch gem dependency to an official release (2.50.0) Nov 2, 2015
Gemfile.rails5 add Rails 5 support Nov 19, 2015 Update Feb 26, 2014
MIT-LICENSE Update copyright dates Feb 14, 2010 Monei: Add US and CA as new supported countries Nov 9, 2016
Rakefile Clean up `rake gateways:hosts` output Feb 25, 2015
activemerchant.gemspec Do not allow to install the gem with Ruby 1.9 Nov 19, 2015
circle.yml add Rails 5 support Nov 19, 2015
shipit.rubygems.yml ShipIt Jun 6, 2014

Active Merchant

Build Status Code Climate

Active Merchant is an extraction from the ecommerce 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.

It was developed for usage in Ruby on Rails web applications and integrates seamlessly as a Rails plugin, but it also works excellently as a stand alone Ruby 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 is maintained by the Shopify and Spreedly teams, with much help from an ever-growing set of contributors.

See if you want to learn more about using Active Merchant in your applications.

If you'd like to contribute to Active Merchant, please start with our contribution guide.


From Git

You can check out the latest source from git:

git clone git://

From RubyGems

Installation from RubyGems:

gem install activemerchant

Or, if you're using Bundler, just add the following to your Gemfile:

gem 'activemerchant'


This simple example demonstrates how a purchase can be made using a person's credit card details.

require 'active_merchant'

# Use the TrustCommerce test servers
ActiveMerchant::Billing::Base.mode = :test

gateway =
            :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 =
                :first_name         => 'Bob',
                :last_name          => 'Bobsen',
                :number             => '4242424242424242',
                :month              => '8',
                :year               =>,
                :verification_value => '000')

# Validating the card automatically detects the card type
if credit_card.validate.empty?
  # 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}"
    raise StandardError, response.message

For more in-depth documentation and tutorials, see and the API documentation.

Supported Payment Gateways

The ActiveMerchant Wiki contains a table of features supported by each gateway.

API stability policy

Functionality or APIs that are deprecated will be marked as such. Deprecated functionality is removed on major version changes - for example, deprecations from 2.x are removed in 3.x.