Skip to content
Branch: master
Clone or download
Latest commit 6e56c70 Mar 28, 2019
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Update PR template for running unit tests (#156) Dec 18, 2017
env 2.10.0 Apr 26, 2011
lib 2.95.0 Mar 28, 2019
spec 2.95.0 Mar 28, 2019
.gitignore 2.34.0 Sep 11, 2014 2.68.2 Oct 31, 2016
Dockerfile 2.94.0 Jan 23, 2019
Gemfile 2.87.0 Apr 12, 2018
LICENSE 2.73.0 Mar 29, 2017
Makefile 2.82.0 Jan 19, 2018 2.83.0 Feb 8, 2018
Rakefile 2.52.0 Oct 23, 2015
braintree-ruby.gems 2.23.0 May 1, 2013
braintree.gemspec Add changelog url (#166) Jul 31, 2018

Braintree Ruby library

The Braintree gem provides integration access to the Braintree Gateway.

Please Note

The Payment Card Industry (PCI) Council has mandated that early versions of TLS be retired from service. All organizations that handle credit card information are required to comply with this standard. As part of this obligation, Braintree is updating its services to require TLS 1.2 for all HTTPS connections. Braintree will also require HTTP/1.1 for all connections. Please see our technical documentation for more information.


  • builder
  • libxml-ruby


gem install braintree

Or add to your Gemfile:

gem 'braintree'

Quick Start Example

require "rubygems"
require "braintree"

gateway =
  :environment => :sandbox,
  :merchant_id => "your_merchant_id",
  :public_key => "your_public_key",
  :private_key => "your_private_key",

result =
  :amount => "1000.00",
  :payment_method_nonce => nonce_from_the_client,
  :options => {
    :submit_for_settlement => true

if result.success?
  puts "success!: #{}"
elsif result.transaction
  puts "Error processing transaction:"
  puts "  code: #{result.transaction.processor_response_code}"
  puts "  text: #{result.transaction.processor_response_text}"
  p result.errors

You retrieve your merchant_id, public_key, and private_key when signing up for Braintree. Signing up for a sandbox account is easy, free, and instant.

Bang Methods

Most methods have a bang and a non-bang version (e.g. gateway.customer.create and gateway.customer.create!). The non-bang version will either return a SuccessfulResult or an ErrorResult. The bang version will either return the created or updated resource, or it will raise a ValidationsFailed exception.

Example of using non-bang method:

result = gateway.customer.create(:first_name => "Josh")
if result.success?
  puts "Created customer #{}"
  puts "Validations failed"
  result.errors.for(:customer).each do |error|
    puts error.message

Example of using bang method:

  customer = gateway.customer.create!(:first_name => "Josh")
  puts "Created customer #{}"
rescue Braintree::ValidationsFailed
  puts "Validations failed"

We recommend using the bang methods when you assume that the data is valid and do not expect validations to fail. Otherwise, we recommend using the non-bang methods.

More Information

Developing (Docker)

The Makefile and Dockerfile will build an image containing the dependencies and drop you to a terminal where you can run tests.



The unit specs can be run by anyone on any system, but the integration specs are meant to be run against a local development server of our gateway code. These integration specs are not meant for public consumption and will likely fail if run on your system. To run unit tests use rake: rake test:unit.

Suppress Braintree Logs

To suppress logs from Braintree on environments where they are considered noise (e.g. test) use the following configuration:

logger ="/dev/null")
logger.level = Logger::INFO
gateway.config.logger = logger


See the LICENSE file for more info.

You can’t perform that action at this time.