Skip to content
This repository

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.

Merge pull request #1125 from Shopify/nmi_rename

Rename Transnational to Network Merchants
latest commit 7d114911f1
Boris Slobodin bslobodin authored April 17, 2014
Octocat-spinner-32 generators Improve gateway generator February 21, 2014
Octocat-spinner-32 lib Merge pull request #1125 from Shopify/nmi_rename April 17, 2014
Octocat-spinner-32 rails Add rails/init.rb for gem campatability in Rails March 28, 2011
Octocat-spinner-32 script Rewrite generate to use Thor rather than Rubigen November 09, 2012
Octocat-spinner-32 test Merge pull request #1125 from Shopify/nmi_rename April 17, 2014
Octocat-spinner-32 .gitignore Better rake task for gem release November 12, 2013
Octocat-spinner-32 .travis.yml Change Travis notifications to go to payments team April 17, 2014
Octocat-spinner-32 .yardopts Fix yard doc ignoring README February 12, 2014
Octocat-spinner-32 CHANGELOG Rename Transnational to Network Merchants April 16, 2014
Octocat-spinner-32 CONTRIBUTORS Add BridgePay gateway April 16, 2014
Octocat-spinner-32 Gemfile Initial implementation March 27, 2014
Octocat-spinner-32 Gemfile_common Litle: Remove dependency on the Litle gem April 02, 2014
Octocat-spinner-32 Gemfile_rails23 Fixing builder dependency for rails 3.0, and adding upper limit to ac… August 22, 2013
Octocat-spinner-32 Gemfile_rails30 Allows i18n v.0.5.0 for Rails 3 August 29, 2013
Octocat-spinner-32 Gemfile_rails31 Fixing builder dependency for rails 3.0, and adding upper limit to ac… August 22, 2013
Octocat-spinner-32 Gemfile_rails40 Specify rails 4 so it does not include rails 4.1 in Gemfile_rails40. April 09, 2014
Octocat-spinner-32 GettingStarted.md Update GettingStarted.md February 26, 2014
Octocat-spinner-32 MIT-LICENSE Update copyright dates February 13, 2010
Octocat-spinner-32 README.md Add BridgePay gateway April 16, 2014
Octocat-spinner-32 RELEASING 1.42.6 release February 24, 2014
Octocat-spinner-32 Rakefile Require private key to build gem November 13, 2013
Octocat-spinner-32 activemerchant.gemspec Allow money gem v6. November 07, 2013
Octocat-spinner-32 gem-public_cert.pem New updated public_cert November 13, 2013
Octocat-spinner-32 init.rb Don't setup logger by default May 12, 2009
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.

Installation

From Git

You can check out the latest source from git:

git clone git://github.com/Shopify/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 '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               => Time.now.year+1,
                :verification_value => '000')

# 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 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.

Something went wrong with that request. Please try again.