Connecting Braintree to ChartMogul

You must be an Admin in both Braintree and ChartMogul to complete the following steps.

Braintree is one of ChartMogul's supported billing systems.

Here's what we cover in this article:

Before you begin

Please review the following details before completing the steps outlined in this article.

  • You'll need to select which environment ChartMogul will import data from Braintree. Learn more about the environment.
  • Locate your Braintree Merchant ID.
  • Once connected, ChartMogul automatically imports lead and trial data from Braintree. Since Braintree doesn’t track the date a lead is created, ChartMogul calculates this by taking the first billing date, subtracting the trial interval, and adjusting the result to your time zone.

Step 1 — Create a read-only API key

ChartMogul uses API keys to connect Braintree to ChartMogul. For added security, we recommend creating a read-only user in Braintree and using the API keys from this user to grant ChartMogul access to your Braintree account.

  1. Log in as admin to your Braintree account and go to Settings > Team > Roles > + New Role.
  2. Give the role a name like Read-only.
  3. Uncheck all permissions except:
    • Transactions > Download Transactions with Masked Payment Data
    • Customer Management> Download Vault Records with Masked Payment Data
    • Recurring Billing
      • Download Subscription Records
      • View Modifications
      • View Subscription Plans
      • View Subscriptions
      • Search Subscriptions
    • Read-Only Access (ALL)
    • Search (ALL)
       
  4. Next, go to Settings > Team > Users > + New user.
    • Give the user API Access
    • Assign the read-only role you previously created
    • Assign access to the merchant accounts (usually all of them).
  5. Now log out of Braintree and log back in as this new read-only user.
  6. Then go to Account > My User > Api Keys.
  7. Note the Public Key and Private Key as you'll need these when adding Braintree as a source.
  8. Log out of the read-only user Braintree account.

Step 2 — Add Braintree as a source

  1. Within ChartMogul, navigate to Data Platform > Sources
  2. Add a source by clicking ADD A SOURCE.
    add_a_source.png
  3. Select Braintree.
  4. Enter a name for your source and click Next.

Step 3 — Connect Braintree

  1. Select the Environment: Sandbox or Production.
  2. Enter your Public Key and Private Keys from the read-only user you created in Step 1.
  3. Enter your Merchant ID.
  4. Click Save.
  5. ChartMogul generates a Webhook URL that you'll need to add to Braintree.

Step 4 — Add a webhook to keep your data synced

  1. Log in to your Braintree account using your Account Admin credentials.
  2. Navigate to your Braintree Control Panel and from Settings in the top menu, select Webhooks.
  3. Click New Webhook. Then, paste in the Webhook URL from Step 3 in the Destination URL field.
  4. Configure the following options and then click Save.

Step 5 — Import your historical data

In ChartMogul, click IMPORT DATA. This will connect the Braintree webhook to your ChartMogul account and start your data import.

The import can take some time depending on the number of customers. After the import has concluded, ChartMogul will update automatically with any new activity from Braintree.

Was this article helpful?

We’re sorry to hear that. Would you like to share more feedback?


Thanks for your feedback!