Set Up Your Serveranchor

Server side payment token flowDiagram demonstrating the required interaction between the client, our servers, and your server.

Install and configureanchor


Requires Ruby 2.6 or later.

Add the braintree gem to your project's Gemfile:

  1. Ruby
gem "braintree", "~> 4.20.0"

And run bundle install to install it.

In your code, configure the environment and API credentials:

  1. Ruby
gateway =
  :environment => :sandbox,
  :merchant_id => "use_your_merchant_id",
  :public_key => "use_your_public_key",
  :private_key => "use_your_private_key",

See the Braintree Ruby Version Changelog.

Generate a client tokenanchor

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 customer_id when generating the client token lets returning customers select from previously used payment method options, improving user experience over multiple checkouts.

  1. Ruby
# pass client_token to your front-end
@client_token = gateway.client_token.generate(
  :customer_id => a_customer_id

If the customer can't be found, it will raise an ArgumentError.

Set Up Your Client covers the client side of the exchange.

Send a client token to your clientanchor

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

  1. Ruby
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 clientanchor

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.

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

Create a transactionanchor

You can create a transaction using an amount and the nonce_from_the_client you received in the previous step.

Collect device data from the client and include the device_data_from_the_client in the transaction.

  1. Ruby
result =
  :amount => "10.00",
  :payment_method_nonce => nonce_from_the_client,
  :device_data => device_data_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 integrationanchor

See our Testing page for values you can use for nonce_from_the_client in your sandbox account. These nonces can be passed as strings through server-side calls to generate payment methods in the desired state. 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 productionanchor

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.

Further readinganchor

Next Page: Go Live