Skip to main content
Braintree
Previewv1.3.0
53 actions · 36 events · 1 auth method
Payments

Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See Organizations & Projects.
2

Configure the Connector

Enable the connector and set up a Connector Profile in your project. See Setup Connector Profile.

Connector Profile · API Key (Basic Auth)

Braintree uses HTTP Basic Authentication for server-side API access. The public key serves as the username and the priva…
Optionally, configure receiving Events for Braintree into StackOne.

Webhooks setup

3

Link an Account

Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

Link Account · API Key (Basic Auth)

4

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

Actions

53 actions
Action
Description
Create Customer
Create a new customer in the Braintree Vault
Find Customer
Retrieve a specific customer by ID from the Braintree Vault
Update Customer
Update an existing customer in the Braintree Vault
Delete Customer
Delete a customer from the Braintree Vault. Also deletes all their payment methods and cancels all their subscriptions
Search Customers
Search for customers by name, email, phone, or other criteria. Use find_customer instead if you already have the custome…
Create Address
Create a new address for a customer in the Braintree Vault
Find Address
Retrieve a specific address by customer_id and address_id from the Braintree Vault
Update Address
Update an existing address by customer_id and address_id in the Braintree Vault
Delete Address
Delete an address by customer_id and address_id from the Braintree Vault
Create Transaction (Sale)
Create a new sale transaction. Requires amount and at least one payment source — payment_method_nonce, payment_method_t…
Find Transaction
Retrieve a specific transaction by its ID
Search Transactions
Search for transactions (payments) using advanced criteria. Use search_disputes instead to search for chargebacks/disput…
Refund Transaction
Refund a transaction that has already settled or is settling. Use void_transaction instead for unsettled transactions
Void Transaction
Void a transaction before it settles (status must be authorized or submitted_for_settlement). Use refund_transaction ins…
Submit Transaction For Settlement
Submit an authorized transaction for settlement
Submit Transaction For Partial Settlement
Submit a partial settlement against a parent authorization
Update Transaction Details
Update the details of a submitted-for-settlement transaction
Create Subscription
Enroll a customer in a recurring billing subscription. Requires plan_id (from list_plans) and a payment source (payment_…
Find Subscription
Retrieve a specific subscription by its ID.
Update Subscription
Update an existing subscription by its ID. Plan changes must match the current billing cycle frequency
Cancel Subscription
Cancel an existing subscription by its ID.
Search Subscriptions
Search for subscriptions using advanced search criteria.
Retry Subscription Charge
Retry a charge on a subscription that is in Past Due status
List Plans
Retrieve all plans from the Braintree Vault.
Create Plan
Create a new subscription plan template (defines billing rules). Use create_subscription to enroll a customer in a plan
Find Plan
Retrieve a specific plan by its ID.
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
Retrieve a specific dispute by its ID.
Search Disputes
Search for disputes (chargebacks/retrievals) using advanced criteria. Use search_transactions instead to search payment…
Accept Dispute
Accept a dispute (concede the chargeback). Only OPEN disputes can be accepted.
Finalize Dispute
Finalize a dispute (submit evidence to issuing bank). Only OPEN disputes can be finalized.
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
Add text content (refund ID, tracking number, etc.) as evidence to a dispute
Remove Dispute Evidence
Remove a specific piece of evidence from a dispute by dispute_id and evidence_id
Create Payment Method
Create any payment method type (credit card, PayPal, bank account) in the Vault for an existing customer
Find Payment Method
Retrieve any payment method type by its token (works for credit cards, PayPal, bank accounts)
Update Payment Method
Update any payment method type in the Vault by its token (works for credit cards, PayPal, bank accounts)
Delete Payment Method
Delete any payment method type from the Vault by its token (works for credit cards, PayPal, bank accounts)
Create Credit Card
Create a credit card specifically (not PayPal or other types) in the Vault for an existing customer
Find Credit Card
Retrieve a credit card specifically by its token (use find_payment_method for any payment type)
Update Credit Card
Update an existing credit card specifically by its token (use update_payment_method for any payment type)
Delete Credit Card
Delete a credit card specifically from the Vault by its token (use delete_payment_method for any payment type)
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)
Find Payment Method Nonce
Inspect a payment method nonce without consuming it (get nonce from create_payment_method_nonce or client-side SDK)
Create Verification
Verify a credit card without creating a transaction. Pass either payment_method_nonce or credit_card details inside the…
Search Verifications
Search for credit card verifications using advanced criteria. The created_at date filter uses MM/DD/YY HH:MM format, not…
List Merchant Accounts
Retrieve all merchant accounts
Find Merchant Account
Retrieve a specific merchant account by ID. Use list_merchant_accounts first to get available IDs
Generate Client Token
Generate a client token for client-side SDK authorization. Pass options only when customer_id is also provided
List Add-Ons
Retrieve all add-ons configured in the Braintree gateway
List Discounts
Retrieve all discounts configured in the Braintree gateway
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
Find All Transaction Line Items
Retrieve all line items for a specific transaction

