Skip to content
This repository has been archived by the owner on Apr 14, 2023. It is now read-only.



⛔️ This extension is archived. ⛔️

It has been renamed and moved to solidus_braintree.

If you were using this project, you can follow the instructions to upgrade to the new extension.

CircleCI codecov

solidus_paypal_braintree is an extension that adds support for using Braintree as a payment source in your Solidus store. It supports Apple Pay, PayPal, and credit card transactions.

🚧 This extension is currently only compatible with the legacy solidus_frontend 🚧


Add solidus_paypal_braintree to your Gemfile:

gem 'solidus_paypal_braintree', github: 'solidusio/solidus_paypal_braintree', branch: :master

Bundle your dependencies and run the installation generator:

bundle exec rails g solidus_paypal_braintree:install

Basic Setup

Retrieve Braintree account details

You'll need the following account details:

  • Merchant ID
  • Public key
  • Private key

These values can be obtained by logging in to your Braintree account, going to Account -> My User and clicking View Authorizations in the API Keys, Tokenization Keys, Encryption Keys section.

Create a new payment method

Payment methods can accept preferences either directly entered in admin, or from a static source in code. For most projects we recommend using a static source, so that sensitive account credentials are not stored in the database.

  1. Set static preferences in an initializer
# config/initializers/spree.rb
Rails.application.config.to_prepare do
    'braintree_credentials', {
      environment: Rails.env.production? ? 'production' : 'sandbox',
      merchant_id: ENV['BRAINTREE_MERCHANT_ID'],
      public_key: ENV['BRAINTREE_PUBLIC_KEY'],
      private_key: ENV['BRAINTREE_PRIVATE_KEY'],
      paypal_flow: 'vault', # 'checkout' is accepted too
      use_data_collector: true # Fingerprint the user's browser when using Paypal

Other optional preferences are discussed below.

  1. Visit /admin/payment_methods/new

  2. Set provider to SolidusPaypalBraintree::Gateway

  3. Click "Save"

  4. Choose braintree_credentials from the Preference Source select

  5. Click Update to save

Alternatively, create a payment method from the Rails console with:
  name: "Braintree",
  preference_source: "braintree_credentials"

Configure payment types

Your payment method can accept payments in three ways: through Paypal, through ApplePay, or with credit card details entered directly by the customer. By default all are disabled for all your site's stores. Before proceeding to checkout, ensure you've created a Braintree configuration for your store:

  1. Visit /solidus_paypal_braintree/configurations/list

  2. Check the payment types you'd like to accept. If your site has multiple stores, there'll be a set of checkboxes for each.

  3. Click Save changes to save

Or from the console:

Spree::Store.all.each do |store|
    credit_card: true,
    paypal: true,
    apple_pay: true,
    venmo: true
  1. If your site uses an unmodified solidus_frontend, it should now be ready to take payments. See below for more information on configuring Paypal and ApplePay.

  2. Typical Solidus sites will have customized frontend code, and may require some additional work. Use lib/views/frontend/spree/checkout/payment/_paypal_braintree.html.erb and app/assets/javascripts/solidus_paypal_braintree/checkout.js as models.

Apple Pay

Developing with Apple Pay

You'll need the following:

  • A device running iOS 10+.
  • An Apple Pay sandbox account. You can check out Apple's documentation for additional help in performing this step.
  • A site served via HTTPS. To set this up for development we recommend setting up a reverse proxy server. There are lots of guides on how this can be achieved.
  • A Braintree sandbox account with Apple Pay enabled (Settings>Processing) and configured (Settings>Processing>Options) with your Apple Merchant ID and the HTTPS domain for your site.
  • A sandbox user logged in to your device, with a test card in its Wallet

Enabling Apple Pay for custom frontends

The following is a relatively bare-bones implementation to enable Apple Pay on the frontend:

<% if current_store.braintree_configuration.apple_pay? %>
  <script src=""></script>

  <button id="apple-pay-button" class="apple-pay-button"></button>

    var applePayButtonElement = document.getElementById('apple-pay-button');
    var applePayOptions = {
      paymentMethodId: <%= id %>,
      storeName: "<%= %>",
      orderEmail: "<%= %>",
      amount: "<%= %>",
      shippingContact: {
        emailAddress: '<%= %>',
        givenName: '<%= address.firstname %>',
        familyName: '<%= address.lastname %>',
        phoneNumber: '<%= %>',
        addressLines: ['<%= address.address1 %>','<%= address.address2 %>'],
        locality: '<%= %>',
        administrativeArea: '<%= %>',
        postalCode: '<%= address.zipcode %>',
        country: '<%= %>',
        countryCode: '<%= %>'
    var button = new SolidusPaypalBraintree.createApplePayButton(applePayButtonElement, applePayOptions);
<% end %>

Further Apple Pay information

Braintree has some excellent documentation on what you'll need to do to get Apple Pay up and running.

For additional information check out Apple's documentation and Braintree's documentation.


There are two ways for users to use Venmo for payments:

  1. Braintree's native Venmo integration, which supports vaulting of payment sources. See more.
  2. Through the PayPal buttons when using checkout flow, therefore doesn't support vaulting. See more.

PayPal's Venmo financing option

To add Venmo for PayPal, see here

Braintree's Venmo



  1. Enable Venmo in your Braintree account
  2. Enable Venmo in your store's Braintree configuration.
  3. Ensure your Braintree API credentials are in the Braintree payment method.
  4. Set your Braintree payment method's preference of preferred_venmo_new_tab_support to false if your store cannot handle Venmo returning a user to a new tab after payment. This may be because your website is a single-page applicaiton (SPA). On mobile, the user may be returned to the same store tab if their browser supports it, otherwise a new tab will be created (unless you have this preference as false).

By default your default Venmo business account will be used. If you want to use a non-default profile, override the SolidusPaypalBraintree::Gateway #venmo_business_profile_id method with its id.


Test the following scenarios:

  • Ensure the Venmo checkout button opens a modal with a QR code and is closeable.
  • Do a full transaction
  • Ensure that you can also save the payment source in the user wallet.
  • Ensure the saved Venmo wallet payment source loads in the partial correctly.
  • Ensure the saved Venmo payment source can be reused for another order.
  • Test doing transactions on the admin
  • Testing voiding and refunding Venmo transactions

You'll need the Venmo app in order to fully test the integration. However, if you are outside of the US, this is not an option. You can fake the tokenization by:

  • Altering the venmo_button.js file to call the handleVenmoSuccess function instead of tokenizing; or
  • Manually doing its steps:
    1. Update the #venmo_payment_method_nonce hidden input value to "fake-venmo-account-nonce".
    2. Remove the disabled attributes from the venmo-fields inputs.
    3. If you have hosted fields on the page (credit_card enabled in Braintree configuration), remove it's submit button listener: $('#checkout_form_payment').off('submit');

More information


In your store's Braintree configuration, you can customize the Venmo checkout button's color and width.

Note, other images such as Venmo's full logo and shortened "V" logo are included in the assets.

Ensure that you follow Venmo's guidelines when making other style changes, otherwise failing to comply can lead to an interruption of your Venmo service.


A default checkout view is provided that will display PayPal as a payment option. It will only be displayed if the SolidusPaypalBraintree::Gateway payment method is configured to display on the frontend and PayPal is enabled in the store's configuration.

You can find button configuration options in /solidus_paypal_braintree/configurations/list if you want to change the color, shape, layout, and a few other options. For more information check out PayPal's documentation.

Keep in mind that:

  • paypal_button_tagline does not work when the paypal_button_layout is set to vertical, and will be ignored; and
  • paypal_button_layout of horizontal limits financing options/buttons to 2, where as vertical is 4. Other available financing options after the limit will not be rendered in the PayPal's iframe DOM.

The checkout view initializes the PayPal button using the Vault flow, which allows the source to be reused. Please note that PayPal messaging is disabled with vault flow. If you want, you can use Checkout with PayPal instead, which doesn't allow you to reuse sources but allows your customers to pay with their PayPal balance and with PayPal financing options (see setup instructions). More information about other financing options below.

If you are creating your own checkout view or would like to customize the options that get passed to tokenize , you can initialize your own using the CreatePaypalButton JS object:

var paypalOptions = {
  // your configuration options here

var button = new SolidusPaypalBraintree.createPaypalButton(document.querySelector("#your-button-id"), paypalOptions);


Express checkout from the cart

A PayPal button can also be included on the cart view to enable express checkouts:

render "spree/shared/paypal_cart_button"

PayPal financing options

When using 'checkout' paypal flow and not 'vault'. Your customers can have different finance options such as

  • paylater
  • Venmo

PayPal Venmo

Venmo is currently available to US merchants and buyers. There are also other prequisites.

By default, the extension and Braintree will try to render a Venmo button to buyers when prequisites are met and you have enabled it in your Braintree account).

Set the SolidusPaypalBraintree PaymentMethod enable_venmo_funding preference to:

  • enabled, available as a PayPal funding option (if other prequisites are met); or
  • disabled (default).

Note, Venmo is currently only available as a financing option on the checkout page; Venmo currently does not support shipping callbacks so it cannot be on the cart page.

As Venmo is only available in the US, you may want to mock your location for testing

PayPal Financing Messaging

PayPal offers an on-site messaging component to notify the customer that there are financing options available. This component is included in both the cart and checkout partials, but is disabled by default. To enable this option, you'll need to use the checkout flow, and set the paypal button messaging option to true in your Braintree configuration.

You can also include this view partial to implement this messaging component anywhere - for instance, on the product page:

render "spree/shared/paypal_messaging, options: {total: @product.price, placement: "product", currency: 'USD'}"

While we provide the messaging component on the payment buttons for cart and checkout, you're expected to move these to where they make the most sense for your frontend. PayPal recommends keeping the messaging directly below wherever the order or product total is located.

PayPal configuration

If your store requires the phone number into user addresses you'll need to configure PayPal to return the phone back when it returns the address used by the user:

  1. Log into your PayPal account
  2. Hover over the user in the Navbar to get the dropdown
  3. Click on Account Settings
  4. In the left panel under Products & Services, click Website Payments
  5. Click Update for Website Preferences
  6. Set Contact Telephone to On (Required Field) or On (Optional Field)

Using the option Off will not make the address valid and will raise a validation error.

Disabling the data collector

For fraud prevention, PayPal recommends using a data collector to collect device information, which we've included by default. You're able to turn off the PayPal data collector on the payment method preferences if you desire. If you use static preferences, add use_data_collector: false to your initializer.

Optional configuration

Accepting multiple currencies

The payment method also provides an optional preference merchant_currency_map. This preference allows users to provide different Merchant Account Ids for different currencies. If you only plan to accept payment in one currency, the defaut Merchant Account Id will be used and you can omit this option. An example of setting this preference can be found here.

In addition to this, you can also specify different PayPal accounts for each currency by using the paypal_payee_email_map preference. If you only want to use one PayPal account for all currencies, then you can ignore this option. You can find an example of setting this preference here.

Default store configuration

The migrations for this gem will add a default configuration to all stores that has each payment type disabled. It also adds a before_create callback to Spree::Store that builds a default configuration. You can customize the default configuration that gets created by overriding the private build_default_configuration method on Spree::Store.

Hosted Fields Styling

You can style the Braintree credit card fields by using the credit_card_fields_style preference on the payment method. The credit_card_fields_style will be passed to the style key when initializing the credit card fields. You can find more information about styling hosted fields can be found here.

You can also use the placeholder_text preference on the payment method to set the placeholder text you'd like to use for each of the hosted fields. You'll pass the field name in as the key, and the placeholder text you'd like to use as the value. For example:

  { number: "Enter card number", cvv: "Enter CVV", expirationDate: "mm/yy" }

3D Secure

This gem supports 3D Secure 2, which satisfies the Strong Customer Authentication (SCA) requirements introduced by PSD2.

3D Secure can be enabled from Solidus Admin -> Braintree (left-side menu) -> tick 3D Secure checkbox.

Once enabled, you can use the following card numbers to test 3DS 2 on your client side in sandbox:


To run the specs it is required to set the Braintree test account data in these environment variables: BRAINTREE_PUBLIC_KEY, BRAINTREE_PRIVATE_KEY, BRAINTREE_MERCHANT_ID and BRAINTREE_PAYPAL_PAYEE_EMAIL

First bundle your dependencies, then run rake. rake will default to building the dummy app if it does not exist, then it will run specs, and Rubocop static code analysis. The dummy app can be regenerated by using rake test_app.

bundle exec rake

When testing your applications integration with this extension you may use it's factories. Simply add this require statement to your spec_helper:

require 'solidus_paypal_braintree/factories'


Mocking your buyer country

PayPal looks at the buyer's IP geolocation to determine what funding sources should be available to them. Because for example, Venmo is currently only available to US buyers. Because of this, you may want to pretend that you are from US so you can check if Venmo is correctly integrated for these customers. To do this, set the payment method's preference of force_buyer_country to "US". See more information about preferences above.

This preference has no effect on production.

Running the sandbox

To run this extension in a sandboxed Solidus application, you can run bin/sandbox. The path for the sandbox app is ./sandbox and bin/rails will forward any Rails commands to sandbox/bin/rails.

Here's an example:

$ bin/rails server
=> Booting Puma
=> Rails 7.0.4 application starting in development
* Listening on tcp://
Use Ctrl-C to stop

Releasing new versions

Please refer to the dedicated page on Solidus wiki.


Copyright (c) 2016-2020 Stembolt and others contributors, released under the New BSD License