> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Braintree

> How to set up the Braintree connector, plus the actions and events that are available.

![Braintree](https://stackone-logos.com/api/braintree/filled/svg)

v2.0.0[See changelog](https://docs.stackone.com/connectors/braintree/changelog.md)

[55 actions](#actions) · [36 events](#events) · 2 auth methods

Payments

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key (Basic Auth) · Connector Profile](https://docs.stackone.com/connectors/braintree/guides/connector-profile/api-key-basic-auth.md)
>
> Braintree uses HTTP Basic Authentication for server-side API access. The public key serves as the username and the priva...

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/braintree/guides/connector-profile/oauth-2-0.md)
>
> Requires creating an OAuth app in the Braintree Control Panel. Production OAuth is in closed beta.

Optionally, configure receiving Events for Braintree into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/braintree/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key (Basic Auth) · Link Account](https://docs.stackone.com/connectors/braintree/guides/link-account/api-key-basic-auth.md)

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/braintree/guides/link-account/oauth-2-0.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

API Key (Basic Auth)

OAuth 2.0

No auth methods found

Scopes

Select all
|
Clear

address:create

address:delete

address:find

address:update

client\_token:generate

credit\_card\_verification:search

customer:create

customer:delete

customer:find

customer:search

customer:update

dispute:find

dispute:search

document\_upload:create

merchant\_account:all

merchant\_account:find

payment\_method:create

payment\_method:delete

payment\_method:find

payment\_method:update

payment\_method\_nonce:create

payment\_method\_nonce:find

subscription:cancel

subscription:create

subscription:find

subscription:search

subscription:update

transaction:find

transaction:manage\_settlement

transaction:refund

transaction:sale

transaction:search

transaction:void

No scopes found

55 actions

ActionDescriptionRequired scopes

Create Customer`braintree_create_customer`

Create a new customer in the Braintree Vault

`customer:create`

Find Customer`braintree_find_customer`

Retrieve a specific customer by ID from the Braintree Vault

`customer:find`

Update Customer`braintree_update_customer`

Update an existing customer in the Braintree Vault

`customer:update`

Delete Customer`braintree_delete_customer`

Delete a customer from the Braintree Vault. Also deletes all their payment methods and cancels all their subscriptions

`customer:delete`

Search Customers`braintree_search_customers`

Search for customers by name, email, phone, or other criteria. Use find\_customer instead if you already have the custome...

`customer:search`

Create Address`braintree_create_address`

Create a new address for a customer in the Braintree Vault

`address:create`

Find Address`braintree_find_address`

Retrieve a specific address by customer\_id and address\_id from the Braintree Vault

`address:find`

Update Address`braintree_update_address`

Update an existing address by customer\_id and address\_id in the Braintree Vault

`address:update`

Delete Address`braintree_delete_address`

Delete an address by customer\_id and address\_id from the Braintree Vault

`address:delete`

Create Transaction (Sale)`braintree_create_transaction_sale`

Create a new sale transaction. Requires amount and at least one payment source -- payment\_method\_nonce, payment\_method\_t...

`transaction:sale`

Find Transaction`braintree_find_transaction`

Retrieve a specific transaction by its ID

`transaction:find`

Search Transactions`braintree_search_transactions`

Search for transactions (payments) using advanced criteria. Use search\_disputes instead to search for chargebacks/disput...

`transaction:search`

Search Transaction IDs`braintree_search_transaction_ids`

Return the IDs of every transaction matching search criteria, without the full records.

`transaction:search`

Refund Transaction`braintree_refund_transaction`

Refund a transaction that has already settled or is settling. Use void\_transaction instead for unsettled transactions

`transaction:refund`

Void Transaction`braintree_void_transaction`

Void a transaction before it settles (status must be authorized or submitted\_for\_settlement). Use refund\_transaction ins...

`transaction:void`

Submit Transaction For Settlement`braintree_submit_transaction_for_settlement`

Submit an authorized transaction for settlement

`transaction:manage_settlement`

Submit Transaction For Partial Settlement`braintree_submit_transaction_for_partial_settlement`

Submit a partial settlement against a parent authorization

`transaction:manage_settlement`

Update Transaction Details`braintree_update_transaction_details`

Update the details of a submitted-for-settlement transaction

Create Subscription`braintree_create_subscription`

Enroll a customer in a recurring billing subscription. Requires plan\_id (from list\_plans) and a payment source (payment\_...

`subscription:create`

Find Subscription`braintree_find_subscription`

Retrieve a specific subscription by its ID.

`subscription:find`

Update Subscription`braintree_update_subscription`

Update an existing subscription by its ID. Plan changes must match the current billing cycle frequency

`subscription:update`

Cancel Subscription`braintree_cancel_subscription`

Cancel an existing subscription by its ID.

`subscription:cancel`

Search Subscriptions`braintree_search_subscriptions`

Search for subscriptions using advanced search criteria.

`subscription:search`

Search Subscription IDs`braintree_search_subscription_ids`

Return the IDs of every subscription matching search criteria, without the full records.

`subscription:search`

Retry Subscription Charge`braintree_retry_subscription_charge`

Retry a charge on a subscription that is in Past Due status

`transaction:sale`

List Plans`braintree_list_plans`

Retrieve all plans from the Braintree Vault.

Create Plan`braintree_create_plan`

Create a new subscription plan template (defines billing rules). Use create\_subscription to enroll a customer in a plan

Find Plan`braintree_find_plan`

Retrieve a specific plan by its ID.

Update Plan`braintree_update_plan`

Update an existing plan by its ID. Re-send the plan's add-ons and discounts in the same call or they are dropped

Find Dispute`braintree_find_dispute`

Retrieve a specific dispute by its ID.

`dispute:find`

Search Disputes`braintree_search_disputes`

Search for disputes (chargebacks/retrievals) using advanced criteria. Use search\_transactions instead to search payment...

`dispute:search`

Accept Dispute`braintree_accept_dispute`

Accept a dispute (concede the chargeback). Only OPEN disputes can be accepted.

Finalize Dispute`braintree_finalize_dispute`

Finalize a dispute (submit evidence to issuing bank). Only OPEN disputes can be finalized.

Add Dispute File Evidence`braintree_add_dispute_file_evidence`

Add a previously uploaded file as evidence to a dispute (requires document\_upload\_id from create\_document\_upload)

Add Dispute Text Evidence`braintree_add_dispute_text_evidence`

Add text content (refund ID, tracking number, etc.) as evidence to a dispute

Remove Dispute Evidence`braintree_remove_dispute_evidence`

Remove a specific piece of evidence from a dispute by dispute\_id and evidence\_id

Create Payment Method`braintree_create_payment_method`

Create any payment method type (credit card, PayPal, bank account) in the Vault for an existing customer

`payment_method:create`

Find Payment Method`braintree_find_payment_method`

Retrieve any payment method type by its token (works for credit cards, PayPal, bank accounts)

`payment_method:find`

Update Payment Method`braintree_update_payment_method`

Update any payment method type in the Vault by its token (works for credit cards, PayPal, bank accounts)

`payment_method:update`

Delete Payment Method`braintree_delete_payment_method`

Delete any payment method type from the Vault by its token (works for credit cards, PayPal, bank accounts)

`payment_method:delete`

Create Credit Card`braintree_create_credit_card`

Create a credit card specifically (not PayPal or other types) in the Vault for an existing customer

`payment_method:create`

Find Credit Card`braintree_find_credit_card`

Retrieve a credit card specifically by its token (use find\_payment\_method for any payment type)

`payment_method:find`

Update Credit Card`braintree_update_credit_card`

Update an existing credit card specifically by its token (use update\_payment\_method for any payment type)

`payment_method:update`

Delete Credit Card`braintree_delete_credit_card`

Delete a credit card specifically from the Vault by its token (use delete\_payment\_method for any payment type)

`payment_method:delete`

Create Payment Method Nonce`braintree_create_payment_method_nonce`

Create a one-time-use nonce from a vaulted payment method token (get token from find\_customer or find\_payment\_method)

`payment_method_nonce:create`

Find Payment Method Nonce`braintree_find_payment_method_nonce`

Inspect a payment method nonce without consuming it (get nonce from create\_payment\_method\_nonce or client-side SDK)

`payment_method_nonce:find`

Create Verification`braintree_create_verification`

Verify a credit card without creating a transaction. Pass either payment\_method\_nonce or credit\_card details inside the...

Search Verifications`braintree_search_verifications`

Search for credit card verifications using advanced criteria. The created\_at date filter uses MM/DD/YY HH:MM format, not...

`credit_card_verification:search`

List Merchant Accounts`braintree_list_merchant_accounts`

Retrieve all merchant accounts

`merchant_account:all`

Find Merchant Account`braintree_find_merchant_account`

Retrieve a specific merchant account by ID. Use list\_merchant\_accounts first to get available IDs

`merchant_account:find`

Generate Client Token`braintree_generate_client_token`

Generate a client token for client-side SDK authorization. Pass options only when customer\_id is also provided

`client_token:generate`

List Add-Ons`braintree_list_add_ons`

Retrieve all add-ons configured in the Braintree gateway

List Discounts`braintree_list_discounts`

Retrieve all discounts configured in the Braintree gateway

Create Document Upload`braintree_create_document_upload`

Upload a document file (png/jpg/pdf, max 4MB) to get a document\_upload\_id for use with add\_dispute\_file\_evidence

`document_upload:create`

Find All Transaction Line Items`braintree_find_all_transaction_line_items`

Retrieve all line items for a specific transaction

`transaction:find`

## Events

Tags

Select all
|
Clear

Account Updater

Disbursements

Disputes

Grant API

Local Payments

Payment Methods

Refunds

Subscriptions

Transactions

Verification

Webhooks

No tags found

36 events

EventDescriptionTags

Check URL Verification`braintree_webhook_check`Manual setup

Acknowledges the Braintree Control Panel Check URL notification (kind check) without emitting an event.

Verification

Subscription Billing Skipped Webhook`braintree_webhook_subscription_billing_skipped`Manual setup

Processes the Braintree subscription\_billing\_skipped webhook notification, sent when a subscription billing cycle is ski...

SubscriptionsWebhooks

Subscription Canceled Webhook`braintree_webhook_subscription_canceled`Manual setup

Processes the Braintree subscription\_canceled webhook notification, sent when a subscription is canceled.

SubscriptionsWebhooks

Subscription Charged Successfully Webhook`braintree_webhook_subscription_charged_successfully`Manual setup

Processes the Braintree subscription\_charged\_successfully webhook notification, sent when a recurring subscription charg...

SubscriptionsWebhooks

Subscription Charged Unsuccessfully Webhook`braintree_webhook_subscription_charged_unsuccessfully`Manual setup

Processes the Braintree subscription\_charged\_unsuccessfully webhook notification, sent when a recurring subscription cha...

SubscriptionsWebhooks

Subscription Expired Webhook`braintree_webhook_subscription_expired`Manual setup

Processes the Braintree subscription\_expired webhook notification, sent when a subscription reaches the end of its billi...

SubscriptionsWebhooks

Subscription Trial Ended Webhook`braintree_webhook_subscription_trial_ended`Manual setup

Processes the Braintree subscription\_trial\_ended webhook notification, sent when a subscription's trial period ends.

SubscriptionsWebhooks

Subscription Went Active Webhook`braintree_webhook_subscription_went_active`Manual setup

Processes the Braintree subscription\_went\_active webhook notification, sent when a subscription becomes Active (its firs...

SubscriptionsWebhooks

Subscription Went Past Due Webhook`braintree_webhook_subscription_went_past_due`Manual setup

Processes the Braintree subscription\_went\_past\_due webhook notification, sent when a subscription moves to Past Due afte...

SubscriptionsWebhooks

Dispute Opened Webhook`braintree_webhook_dispute_opened`Manual setup

Processes the Braintree dispute\_opened webhook notification, sent when a new dispute (chargeback, retrieval or pre-arbit...

DisputesWebhooks

Dispute Under Review Webhook`braintree_webhook_dispute_under_review`Manual setup

Processes the Braintree dispute\_under\_review webhook notification, sent when a dispute moves to under review.

DisputesWebhooks

Dispute Accepted Webhook`braintree_webhook_dispute_accepted`Manual setup

Processes the Braintree dispute\_accepted webhook notification, sent when the merchant accepts a dispute.

DisputesWebhooks

Dispute Auto Accepted Webhook`braintree_webhook_dispute_auto_accepted`Manual setup

Processes the Braintree dispute\_auto\_accepted webhook notification, sent when a dispute is accepted automatically becaus...

DisputesWebhooks

Dispute Disputed Webhook`braintree_webhook_dispute_disputed`Manual setup

Processes the Braintree dispute\_disputed webhook notification, sent when the merchant finalizes evidence and contests a...

DisputesWebhooks

Dispute Expired Webhook`braintree_webhook_dispute_expired`Manual setup

Processes the Braintree dispute\_expired webhook notification, sent when a dispute expires without a merchant response.

DisputesWebhooks

Dispute Won Webhook`braintree_webhook_dispute_won`Manual setup

Processes the Braintree dispute\_won webhook notification, sent when a dispute is resolved in the merchant's favour.

DisputesWebhooks

Dispute Lost Webhook`braintree_webhook_dispute_lost`Manual setup

Processes the Braintree dispute\_lost webhook notification, sent when a dispute is resolved against the merchant.

DisputesWebhooks

Disputed Transaction Custom Fields Updated Webhook`braintree_webhook_disputed_transaction_custom_fields_updated`Manual setup

Processes the Braintree disputed\_transaction\_custom\_fields\_updated webhook notification, sent when a custom field on a d...

DisputesWebhooks

Transaction Disbursed Webhook`braintree_webhook_transaction_disbursed`Manual setup

Processes the Braintree transaction\_disbursed webhook notification, sent when a transaction is disbursed to the merchant...

TransactionsWebhooks

Transaction Settled Webhook`braintree_webhook_transaction_settled`Manual setup

Processes the Braintree transaction\_settled webhook notification, sent when a transaction settles (sent for ACH / US ban...

TransactionsWebhooks

Transaction Settlement Declined Webhook`braintree_webhook_transaction_settlement_declined`Manual setup

Processes the Braintree transaction\_settlement\_declined webhook notification, sent when settlement of a transaction is d...

TransactionsWebhooks

Transaction Reviewed Webhook`braintree_webhook_transaction_reviewed`Manual setup

Processes the Braintree transaction\_reviewed webhook notification, sent when a Fraud Protection Advanced decision on a t...

TransactionsWebhooks

Transaction Retried Webhook`braintree_webhook_transaction_retried`Manual setup

Processes the Braintree transaction\_retried webhook notification, sent when Braintree retries a declined transaction.

TransactionsWebhooks

Refund Failed Webhook`braintree_webhook_refund_failed`Manual setup

Processes the Braintree refund\_failed webhook notification, sent when a refund transaction fails.

RefundsWebhooks

Disbursement Webhook`braintree_webhook_disbursement`Manual setup

Processes the Braintree disbursement webhook notification, sent when a disbursement (payout of settled funds) is created...

DisbursementsWebhooks

Local Payment Completed Webhook`braintree_webhook_local_payment_completed`Manual setup

Processes the Braintree local\_payment\_completed webhook notification, sent when a buyer completes a local payment method...

Local PaymentsWebhooks

Local Payment Expired Webhook`braintree_webhook_local_payment_expired`Manual setup

Processes the Braintree local\_payment\_expired webhook notification, sent when a local payment expires before it is funde...

Local PaymentsWebhooks

Local Payment Funded Webhook`braintree_webhook_local_payment_funded`Manual setup

Processes the Braintree local\_payment\_funded webhook notification, sent when a local payment is funded.

Local PaymentsWebhooks

Local Payment Reversed Webhook`braintree_webhook_local_payment_reversed`Manual setup

Processes the Braintree local\_payment\_reversed webhook notification, sent when a local payment is reversed.

Local PaymentsWebhooks

Payment Method Revoked By Customer Webhook`braintree_webhook_payment_method_revoked_by_customer`Manual setup

Processes the Braintree payment\_method\_revoked\_by\_customer webhook notification, sent when a customer revokes a vaulted...

Payment MethodsWebhooks

Payment Method Customer Data Updated Webhook`braintree_webhook_payment_method_customer_data_updated`Manual setup

Processes the Braintree payment\_method\_customer\_data\_updated webhook notification, sent when customer data behind a vaul...

Payment MethodsWebhooks

Account Updater Daily Report Webhook`braintree_webhook_account_updater_daily_report`Manual setup

Processes the Braintree account\_updater\_daily\_report webhook notification, sent when the daily Account Updater report of...

Account UpdaterWebhooks

Granted Payment Instrument Update Webhook`braintree_webhook_granted_payment_instrument_update`Manual setup

Processes the Braintree granted\_payment\_instrument\_update webhook notification, sent when a payment instrument shared th...

Grant APIWebhooks

Granted Payment Method Revoked Webhook`braintree_webhook_granted_payment_method_revoked`Manual setup

Processes the Braintree granted\_payment\_method\_revoked webhook notification, sent when a payment method shared through t...

Grant APIWebhooks

Grantor Updated Granted Payment Method Webhook`braintree_webhook_grantor_updated_granted_payment_method`Manual setup

Processes the Braintree grantor\_updated\_granted\_payment\_method webhook notification, sent when the grantor updates a pay...

Grant APIWebhooks

Recipient Updated Granted Payment Method Webhook`braintree_webhook_recipient_updated_granted_payment_method`Manual setup

Processes the Braintree recipient\_updated\_granted\_payment\_method webhook notification, sent when the recipient updates a...

Grant APIWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.