Skip to content
Find file
Fetching contributors…
Cannot retrieve contributors at this time
69 lines (50 sloc) 1.98 KB

Braintree Ruby Client Library

The Braintree gem provides integration access to the Braintree Gateway.


  • builder

  • libxml-ruby

Quick Start Example

require "rubygems"
require "braintree"

Braintree::Configuration.environment = :sandbox
Braintree::Configuration.merchant_id = "the_merchant_id"
Braintree::Configuration.public_key = "a_public_key"
Braintree::Configuration.private_key = "a_private_key"

transaction =!(
  :amount => "100.00",
  :credit_card => {
    :number => "5105105105105100",
    :expiration_date => "05/12"
puts "Transaction ID: #{}"
puts "Status: #{transaction.status}"

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.


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.


See the LICENSE file.

Something went wrong with that request. Please try again.