Braintree
Connect Braintree as a source in Reveal Transactions so Reveal can import historical transaction data and monitor live payment activity for authorization performance, declines, disputes, and related insights.
Reveal needs three credentials from Braintree:
- Merchant ID
- Public Key
- Private Key
Connecting Braintree does not change how Braintree processes payments. Reveal reads data for analytics only.
Note
Braintree’s Control Panel labels and navigation can change. This page lists what Reveal requires. For the latest Braintree UI steps, use Braintree’s documentation.
Choose how to create Braintree API keys
Create the three credentials in either of these ways:
- Read-only access (recommended) — Create a limited Braintree role and API user, then generate keys for that user. See Braintree read-only access.
- Account admin keys — Generate keys while signed in as a Braintree user with Account Admin access. Use this only if your security policy allows broader API access.
When you have Merchant ID, Public Key, and Private Key, continue with the Reveal steps below.
Create API keys as a Braintree Account Admin
Skip this section if you already created keys with read-only access.
What Reveal needs from this step: production (or sandbox) Merchant ID, Public Key, and Private Key for the user whose keys you will connect.
In Braintree, sign in with Account Admin access and open API authorizations for that user. Copy:
- Public Key and Private Key from the API keys for that user
- Merchant ID for the gateway environment you are connecting
For Braintree’s guidance on API users and where to find these values, see Braintree: go live (API credentials section). Use the Control Panel for the same environment you intend to connect (sandbox or production).
Add Braintree as a source in Reveal
- Open the Reveal dashboard and select Transactions from the toggle at the top of the page.
- Click Sources in the left navigation, then click Add source.
- Select Braintree.
- Enter the Merchant ID, Public Key, and Private Key you copied from Braintree (from the read-only or Account Admin key setup above).
- Enter an Alias so you can recognize this Gateway Account in Reveal.
- Click Connect.
After a successful connection, Reveal starts importing historical Braintree data and continues to monitor activity. Initial load time depends on transaction volume.
Configure the Braintree webhook
Reveal needs a Braintree webhook so live events continue after the initial import. You copy the URL from Reveal, then create the webhook in Braintree.
Get the webhook URL from Reveal
- In Reveal, go to Sources and find the Braintree source you just added.
- Copy the webhook URL shown for that source.
Create the webhook in Braintree
What Reveal needs from this step: a Braintree webhook whose destination URL is the Reveal webhook URL, with notification types that include transaction and dispute-related events (at minimum).
In Braintree, create a new webhook, paste the Reveal URL as the destination, and select the notification kinds your team needs for live updates. The user who creates the webhook must have permission to manage webhooks.
Follow Braintree’s Control Panel steps here: Create a webhook. For webhook permissions on a role, see Webhooks overview.
Take the next step
- Braintree read-only access: Create least-privilege Braintree API keys for Reveal.
- Get started with Transactions: Connect other processors and see what happens after data loads.
- Insights: Review authorization health after Braintree data is available.
- Settlements Braintree: Connect the same Braintree account for reconciliation and fees if you also use Settlements.
Was this article helpful?