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 6 commits ahead, 96 commits behind activemerchant:master.
Permalink
Failed to load latest commit information.
generators Fix incorrect reference in gateway remote test generator May 30, 2017
lib [DEV-6103] no xid for mastercard Jan 25, 2018
script Extract integrations into an offsite_payments gem Jun 4, 2014
test [DEV-6103] no xid for mastercard Jan 25, 2018
.gitignore Ignore .ruby-version Feb 1, 2016
.travis.yml Add Rails 5.1 support (#2407) May 1, 2017
.yardopts Fix yard doc ignoring README Feb 12, 2014
CHANGELOG Worldpay US: Allowing switching to backup gateway per-transaction Nov 7, 2017
CONTRIBUTING.md Fix typo in contribution guidelines Dec 21, 2016
CONTRIBUTORS Add Cardknox gateway Nov 10, 2015
Gemfile Braintree Blue: Add eci_indicator field for Apple Pay Aug 31, 2017
Gemfile.rails32 Test Ruby 2.4, test w/ release version of Active Support 5 Apr 10, 2017
Gemfile.rails40 Test Ruby 2.4, test w/ release version of Active Support 5 Apr 10, 2017
Gemfile.rails41 Test Ruby 2.4, test w/ release version of Active Support 5 Apr 10, 2017
Gemfile.rails42 Test Ruby 2.4, test w/ release version of Active Support 5 Apr 10, 2017
Gemfile.rails50 Test Ruby 2.4, test w/ release version of Active Support 5 Apr 10, 2017
Gemfile.rails51 Add Rails 5.1 support (#2407) May 1, 2017
GettingStarted.md Update GettingStarted.md Feb 26, 2014
MIT-LICENSE Update copyright dates Feb 14, 2010
README.md Remove Barclays ePDQ MPI Mar 15, 2017
Rakefile Clean up `rake gateways:hosts` output Feb 25, 2015
activemerchant.gemspec Add Rails 5.1 support (#2407) May 1, 2017
circle.yml add Rails 5 support Nov 19, 2015
shipit.rubygems.yml ShipIt Jun 6, 2014

README.md

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 GettingStarted.md 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.

Installation

From Git

You can check out the latest source from git:

git clone git://github.com/activemerchant/active_merchant.git

From RubyGems

Installation from RubyGems:

gem install activemerchant

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

gem 'activemerchant'

Usage

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 = 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               => Time.now.year+1,
                :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}"
  else
    raise StandardError, response.message
  end
end

For more in-depth documentation and tutorials, see GettingStarted.md 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.