Braintree Payments

Last updated on Feb 03, 2023

Prerequisites

An active Braintree Payments account with Super Admin and API Access permissions. You can assign these permissions at the time of Braintree account creation. Read Managing Users and Roles for steps to create and edit roles for users.
A public, private API key and merchant ID to provide Hevo access to your Braintree Payments account data.

Obtaining the Public, Private API Keys, and Merchant ID

Hevo supports the Production and Sandbox environments for Braintree. In order to ingest your Braintree account data and load it into your desired Destination, you must fetch the public, private API keys, and the merchant ID for your environment. The steps to obtain these keys differ, depending on the environment. You must refer to the sections below for your specific environment.

Using production environment

Perform the following steps to find the public, private API keys, and the merchant ID:

Log in to your Braintree Account.
In the top right corner, click Account, and then click My User.
In the Edit User page, under API Keys, Tokenization Keys, Encryption Keys, click View Authorizations.
In the API Keys section, under the Private Key column, click View corresponding to the public key of your choice. You can also choose to generate a new API key by clicking Generate New API Key.
In the Client Library Key page, copy the Public Key, Private Key, and Merchant ID and store them. These keys are required while setting up a Pipeline in Hevo.

Using sandbox environment

Perform the following steps to find the public, private API keys, and the merchant ID:

Log in to your Braintree Sandbox Account.
In the top right corner, click the Settings ( ) icon, and then click API.
In the API Keys section, under the Private Key column, click View corresponding to the public key of your choice. You can also choose to generate a new API key by clicking + Generate New API Key.
In the Client Library Key page, copy the Public Key, Private Key, and Merchant ID and store them. These keys are required while setting up a Pipeline in Hevo.

Configuring Braintree Payments as a Source

Perform the following steps to configure Braintree Payments as the Source in your Pipeline:

Click PIPELINES in the Asset Palette.
Click + CREATE in the Pipelines List View.
In the Select Source Type page, select Braintree Payments.
In the Configure your Braintree Payments Source page, specify the following:
- Pipeline Name: A unique name for your Pipeline, not exceeding 255 characters.
- Public Key: The public key that you obtained from your Braintree Payments account. Refer to section, Obtaining the Public, Private API Keys, and Merchant ID for steps to fetch the public key for your environment.
- Private Key: The private key that you obtained from your Braintree Payments account. Refer to section, Obtaining the Public, Private API Keys, and Merchant ID for steps to fetch the private key for your environment.
- Merchant ID: The ID for your merchant account. Refer to section, Obtaining the Public, Private API Keys, and Merchant ID for steps to fetch your merchant ID.
- Historical Sync Duration: The duration for which the existing data in the Source must be ingested. Default value: 3 Months.
Click TEST & CONTINUE.
Proceed to configuring the data ingestion and setting up the Destination.

Data Replication

Default Pipeline Frequency	Minimum Pipeline Frequency	Maximum Pipeline Frequency	Custom Frequency Range (Hrs)
30 Mins	15 Mins	24 Hrs	1-24

Note: The custom frequency must be set in hours, as an integer value. For example, 1, 2, 3 but not 1.5 or 1.75.

Historical Data: In the first run of the Pipeline, Hevo ingests historical data for all the objects on the basis of the historical sync duration selected at the time of creating the Pipeline and loads it to the Destination. Default duration: 3 Months.
Incremental Data: Once the historical load is complete, all new and updated records for the Registered Customer, Transaction, Credit Card Verification, and Subscription objects are synchronized with your Destination, as per the Pipeline frequency.

Note: Merchant Account and Plan are Full Load objects, and the entire data is fetched in each run of the Pipeline.

Schema and Primary Keys

Hevo uses the following schema to upload the records in the Destination:

Data Model

The following is the list of tables (objects) that are created at the Destination when you run the Pipeline:

Object	Description
Credit Card Verification	Contains information about the credit card, such as the credit card type, number, expiration date, cardholder’s name, and email address.
Merchant Account	- Contains information about a master merchant or sub-merchant, such as the merchant ID, name, email, address, phone, and status of the account. - This is a Full Load object.
Plan	- Contains information about your customer’s plan, such as the billing day of the month, interval of the plan, currency in which the plan was purchased, and any discounts associated with the plan. - This is a Full Load object.
Registered Customer	Contains information about your customer, such as the customer ID, name, email, address, and the credit cards they hold.
Subscription	Contains the information about your customer’s subscription, such as the plan ID, price, next billing date, discounts, and any add-ons associated with the subscription.
Transaction	Contains the information about your customer’s transactions, such as the transaction ID, order ID, payment instrument type, payment receipt, billing details, and shipping details.

Note: The Full Load objects may lead to higher Events quota consumption.

Additional Information

Read the detailed Hevo documentation for the following related topics:

Source Considerations

Source Considerations

By default, Braintree does not capture any updates or deletes in data. For capturing these updates or deletes, you must restart your historical load every time, by restarting your Pipeline or the specific objects.

Limitations

None.

Revision History

Refer to the following table for the list of key updates made to this page:

Date	Release	Description of Change
May-24-2022	1.89	New document.