Already have an account? Sign in

Braintree (v1)

Braintree integration summary

Stitch’s Braintree integration replicates data using theBraintree API. Refer to theSchema section for a list of objects available for replication.

Braintree feature snapshot

A high-level look at Stitch's Braintree (v1) integration, including release status, useful links, and the features supported in Stitch.

Connecting Braintree

Braintree setup requirements

To set up Braintree in Stitch, you need:

• Access to a Production Braintree account. Stitch does not currently support connecting to Sandbox accounts.

• Super Admin and API Access permissions in Braintree. This is required to create the API access token in Braintree.You can find info on Braintree user roles and permissions here.

Additionally, Stitch’s Braintree integration will only replicate transactions for thedefault merchant account in your Braintree instance. You can verify the merchant account set as the default by going toSettings > Processing > Merchant Accounts when signed into Braintree.

Step 1: Whitelist Stitch's IP addresses in Braintree

• Step 1.1: Verify your Stitch account’s data pipeline region

• Step 1.2: Whitelist Stitch’s IP addresses

Step 1.1: Verify your Stitch account's data pipeline region

The IP addresses you’ll whitelist depend on theData pipeline region your account is in.

1. Sign into your Stitch account, if you haven’t already.
2. ClickUser menu (your icon) > Edit User Settings and locate theData pipeline region section to verify your account’s region.

3. Locate the list of IP addresses for your region:

   • North America region IP addresses

   • Europe region IP addresses

Step 1.2: Whitelist Stitch's IP addresses

1. Sign into your Braintree account.
2. ClickSettings > Security.
3. In theSecurity Options page, clickEdit in theIP and Hostname Restrictions section.
4. In theIP Address or Hostname field, paste one of the data pipeline region IP addresses you retrieved in theprevious step.
5. Check theAllow API Access box.
6. ClickAdd Allowed Host.
7. Repeat steps 4-6for each Stitch IP address for your data pipeline region.
8. After all of Stitch’s IP addresses have been added, clickEnable Restrictions.

Step 2: Retrieve your Braintree API credentials

1. If you haven’t already, sign into your Braintree account.
2. ClickAccount > My User.
3. Scroll down to theAPI Keys, Tokenization Keys, Encryption Keys section and clickView Authorizations.
4. In theAPI Keys section, clickGenerate New API Key.
5. After the key has been generated, click theView link in thePrivate Key column.

6. This will display theClient Library Key page, which contains your Braintree API credentials:

   

Leave the Braintree Client Library Key page open for now - you’ll need thePublic Key,Private Key, andMerchant ID to complete the setup in Stitch.

Step 3: Add Braintree as a Stitch data source

1. Sign into your Stitch account.

2. On the Stitch Dashboard page, click theAdd Integration button.

3. Click theBraintree icon.

4. Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.

   For example, the name “Stitch Braintree” would create a schema calledstitch_braintree in the destination.Note: Schema names cannot be changed after you save the integration.

5. In theMerchant ID field, paste your Braintree Merchant ID.
6. In thePublic Key field, paste your Braintree Public Key.
7. In thePrivate Key field, paste your Braintree Private Key.

Step 4: Define the historical replication start date

The Sync Historical Data setting defines the starting date for your Braintree integration. This means that dataequal to or newer than this date will be replicated to your data warehouse.

Change this setting if you want to replicate data beyond Braintree’s default setting of1 year. For a detailed look at historical replication jobs, check out theSyncing Historical SaaS Data guide.

Step 5: Create a replication schedule

In theReplication Frequency section, you’ll create the integration’sreplication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.

Braintree integrations support the following replication scheduling methods:

• Replication Frequency

• Anchor Scheduling

• Advanced Scheduling using Cron (Advanced or Premium plans only)

To keep your row usage low, consider setting the integration to replicate less frequently. See theUnderstanding and Reducing Your Row Usage guide for tips on reducing your usage.

Initial and historical replication jobs

After you finish setting up Braintree, itsSync Status may show asPending on either the Stitch Dashboard or in the Integration Details page.

For a new integration, aPending status indicates that Stitch is in the process of scheduling the initial replication job for the integration.This may take some time to complete.

Free historical data loads

The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.

Braintree table reference

Did this article help? If you have questions or feedback, feel free tosubmit a pull request with your suggestions,open an issue on GitHub, orreach out to us.