Ruby Shell
Latest commit 8021b9c Oct 11, 2016 @braintreeps braintreeps 2.68.1
Failed to load latest commit information.
env 2.10.0 Apr 26, 2011
lib 2.68.1 Oct 11, 2016
spec 2.68.1 Oct 11, 2016
.gitignore 2.34.0 Sep 11, 2014
CHANGELOG.rdoc 2.68.1 Oct 11, 2016
Gemfile 2.64.0 Jul 18, 2016
LICENSE 2.30.1 May 12, 2014
README.rdoc 2.68.0 Oct 10, 2016
Rakefile 2.52.0 Oct 23, 2015
braintree-ruby.gems 2.23.0 May 1, 2013
braintree.gemspec 2.28.0 Dec 31, 2013 2.32.0 Jul 9, 2014


Braintree Ruby Client 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"

Braintree::Configuration.environment = :sandbox
Braintree::Configuration.merchant_id = "your_merchant_id"
Braintree::Configuration.public_key = "your_public_key"
Braintree::Configuration.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. Braintree::Customer.create and Braintree::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 = Braintree::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 = Braintree::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


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.

Open Source Attribution

A list of open source projects that help power Braintree can be found here.


See the LICENSE file.