Events

|
36 events
Event
Description
Tags
Check URL Verification
Manual setup
Acknowledges the Braintree Control Panel Check URL notification (kind check) without emitting an event.
Verification
Subscription Billing Skipped Webhook
Manual setup
Processes the Braintree subscription_billing_skipped webhook notification, sent when a subscription billing cycle is ski…
SubscriptionsWebhooks
Subscription Canceled Webhook
Manual setup
Processes the Braintree subscription_canceled webhook notification, sent when a subscription is canceled.
SubscriptionsWebhooks
Subscription Charged Successfully Webhook
Manual setup
Processes the Braintree subscription_charged_successfully webhook notification, sent when a recurring subscription charg…
SubscriptionsWebhooks
Subscription Charged Unsuccessfully Webhook
Manual setup
Processes the Braintree subscription_charged_unsuccessfully webhook notification, sent when a recurring subscription cha…
SubscriptionsWebhooks
Subscription Expired Webhook
Manual setup
Processes the Braintree subscription_expired webhook notification, sent when a subscription reaches the end of its billi…
SubscriptionsWebhooks
Subscription Trial Ended Webhook
Manual setup
Processes the Braintree subscription_trial_ended webhook notification, sent when a subscription’s trial period ends.
SubscriptionsWebhooks
Subscription Went Active Webhook
Manual setup
Processes the Braintree subscription_went_active webhook notification, sent when a subscription becomes Active (its firs…
SubscriptionsWebhooks
Subscription Went Past Due Webhook
Manual setup
Processes the Braintree subscription_went_past_due webhook notification, sent when a subscription moves to Past Due afte…
SubscriptionsWebhooks
Dispute Opened Webhook
Manual setup
Processes the Braintree dispute_opened webhook notification, sent when a new dispute (chargeback, retrieval or pre-arbit…
DisputesWebhooks
Dispute Under Review Webhook
Manual setup
Processes the Braintree dispute_under_review webhook notification, sent when a dispute moves to under review.
DisputesWebhooks
Dispute Accepted Webhook
Manual setup
Processes the Braintree dispute_accepted webhook notification, sent when the merchant accepts a dispute.
DisputesWebhooks
Dispute Auto Accepted Webhook
Manual setup
Processes the Braintree dispute_auto_accepted webhook notification, sent when a dispute is accepted automatically becaus…
DisputesWebhooks
Dispute Disputed Webhook
Manual setup
Processes the Braintree dispute_disputed webhook notification, sent when the merchant finalizes evidence and contests a…
DisputesWebhooks
Dispute Expired Webhook
Manual setup
Processes the Braintree dispute_expired webhook notification, sent when a dispute expires without a merchant response.
DisputesWebhooks
Dispute Won Webhook
Manual setup
Processes the Braintree dispute_won webhook notification, sent when a dispute is resolved in the merchant’s favour.
DisputesWebhooks
Dispute Lost Webhook
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
Manual setup
Processes the Braintree disputed_transaction_custom_fields_updated webhook notification, sent when a custom field on a d…
DisputesWebhooks
Transaction Disbursed Webhook
Manual setup
Processes the Braintree transaction_disbursed webhook notification, sent when a transaction is disbursed to the merchant…
TransactionsWebhooks
Transaction Settled Webhook
Manual setup
Processes the Braintree transaction_settled webhook notification, sent when a transaction settles (sent for ACH / US ban…
TransactionsWebhooks
Transaction Settlement Declined Webhook
Manual setup
Processes the Braintree transaction_settlement_declined webhook notification, sent when settlement of a transaction is d…
TransactionsWebhooks
Transaction Reviewed Webhook
Manual setup
Processes the Braintree transaction_reviewed webhook notification, sent when a Fraud Protection Advanced decision on a t…
TransactionsWebhooks
Transaction Retried Webhook
Manual setup
Processes the Braintree transaction_retried webhook notification, sent when Braintree retries a declined transaction.
TransactionsWebhooks
Refund Failed Webhook
Manual setup
Processes the Braintree refund_failed webhook notification, sent when a refund transaction fails.
RefundsWebhooks
Disbursement Webhook
Manual setup
Processes the Braintree disbursement webhook notification, sent when a disbursement (payout of settled funds) is created…
DisbursementsWebhooks
Local Payment Completed Webhook
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
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
Manual setup
Processes the Braintree local_payment_funded webhook notification, sent when a local payment is funded.
Local PaymentsWebhooks
Local Payment Reversed Webhook
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
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
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
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
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
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
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
Manual setup
Processes the Braintree recipient_updated_granted_payment_method webhook notification, sent when the recipient updates a…
Grant APIWebhooks