Braintree Module Documentation

Braintree Environment Setup


Set up your Braintree Account

  1. Login to your Braintree console
  2. Generate an API key by navigating to Account > My User > API Keys
  3. Note these values because they will be needed when you configure your environment properties

Once you have established an account with Braintree, begin by including the Braintree Module dependency to your pom.xml.


Make sure to include the dependency in your core pom.xml as well:


You should now begin to setup your environment to work with Broadleaf Commerce Braintree support.
The first step is to make Broadleaf Commerce aware of your Braintree account credentials.
This is accomplished through environment configuration (see Runtime Environment Configuration).

Broadleaf allows you to create your own property files per environment (e.g.,,,,,, and
You will need to enter the following key/value pairs in the appropriate locations and replace the "?" with your Braintree API account details:

You can also store these configs in the Database by utilizing the blSystemPropertiesService

Properties File Config

  • gateway.braintree.publicKey=?
  • gateway.braintree.privateKey=?
  • gateway.braintree.merchantId=?
  • gateway.braintree.useRelativeUrls=false
  • gateway.braintree.environment=SANDBOX

Production Property Config

  • gateway.braintree.environment=PRODUCTION