airbyte/docs/integrations/sources/braintree.md

Braintree

This page contains the setup guide and reference information for the Braintree source connector.

Prerequisites

To set up the Braintree source connector, you'll need Braintree's:

1. Public Key
2. Environment
3. Merchant ID
4. Private Key

We recommend creating a restricted, read-only key specifically for Airbyte access. This will allow you to control which resources Airbyte should be able to access.

Set up the Braintree connector in Airbyte

1. Log into your Airbyte Cloud account or navigate to the Airbyte Open Source dashboard.
2. Click Sources and then click + New source.
3. On the Set up the source page, select Braintree from the Source type dropdown.
4. Enter the name for the Braintree connector.
5. For Public Key, enter your Braintree Public Key.
6. For Start Date, enter the date in YYYY-MM-DDTHH:mm:ssZ format. The data added on and after this date will be replicated.
7. For Environment, choose the appropriate option from the dropdown.
8. For Merchant ID, enter your Braintree Merchant ID.
9. For Private Key, enter your Braintree Private Key.
10. Click Set up source.

Sync overview

This source can sync data for the Braintree API. It supports both Full Refresh and Incremental syncs. You can choose if this connector will copy only the new or updated data, or all rows in the tables and columns you set up for replication, every time a sync is run.

Supported Sync Modes

Feature	Supported?(Yes/No)	Notes
Full Refresh Sync	Yes
Incremental Sync	Yes
Namespaces	No

Supported Streams

The following streams are supported:

• Customers
• Discounts
• Disputes
• Transactions
• Merchant Accounts
• Plans
• Subscriptions

Data type mapping

Integration Type	Airbyte Type	Notes
string	string
number	number
array	array
object	object

Performance considerations

The connector is restricted by normal Braintree requests limitation on search transactions.

The Braintree connector should not run into Braintree API limitations under normal usage. Please create an issue if you see any rate limit issues that are not automatically retried successfully.

Changelog

Expand to review

Version	Date	Pull Request	Subject
0.3.28	2025-02-01	52894	Update dependencies
0.3.27	2025-01-25	51769	Update dependencies
0.3.26	2025-01-11	51238	Update dependencies
0.3.25	2024-12-28	50500	Update dependencies
0.3.24	2024-12-21	50211	Update dependencies
0.3.23	2024-12-14	49556	Update dependencies
0.3.22	2024-12-12	49032	Starting with this version, the Docker image is now rootless. Please note that this and future versions will not be compatible with Airbyte versions earlier than 0.64
0.3.21	2024-11-04	48212	Update dependencies
0.3.20	2024-10-21	47062	Update dependencies
0.3.19	2024-10-12	46849	Update dependencies
0.3.18	2024-10-05	46496	Update dependencies
0.3.17	2024-09-28	46180	Update dependencies
0.3.16	2024-09-21	45810	Update dependencies
0.3.15	2024-09-14	45555	Update dependencies
0.3.14	2024-09-07	45310	Update dependencies
0.3.13	2024-08-31	45041	Update dependencies
0.3.12	2024-08-24	44287	Update dependencies
0.3.11	2024-08-12	43953	Corrects timezone handling
0.3.10	2024-08-10	43666	Update dependencies
0.3.9	2024-08-03	43225	Update dependencies
0.3.8	2024-07-29	42848	Corrects pagination issues
0.3.7	2024-07-27	42796	Update dependencies
0.3.6	2024-07-20	42372	Update dependencies
0.3.5	2024-07-18	42096	Adds pagination to get more than 50 records per sync
0.3.4	2024-07-13	41340	Update dependencies
0.3.3	2024-07-09	41312	Update dependencies
0.3.2	2024-07-06	40863	Update dependencies
0.3.1	2024-07-02	40693	Corrects subscription stream fields
0.2.1	2023-11-08	31489	Fix transaction stream custom fields
0.2.0	2023-07-17	29200	Migrate connector to low-code framework
0.1.5	2023-05-24	26340	Fix error in check_connection in integration tests
0.1.4	2023-03-13	23548	Update braintree python library version to 4.18.1
0.1.3	2021-12-23	8434	Update fields in source-connectors specifications
0.1.2	2021-12-22	9042	Fix $ref in schema and spec
0.1.1	2021-10-27	7432	Dispute model should accept multiple Evidences
0.1.0	2021-08-17	5362	Initial version