Braintree

What’s supported

Supported actions

This connector supports:

• Read Actions, including full historic backfill. Please note that incremental read is supported for customers, transactions, refunds, disputes, verifications, and payments objects.
• Write Actions.
• Proxy Actions, using the base URL https://payments.sandbox.braintree-api.com/graphql.

Supported Objects

The Braintree connector supports reading from the following objects:

• customers
• transactions
• refunds
• disputes
• verifications
• merchantAccounts
• inStoreLocations
• inStoreReaders
• businessAccountCreationRequests
• payments

The Braintree connector supports writing to the following objects:

• customers (create/update)
• transactions (charge/capture)
• paymentMethods (create/update)

Example integration

To define an integration for Braintree, create a manifest file that looks like this:

# amp.yaml
specVersion: 1.0.0
integrations:
  - name: braintree-integration
    displayName: My Braintree Integration
    provider: braintree
    read:
      objects:
        - objectName: customers
          destination: myWebhook
          schedule: "*/10 * * * *"
        - objectName: transactions
          destination: myWebhook
          schedule: "*/10 * * * *"
    write:
      objects:
        - objectName: customers
    proxy:
      enabled: true

Using the connector

This connector uses Basic Auth, so you do not need to configure a Provider App before getting started. (Provider Apps are only required for providers using the OAuth2 Authorization Code grant type.)

To integrate with Braintree:

• Create a manifest file similar to the example above.
• Deploy it using the amp CLI.
• If you are using Read Actions, create a destination.
• Embed the InstallIntegration UI component, which will prompt the customer for their API credentials.
• Start using the connector!
  • If your integration has Read Actions, you’ll start getting webhook messages.
  • If your integration has Write Actions, you can start making API calls to our Write API.
  • If your integration has Proxy Actions, you can start making Proxy API calls.

Getting API credentials for Braintree

1. Log in to your Braintree Control Panel.
2. Navigate to Settings > API Keys.
3. Generate or view your API credentials (Public Key, Private Key, and Merchant ID).

For more details, see the Braintree API Credentials documentation.

Note: Make sure you’re using the correct environment (Sandbox or Production) credentials.