Connecting Braintree

Connecting to Braintree uses API keys. If you have not had the values supplied to you, you will need a Braintree login with Account Admin access.

To set up Braintree you will need:

  • Your Merchant ID
  • Public Key
  • Private Key

If you don't have these, follow the steps below.

  1. Log in to Braintree at braintreegateway.com/login.

  2. Select Settings → API, then select Generate API Key.

    📘

    Tip

    Don't share API keys between multiple systems.

    Braintree dashboard Settings menu with the API option highlighted

  3. Find the key you just generated and select View.

    API Keys screen with the Generate New API Key button highlighted

    API Keys screen with the View link highlighted on the new key

  4. From the key detail screen, copy the values for your Merchant ID, Public Key, and Private Key.

    Client Library Key screen showing Public Key, Private Key, Environment, and Merchant ID

  5. Enter these values in the Braintree connection screen. The connection is tested and you are shown a green "Connected to Braintree" message. If there is an error with the connection, an error message will appear.

    📘

    Tip

    If the connection fails, make sure Environment says live — unless you know you are working in a sandbox environment.

    Connected to Braintree confirmation with currency merchant account mappings and AVS option

Connection options

Our integration with Braintree offers several options:

  • Public Key: Update if you change your credentials.
  • Private Key: Update if you change your credentials.
  • Currencies: Braintree only allows you to collect payment in the currency of one of your merchant accounts. We provide a list of each currency you have configured and let you select which merchant account to settle into (see below).
  • Require address (AVS): Requires the customer to enter their billing address.

Adding currencies

To add support for more currencies, go to Settings → Business.

Braintree dashboard Settings menu with the Business option highlighted

Here you can see the merchant accounts you have configured and add new ones. After adding a new one, return to the Braintree connection screen and the new merchant account will appear under its currency.

Braintree Merchant Accounts screen with the New Merchant Account button highlighted

For example, to support AUD, add a merchant account in AUD. (The screenshot below is a test account; the live screen will vary slightly.)

New Merchant Account form with a Merchant Account ID and AUD currency selected