Braintree integration summary

Stitch’s Braintree integration replicates data using the Braintree API . Refer to the Schema 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.

STITCH
Release status

Released on March 1, 2017

 Supported by

Singer Community
Stitch plan

Standard

 API availability

Available
Singer GitHub repository

singer-io/tap-braintree
REPLICATION SETTINGS
Anchor Scheduling

Supported

 Advanced Scheduling

Supported
Table-level reset

Unsupported

 Configurable Replication Methods

Unsupported
DATA SELECTION
Table selection

Unsupported

 Column selection

Unsupported
Select all

Unsupported
TRANSPARENCY
Extraction Logs

Supported

 Loading Reports

Supported

Connecting Braintree

Braintree setup requirements

To set up Braintree in Stitch, you need:

Additionally, Stitch’s Braintree integration will only replicate transactions for the default merchant account in your Braintree instance. You can verify the merchant account set as the default by going to Settings > 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

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

  1. Sign into your Stitch account, if you haven’t already.
  2. Click User menu (your icon) > Manage Account Settings and locate the Data pipeline region section to verify your account’s region.

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

Step 1.2: Whitelist Stitch's IP addresses

  1. Sign into your Braintree account.
  2. Click Settings > Security.
  3. In the Security Options page, click Edit in the IP and Hostname Restrictions section.
  4. In the IP Address or Hostname field, paste one of the data pipeline region IP addresses you retrieved in the previous step.
  5. Check the Allow API Access box.
  6. Click Add Allowed Host.
  7. Repeat steps 4-6 for each Stitch IP address for your data pipeline region.
  8. After all of Stitch’s IP addresses have been added, click Enable Restrictions.

Step 2: Retrieve your Braintree API credentials

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

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

    Braintree API credentials.

Leave the Braintree Client Library Key page open for now - you’ll need the Public Key, Private Key, and Merchant 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 the Add Integration button.

  3. Click the Braintree 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 called stitch_braintree in the destination. Note: Schema names cannot be changed after you save the integration.

  5. In the Merchant ID field, paste your Braintree Merchant ID.
  6. In the Public Key field, paste your Braintree Public Key.
  7. In the Private 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 data equal 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 of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.

Step 5: Create a replication schedule

In the Replication Frequency section, you’ll create the integration’s replication 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:

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

Initial and historical replication jobs

After you finish setting up Braintree, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.

For a new integration, a Pending 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

transactions

The transactions table contains info about the transactions in your Braintree account, including the transaction’s status.

Note: Our Braintree integration will only replicate transactions for the default merchant account in your Braintree instance. You can verify the merchant account set as the default by going to Settings > Processing > Merchant Accounts when signed into Braintree.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

created_at
Useful links

Braintree documentation

transactions schema on GitHub

transactions table schema

amount

NUMBER

created_at

DATE-TIME

credit_card_details

OBJECT

Click to expand credit_card_details

card_type

STRING

customer_location

STRING

currency_iso_code

STRING

customer_details

OBJECT

Click to expand customer_details

email

STRING

id

STRING

disbursement_details

OBJECT

gateway_rejection_reason

STRING

id

STRING

merchant_account_id

STRING

order_id

STRING

payment_instrument_type

STRING

paypal_details

OBJECT

plan_id

STRING

processor_authorization_code

STRING

processor_response_code

STRING

processor_response_text

STRING

recurring

BOOLEAN

refunded_transaction_id

STRING

service_fee_amount

NUMBER

settlement_batch_id

STRING

status

STRING

subscription_details

OBJECT

Click to expand subscription_details

billing_period_end_date

DATE-TIME

billing_period_start_date

DATE-TIME

subscription_id

STRING

type

STRING

updated_at

DATE-TIME

Related Troubleshooting
Questions? Feedback?

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