Skip to content

Latest commit

 

History

History
181 lines (145 loc) · 8.15 KB

README.md

File metadata and controls

181 lines (145 loc) · 8.15 KB
Raw

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.

Build Status