Braintree extension for Spree Commerce

Build Status Code Climate Test Coverage

This is the official Braintree extension for Spree. It supports:
* Braintree Hosted Fields - style the credit card form to match your UI with full PCI compliance
* PayPal Express Checkout - the fastest way for buyers to pay with PayPal - available on Spree for the first time
* Braintree Drop-in UI - start accepting payments ASAP

Learn more during the official PayPal workshop in New York City on June 28-29th during OpenCommerce Conf 2016

Behind-the-scenes, this extension uses Braintree Ruby SDK.


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

#### Spree >= 3.1

  gem 'spree_braintree_vzero', github: 'spree-contrib/spree_braintree_vzero'

#### Spree 3.0 and Spree 2.x

  gem 'spree_braintree_vzero', github: 'spree-contrib/spree_braintree_vzero', 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

  2. Copy & run migrations
    bundle exec rails g spree_braintree_vzero:install

  3. Restart your server

If your server was running, restart it so that it can find the assets properly.

Heroku installation

Additional to migrations the gem adds a cron task (via the Whenever gem) which is needed for updating transaction states from submited for settlement to settled (Braintree transaction states). To run on Heroku you have to add a task to Heroku Scheduler:

rake spree_braintree_vzero:update_states

Recommended frequency is every 6 hours.

Example application

If you want to see a working instance of Spree with this gem please see our sample application repository


If you'd like to contribute, please take a look at the
instructions for installing dependencies and crafting a good
pull request.


Spree Braintree is copyright © 2015-2017
Spark Solutions Sp. z o.o.. It is free software,
and may be redistributed under the terms specified in the

About Spark Solutions

Spark Solutions

Spree Braintree is maintained by Spark Solutions Sp. z o.o. and funded by PayPal, Inc.
The names and logos are trademarks of PayPal, inc.

We are passionate about open source software.
We are available for hire.


No comments yet

Please login to add comment.