Install and configure

Add the braintree gem to your project's Gemfile:

gem "braintree"

Supports ruby 1.8 (>= 1.8.6), 1.9, and 2.0

And run bundle install to install it.

See also

In your code, configure the environment and API credentials:

Braintree::Configuration.environment = :sandbox
Braintree::Configuration.merchant_id = "use_your_merchant_id"
Braintree::Configuration.public_key = "use_your_public_key"
Braintree::Configuration.private_key = "use_your_private_key"

Generate a client token

Your server is responsible for generating a client token, which contains all authorization and configuration information your client needs to initialize the client SDK to communicate with Braintree. Including a customerId when generating the client token lets returning customers select from previously used payment method options, improving user experience over multiple checkouts. Set Up Your Client covers the client side of the exchange.

Send a client token to your client

Here is an example of how your server would generate and expose a client token:

get "/client_token" do

How the token is used by the client may vary. In JavaScript integrations the client token is often included in the generated HTML/JS, while in mobile apps the client token must be requested. These methods are discussed in the client token setup section.

Receive a payment method nonce from your client

Once your client successfully obtains a customer payment method, it receives a payment_method_nonce representing customer payment authorization, which it then sends to your server.

Your server implementation is then responsible for receiving the payment_method_nonce and using it appropriately.

post "/checkout" do
  nonce = params[:payment_method_nonce]
  # Use payment method nonce here...

Create a transaction

You can create a transaction using an amount and the payment_method_nonce you receive from your client:

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

The sale call returns a Transaction Result Object which contains the transaction and information about the request.

Test your integration

See our Testing page for values you can use for nonce_from_the_client in your sandbox account. To verify your integration, you can check in the sandbox Control Panel, where transactions will immediately appear on success.

Always develop and test your code against your sandbox account before processing live transactions against a production account.

Transition to production

At this point, you should be able to accept a payment method nonce and create a transaction in our sandbox. When you're ready to start charging real money, transition over to our production environment. We'll explain that process next.

Next: Go Live →

Still Have Questions?

If you can’t find an answer, give us a call at 877.434.2894 or email our Support team.