Community maintained collection of gateways for use in Spree
Clone or download
damianlegawiec Merge pull request #313 from spree/unify-install-generator
Unify Gateway install generator with Auth Devise install generator
Latest commit 8e14c33 Jul 11, 2018

Spree Gateway

Build Status Code Climate

Community supported Spree Payment Method Gateways. It works as a wrapper for active_merchant gateway. Note that for some gateways you might still need to add another gem to your Gemfile to make it work. For example active_merchant require braintree but it doesn't include that gem on its gemspec. So you need to manually add it to your rails app Gemfile.


  1. Add this extension to your Gemfile with this line:

Spree >= 3.1

gem 'spree_gateway', '~> 3.3'

Spree 3.0 and Spree 2.x

gem 'spree_gateway', github: 'spree/spree_gateway', branch: 'X-X-stable'

The branch option is important: it must match the version of Spree you're using. For example, use 3-0-stable if you're using Spree 3-0-stable or any 3.0.x version.

  1. Install the gem using Bundler:
bundle install
  1. Copy & run migrations
bundle exec rails g spree_gateway:install

Finally, make sure to restart your app. Navigate to Configuration > Payment Methods > New Payment Method in the admin panel and you should see that a bunch of additional gateways have been added to the list.


In the spirit of free software, everyone is encouraged to help improve this project.

Here are some ways you can contribute:

  • by using prerelease versions
  • by reporting bugs
  • by suggesting new features
  • by writing or editing documentation
  • by writing specifications
  • by writing code (no patch is too small: fix typos, add comments, clean up inconsistent whitespace)
  • by refactoring code
  • by resolving issues
  • by reviewing patches

Starting point:

  • Fork the repo
  • Clone your repo
  • (You will need to brew install mysql postgres if you don't already have them installed)
  • Run bundle
  • (You may need to bundle update if bundler gets stuck)
  • Run bundle exec rake test_app to create the test application in spec/test_app
  • Make your changes
  • Ensure specs pass by running bundle exec rspec spec
  • (You will need to brew install phantomjs if you don't already have it installed)
  • Submit your pull request

Copyright (c) 2014 Spree Commerce and other contributors, released under the New BSD License