From 89fbb8fd80e35a667b5af4d92d358b38df53ca9b Mon Sep 17 00:00:00 2001 From: ejoo Date: Tue, 30 Dec 2025 02:15:43 +0500 Subject: [PATCH] feat(braintree): Update provider guide with Read/Write support - Add Read Actions with incremental read support for multiple objects - Add Write Actions for customers, transactions, and paymentMethods - Add Supported Objects section with API documentation links - Update example integration with read/write configuration - Add detailed instructions for getting API credentials --- src/provider-guides/braintree.mdx | 62 +++++++++++++++++++++++++------ 1 file changed, 50 insertions(+), 12 deletions(-) diff --git a/src/provider-guides/braintree.mdx b/src/provider-guides/braintree.mdx index 32cd759d..0dbb9c51 100644 --- a/src/provider-guides/braintree.mdx +++ b/src/provider-guides/braintree.mdx @@ -6,38 +6,76 @@ title: "Braintree" ### Supported actions This connector supports: +- [Read Actions](/read-actions), including full historic backfill. Please note that incremental read is supported for `customers`, `transactions`, `refunds`, `disputes`, `verifications`, and `payments` objects. +- [Write Actions](/write-actions). - [Proxy 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](https://developer.paypal.com/braintree/graphql/guides/customers/) +- [transactions](https://developer.paypal.com/braintree/graphql/guides/transactions/) +- [refunds](https://developer.paypal.com/braintree/graphql/guides/) +- [disputes](https://developer.paypal.com/braintree/graphql/guides/disputes/) +- [verifications](https://developer.paypal.com/braintree/graphql/guides/) +- [merchantAccounts](https://developer.paypal.com/braintree/graphql/guides/) +- [inStoreLocations](https://developer.paypal.com/braintree/graphql/guides/) +- [inStoreReaders](https://developer.paypal.com/braintree/graphql/guides/) +- [businessAccountCreationRequests](https://developer.paypal.com/braintree/graphql/guides/) +- [payments](https://developer.paypal.com/braintree/graphql/guides/) + +The Braintree connector supports writing to the following objects: +- [customers](https://developer.paypal.com/braintree/graphql/guides/customers/) (create/update) +- [transactions](https://developer.paypal.com/braintree/graphql/guides/transactions/) (charge/capture) +- [paymentMethods](https://developer.paypal.com/braintree/graphql/guides/) (create/update) + ### Example integration To define an integration for Braintree, create a manifest file that looks like this: -```YAML +```yaml # 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 ``` -## Before you get started +## Using the connector -[Click here](https://developer.paypal.com/braintree/articles/control-panel/important-gateway-credentials#api-keys) for detailed information about finding and generating your API credentials (Public Key, Private Key, and Merchant ID) in Braintree. +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**.) -Note: Make sure you're using the correct environment (Sandbox or Production) credentials. +To integrate with Braintree: +- Create a manifest file similar to the example above. +- Deploy it using the [amp CLI](/cli/overview). +- If you are using Read Actions, create a [destination](/destinations). +- Embed the [InstallIntegration](/embeddable-ui-components#install-integration) UI component, which will prompt the customer for their API credentials. +- Start using the connector! + - If your integration has [Read Actions](/read-actions), you'll start getting webhook messages. + - If your integration has [Write Actions](/write-actions), you can start making API calls to our Write API. + - If your integration has [Proxy Actions](/proxy-actions), you can start making Proxy API calls. -## Using the connector +## Getting API credentials for Braintree -This connector uses Basic Auth, which means that you do not need to set up a Provider App before getting started. (Provider apps are only required for providers that use OAuth2 Authorization Code grant type.) +1. Log in to your [Braintree Control Panel](https://www.braintreegateway.com/login). +2. Navigate to **Settings** > **API Keys**. +3. Generate or view your API credentials (Public Key, Private Key, and Merchant ID). -To start integrating with Braintree: -- Create a manifest file like the example above. -- Deploy it using the [amp CLI](/cli/overview). -- Embed the [InstallIntegration](/embeddable-ui-components#install-integration) UI component. The UI component will prompt the customer for their API credentials. -- Start making [Proxy Calls](/proxy-actions), and Ampersand will automatically attach the correct Basic Auth headers to your requests. +For more details, see the [Braintree API Credentials documentation](https://developer.paypal.com/braintree/articles/control-panel/important-gateway-credentials#api-keys). -For detailed information about available GraphQL queries and mutations, refer to the [Braintree API Reference](https://developer.paypal.com/braintree/graphql/). +Note: Make sure you're using the correct environment (Sandbox or Production) credentials.