Need help with braintree_ruby?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

417 Stars 206 Forks MIT License 203 Commits 5 Opened issues


Braintree Ruby library

Services available


Need anything else?

Contributors list

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.


gem install braintree

Or add to your Gemfile:

gem 'braintree'

Optionally, you may also include LibXML for more performant XML parsing. If LibXML is not present, REXML will be used instead.

gem 'libxml-ruby'


  • builder

The Braintree Ruby SDK is tested against Ruby versions 2.6, 2.7 and 3.0.

The Ruby core development community has released End-of-Life branches for Ruby versions lower than 2.6, which are no longer receiving security updates. As a result, Braintree no longer supports these versions of Ruby. We have updated our gem specifications to reflect these updates.


Braintree employs a deprecation policy for our SDKs. For more information on the statuses of an SDK check our developer docs. Minimum supported versions are also available in our developer docs.

| Major version number | Status | Released | Deprecated | Unsupported | | -------------------- | ----------- | ------------- | ------------ | ------------ | | 4.x.x | Active | May 2021 | TBA | TBA | | 3.x.x | Inactive | October 2020 | May 2023 | May 2024 | | 2.x.x | Inactive | April 2010 | October 2022 | October 2023 |


Updating from an Inactive, Deprecated, or Unsupported version of this SDK? Check our Migration Guide for tips.

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}" else p result.errors end

You retrieve your

, and
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.

). The non-bang version will either return a
or an
. The bang version will either return the created or updated resource, or it will raise a

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.

Developing (Docker)


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


The Rakefile includes commands to run Rubocop. To run the linter commands use rake:

rake lint


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.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.