Braintree

Braintree is an online and in-app payment platform.

Braintree integration replicates data using the Braintree API.

See the Schema section for a list of objects available for replication.

A high-level look at this connector, including useful links, and supported features.

Feature/Capability	Support details
Supported Qlik Talend Data Integration projects	Replication projects only. Data pipeline projects are not supported.
Target update methods	Replication tasks: Apply changes Store changes Landing data in a data lake tasks: Change data capture (CDC)
Managing metadata	Manual metadata generation is not required.
Schema evolution	Only the Change column data type operation is supported.
Replication of LOB columns (NCLOB, CLOB, and BLOB)	Not supported.
Scheduled CDC	Required. This is how the target is kept up-to-date with changes to the source. For replication tasks, see Scheduling tasks For lake landing tasks, see Scheduling CDC for lake landing tasks
Notifications	Partially supported Setting notifications for changes in operation
Monitoring	CDC-only, as full load is not relevant for this connector. Monitoring an individual data task
Automatic denesting of JSON column payloads	Not supported. JSON column payloads in source datasets are not denested automatically on the target.

Preparing for authentication

To access your data, you need to authenticate the connection with your account credentials.

Make sure that the account you use has read access to the tables you want to fetch.

To set up your Braintree account, you need:

Super Admin and API Access permissions in Braintree. This is required to create the API access token. For more information, see Braintree user roles and permissions.
Additionally, Braintree replicates transactions for the default merchant account in your Braintree instance.

To retrieve your private key:

Log into your Braintree account.
Click Account > My User.
Scroll down to the API Keys, Tokenization Keys, Encryption Keys section.
Click View Authorizations.
In the API Keys section, click Generate New API Key.
After the key has been generated, click the View link in the Private Key column.
The Client Library Key page is displayed with your Braintree API credentials.

Creating the connection

For more information, see Connecting to SaaS applications.

Fill in the required connection properties.
Provide a name for the connection in Connection name.
Select Open connection metadata to define metadata for the connection when it has been created.
Click Create.

Connection settings
Setting	Description
Data gateway	Select a Data Movement gateway if required by your use case. Information note This field is not available with the Qlik Talend Cloud Starter subscription, as it does not support Data Movement gateway. If you have another subscription tier and do not want to use Data Movement gateway, select None. For information on the benefits of Data Movement gateway and use cases that require it, see Qlik Data Gateway - Data Movement.
Start Date	Enter the date, in the format `MM/DD/YYYY`, from which the data must be replicated from your source to your target.
Merchant ID	Merchant ID.
Private Key	Private key.
Public Key	Public key.
Environment	Enter a value: Development, QA, Sandbox, Production, or All. If left empty, Production is set as default.

Schema

Schemas and naming conventions can change from version to version. It is recommended to verify your version before continuing.

The schema and info displayed below is for version 1.

Depending on your destination, table and column names may not appear as they are outlined below.

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	CDC
Primary Key	id
Replication Key	created_at
Useful links	Braintree documentation

amount

NUMBER

created_at

DATE-TIME

credit_card_details

OBJECT

This is a nested data structure:

card_type: STRING
customer_location: STRING

currency_iso_code

STRING

customer_details

OBJECT

This is a nested data structure:

email: STRING
id: STRING

disbursement_details

OBJECT

gateway_rejection_reason

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

This is a nested data structure:

billing_period_end_date: DATE-TIME
billing_period_start_date: DATE-TIME

subscription_id

STRING

type

STRING

updated_at

DATE-TIME

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!

Leave your feedback here