https://github.com/spree-contrib/spree_braintree_vzero
Official Braintree + PayPal integration gem for Spree Commerce
https://github.com/spree-contrib/spree_braintree_vzero
braintree payments paypal spree spree-commerce
Last synced: 6 months ago
JSON representation
Official Braintree + PayPal integration gem for Spree Commerce
- Host: GitHub
- URL: https://github.com/spree-contrib/spree_braintree_vzero
- Owner: spree-contrib
- License: bsd-3-clause
- Created: 2015-08-26T09:03:36.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2025-06-05T10:40:19.000Z (about 1 year ago)
- Last Synced: 2025-06-05T11:38:01.706Z (about 1 year ago)
- Topics: braintree, payments, paypal, spree, spree-commerce
- Language: Ruby
- Homepage: https://www.braintreepayments.com/
- Size: 1.49 MB
- Stars: 46
- Watchers: 21
- Forks: 63
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Official Braintree integration for Spree Commerce
> [!NOTE]
> For **PayPal** support head over to [Spree PayPal Checkout](https://github.com/spree/spree_paypal_checkout) which uses the newest PayPal APIs and supports Spree 5
This is the official Braintree + PayPal extension for [Spree Commerce](https://spreecommerce.org). It supports:
* [Braintree Hosted Fields](https://github.com/spree-contrib/spree_braintree_vzero/wiki/1.-Hosted-Fields) - style the credit card form to match your UI with full PCI compliance
* [PayPal Express Checkout](https://github.com/spree-contrib/spree_braintree_vzero/wiki/2.-PayPal-Express) - the fastest way for buyers to pay with PayPal - available on Spree for the first time
* [Braintree Drop-in UI](http://github.com/spree-contrib/spree_braintree_vzero/wiki/3.-Drop-in-UI) - start accepting payments ASAP
Behind-the-scenes, this extension uses [Braintree Ruby SDK](https://github.com/braintree/braintree_ruby).
## Installation
1. Add this extension to your Gemfile with this line:
#### Spree >= 3.1
```ruby
gem 'spree_braintree_vzero', '~> 3.5'
```
#### Spree 3.0 and Spree 2.x
```ruby
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.
2. Install the gem using Bundler:
```ruby
bundle install
```
3. Copy & run migrations
```ruby
bundle exec rails g spree_braintree_vzero:install
```
4. Restart your server
If your server was running, restart it so that it can find the assets properly.
## Documentation
See [wiki](https://github.com/spree-contrib/spree_braintree_vzero/wiki) for more detailed documentation.
## Heroku installation (optional)
Additional to migrations the gem adds a cron task (via the [Whenever gem](https://github.com/javan/whenever)) which is needed for updating transaction states from _submited for settlement_ to _settled_ ([Braintree v.zero transaction states](https://developers.braintreepayments.com/guides/transactions/ruby#status)). To run on Heroku you have to add a task to [Heroku Scheduler](https://devcenter.heroku.com/articles/scheduler):
```
rake spree_braintree_vzero:update_states
```
Recommended frequency is every 6 hours.
## Contributing
If you'd like to contribute, please take a look at the
[instructions](CONTRIBUTING.md) for installing dependencies and crafting a good
pull request.
## License
Spree Braintree V.zero is copyright © 2015-2021
[Spark Solutions Sp. z o.o.][spark]. It is free software,
and may be redistributed under the terms specified in the
[LICENCE](LICENSE) file.
[LICENSE]: https://github.com/spark-solutions/spree_braintree_vzero/blob/master/LICENSE
## About Spark Solutions
[][spark]
Spree Braintree V.zero is maintained by [Spark Solutions Sp. z o.o.](http://sparksolutions.co?utm_source=github) and funded by [PayPal, Inc.](http://paypal.com)
The names and logos are trademarks of PayPal, inc.
We are passionate about open source software.
We are [available for hire][spark].
[spark]:http://sparksolutions.co?utm_source=github