Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
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.
Ruby
Failed to load latest commit information.
generators Fix warnings
lib CenPOS: Allow specification of customer_code
script Extract integrations into an offsite_payments gem
test CenPOS: Allow specification of customer_code
.gitignore Ignore files generated by rdoc
.travis.yml Remove Ruby 1.9 from travis.yml as it is no longer supported
.yardopts Fix yard doc ignoring README
CHANGELOG CenPOS: Allow specification of customer_code
CONTRIBUTING.md Update contributions doc to include requirements for remote tests
CONTRIBUTORS Adding Worldpay Online Payments
Gemfile use emv_auth_data and emv_approval_data keys, do not post to /capture…
Gemfile.rails32 use emv_auth_data and emv_approval_data keys, do not post to /capture…
Gemfile.rails40 use emv_auth_data and emv_approval_data keys, do not post to /capture…
Gemfile.rails41 use emv_auth_data and emv_approval_data keys, do not post to /capture…
Gemfile.rails42 use emv_auth_data and emv_approval_data keys, do not post to /capture…
GettingStarted.md Update GettingStarted.md
MIT-LICENSE Update copyright dates
README.md Dibs: Add gateway
Rakefile Clean up `rake gateways:hosts` output
activemerchant.gemspec Remove dev dependency on Rails
shipit.rubygems.yml ShipIt

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

Something went wrong with that request. Please try again.