The Braintree connector lets your AI agent act in each user's Braintree account. Each user connects their own Braintree API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 27 tools.
- Tools
- 27
- What they doRead · write · destructive
- 13 · 7 · 713 read7 write7 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Braintree connection
In AgentKit > Connections, create a Braintree connection. The name you give it is the
connection_nameyour code passes. See Configure connections.
Tools
Pass the exact name toexecute_toolbraintree_customer_getGet one Braintree vault customer by GraphQL ID, with their vaulted payment methods.Read-onlyGet Customer
Get one Braintree vault customer by GraphQL ID, with their vaulted payment methods. Returns the customer's id, legacyId, name, email, company, phone, website, custom fields, default payment method and payment methods. Use Search Customers to find a customer by email.
Inputs
customer_idstringrequired- Braintree GraphQL ID of the customer (not the legacy ID shown in the Control Panel; convert one with Get ID From Legacy ID). Get it from Search Customers. Example: Y3VzdG9tZXJfYWJjMTIz.
braintree_customers_searchSearch Braintree vault customers by ID, email, name, company, phone or creation date, with cursor paging.Read-onlySearch Customers
Search Braintree vault customers by ID, email, name, company, phone or creation date, with cursor paging. Returns pageInfo and customers with id, legacyId, name, email, company, phone, custom fields, default payment method and vaulted payment methods. Use Get Customer when you have the customer ID.
Inputs
afterstring- Cursor to continue after: the pageInfo.endCursor of the previous page. Example: YXJyYXljb25uZWN0aW9uOjI0.
criteriaobject- Search criteria as a Braintree CustomerSearchInput object. Keys: id {is | in}, email, firstName, lastName, company, phoneNumber as text matches {is | isNot | startsWith | endsWith | contains}, createdAt {greaterThanOrEqualTo, lessThanOrEqualTo}. Pass {} for no filter. Example: {"email": {"is": "jane@example.com"}}.
firstinteger- Number of results to return, 1 to 50. Example: 25.default
25
braintree_dispute_getGet one Braintree dispute by GraphQL ID.Read-onlyGet Dispute
Get one Braintree dispute by GraphQL ID. Returns the dispute's id, status, type, caseNumber, referenceNumber, receivedDate, replyByDate, amounts, transaction, evidence and status history. Use Search Disputes to find open disputes.
Inputs
dispute_idstringrequired- Braintree GraphQL ID of the dispute (not the legacy ID shown in the Control Panel; convert one with Get ID From Legacy ID). Get it from Search Disputes. Example: ZGlzcHV0ZV9hYmMxMjM.
braintree_disputes_searchSearch Braintree disputes (chargebacks, retrievals, pre-arbitration) by status, type, reason, dates and amounts, with cursor paging.Read-onlySearch Disputes
Search Braintree disputes (chargebacks, retrievals, pre-arbitration) by status, type, reason, dates and amounts, with cursor paging. Returns pageInfo and disputes with id, status, type, caseNumber, receivedDate, replyByDate, amountDisputed, amountWon, transaction and evidence. Use Get Dispute for one dispute.
Inputs
afterstring- Cursor to continue after: the pageInfo.endCursor of the previous page. Example: YXJyYXljb25uZWN0aW9uOjI0.
criteriaobject- Search criteria as a Braintree DisputeSearchInput object. Common keys: id {is | in}, status {in: [OPEN, ACCEPTED, DISPUTED, WON, LOST, EXPIRED, ...]}, type {in: [CHARGEBACK, PRE_ARBITRATION, RETRIEVAL]}, receivedDate and replyByDate {greaterThanOrEqualTo, lessThanOrEqualTo} as dates, transaction {transactionId {is}}. Pass {} for no filter. Example: {"status": {"in": ["OPEN"]}}.
firstinteger- Number of results to return, 1 to 50. Example: 25.default
25
braintree_legacy_id_convertConvert a legacy Braintree ID (as shown in the Control Panel and the older SDKs) into the GraphQL ID the other tools need.Read-onlyGet ID From Legacy ID
Convert a legacy Braintree ID (as shown in the Control Panel and the older SDKs) into the GraphQL ID the other tools need. Returns the GraphQL ID. Use this when you only have a Control Panel transaction, customer, refund, dispute or payment method ID.
Inputs
legacy_idstringrequired- Legacy ID from the Control Panel or SDK. Example: 8wb5v7nq.
typestringrequired- What the ID is for: TRANSACTION, CUSTOMER, REFUND, DISPUTE, PAYMENT_METHOD, RECURRING_BILLING_SUBSCRIPTION, RECURRING_BILLING_SUBSCRIPTION_PLAN, VERIFICATION and other Braintree legacy ID types. Example: TRANSACTION.one of
CUSTOMERDISPUTEMERCHANT_ACCOUNT_APPLICATIONPAYMENT_CONTEXTPAYMENT_METHODRECURRING_BILLING_SUBSCRIPTIONRECURRING_BILLING_SUBSCRIPTION_PLANRECURRING_BILLING_SUBSCRIPTION_PLAN_ADD_ONRECURRING_BILLING_SUBSCRIPTION_PLAN_DISCOUNTREFUNDTRANSACTIONUS_BANK_ACCOUNT_VERIFICATIONVERIFICATION
braintree_payment_method_getGet one vaulted Braintree payment method by its GraphQL ID.Read-onlyGet Payment Method
Get one vaulted Braintree payment method by its GraphQL ID. Returns the payment method's id, legacyId, usage, createdAt, details type and customer. Use Get Customer to list a customer's payment methods.
Inputs
payment_method_idstringrequired- Braintree GraphQL ID of the payment method (not the legacy ID shown in the Control Panel; convert one with Get ID From Legacy ID). Get it from Get Customer. Example: cGF5bWVudG1ldGhvZF9jY19hYmMxMjM.
braintree_pingCheck that the Braintree connection and credentials work.Read-onlyPing
Check that the Braintree connection and credentials work. Returns the string pong. Use this to test a new connection. Use Get Viewer for merchant details.
Inputs
This tool takes no inputs.
braintree_refunds_searchSearch Braintree refunds by status, date, amount, order ID or customer, with cursor paging.Read-onlySearch Refunds
Search Braintree refunds by status, date, amount, order ID or customer, with cursor paging. Returns pageInfo and refunds with id, legacyId, createdAt, status, orderId, amount, refunded transaction and status history. Use Refund Transaction to create a refund.
Inputs
afterstring- Cursor to continue after: the pageInfo.endCursor of the previous page. Example: YXJyYXljb25uZWN0aW9uOjI0.
criteriaobject- Search criteria as a Braintree RefundSearchInput object. Common keys: id {is | in}, status {in: [...]}, createdAt {greaterThanOrEqualTo, lessThanOrEqualTo}, amount {value {greaterThanOrEqualTo, lessThanOrEqualTo}}, orderId {is | contains}, customer {id {is}}. Pass {} for no filter. Example: {"createdAt": {"greaterThanOrEqualTo": "2026-01-01T00:00:00Z"}}.
firstinteger- Number of results to return, 1 to 50. Example: 25.default
25
braintree_subscription_plans_listList the recurring billing plans defined in the Braintree Control Panel.Read-onlyList Subscription Plans
List the recurring billing plans defined in the Braintree Control Panel. Returns each plan's id, legacyId, name, description, price, billingFrequency, billingDayOfMonth, numberOfBillingCycles and trial. Use this to interpret planId values on subscriptions.
Inputs
This tool takes no inputs.
braintree_subscriptions_searchSearch Braintree recurring billing subscriptions by status, plan, price, days past due, next billing date and more, with cursor paging.Read-onlySearch Subscriptions
Search Braintree recurring billing subscriptions by status, plan, price, days past due, next billing date and more, with cursor paging. Returns pageInfo and subscriptions with id, legacyId, status, planId, paymentMethodId, price, balance, billing cycle details, failureCount, daysPastDue and transactionIds. Use List Subscription Plans to see plan IDs.
Inputs
afterstring- Cursor to continue after: the pageInfo.endCursor of the previous page. Example: YXJyYXljb25uZWN0aW9uOjI0.
criteriaobject- Search criteria as a Braintree RecurringBillingSubscriptionSearchInput object. Common keys: id {is | in}, planId {is | in}, status as a list (ACTIVE, CANCELED, EXPIRED, PAST_DUE, PENDING), inTrialPeriod (true/false), daysPastDue and price {greaterThanOrEqualTo, lessThanOrEqualTo}, nextBillingDate {greaterThanOrEqualTo, lessThanOrEqualTo}. Pass {} for no filter. Example: {"status": ["PAST_DUE"]}.
firstinteger- Number of results to return, 1 to 50. Example: 25.default
25
braintree_transaction_getGet one Braintree transaction by its GraphQL ID.Read-onlyGet Transaction
Get one Braintree transaction by its GraphQL ID. Returns the transaction's id, legacyId, createdAt, status, orderId, amount, customer, payment method, refunds, disputes and status history. Use Get ID From Legacy ID first if you only have the Control Panel ID.
Inputs
transaction_idstringrequired- Braintree GraphQL ID of the transaction (not the legacy ID shown in the Control Panel; convert one with Get ID From Legacy ID). Get it from Search Transactions. Example: dHJhbnNhY3Rpb25fYWJjMTIz.
braintree_transactions_searchSearch Braintree transactions by status, date, amount, order ID, customer, payment method and more, with cursor paging.Read-onlySearch Transactions
Search Braintree transactions by status, date, amount, order ID, customer, payment method and more, with cursor paging. Returns pageInfo and transactions with id, legacyId, createdAt, status, orderId, amount, customer, payment method, refunds, disputes and status history. Use Get Transaction when you have the transaction ID.
Inputs
afterstring- Cursor to continue after: the pageInfo.endCursor of the previous page. Example: YXJyYXljb25uZWN0aW9uOjI0.
criteriaobject- Search criteria as a Braintree TransactionSearchInput object. Common keys: id {is | in}, status {in: [SETTLED, SUBMITTED_FOR_SETTLEMENT, AUTHORIZED, VOIDED, FAILED, ...]}, createdAt {greaterThanOrEqualTo, lessThanOrEqualTo} as ISO timestamps, amount {value {greaterThanOrEqualTo, lessThanOrEqualTo}}, orderId {is | contains}, customer {id {is}, email {is}}. Pass {} for no filter. Example: {"status": {"in": ["SETTLED"]}, "createdAt": {"greaterThanOrEqualTo": "2026-01-01T00:00:00Z"}}.
firstinteger- Number of results to return, 1 to 50. Example: 25.default
25
braintree_viewer_getGet the Braintree merchant and API user behind the connected API key.Read-onlyGet Viewer
Get the Braintree merchant and API user behind the connected API key. Returns the merchant's id, companyName and merchant accounts, and the user's id, name and email. Use this to confirm which merchant account and environment are connected.
Inputs
This tool takes no inputs.
braintree_customer_createCreate a customer record in the Braintree vault.WriteCreate Customer
Create a customer record in the Braintree vault. Returns the new customer's id, legacyId and details. This stores customer details only. Payment methods are vaulted through Braintree's client-side tokenization.
Inputs
companystring- Company name of the customer. Example: Acme Inc.
custom_fieldsarray- Custom field values, each with the name of a custom field defined in the Control Panel and a value. Example: [{"name": "loyalty_tier", "value": "gold"}].
emailstring- Email address of the customer. Example: jane@example.com.
first_namestring- First name of the customer. Example: Jane.
last_namestring- Last name of the customer. Example: Doe.
phone_numberstring- Phone number of the customer. Example: 312-555-1234.
websitestring- Website URL of the customer. Example: https://acme.example.com.
braintree_customer_updateUpdate a Braintree vault customer's name, email, company, phone, website or custom fields.WriteUpdate Customer
Update a Braintree vault customer's name, email, company, phone, website or custom fields. Returns the updated customer. Only the fields you pass change.
- Idempotent
Inputs
customer_idstringrequired- Braintree GraphQL ID of the customer (not the legacy ID shown in the Control Panel; convert one with Get ID From Legacy ID). Get it from Search Customers. Example: Y3VzdG9tZXJfYWJjMTIz.
companystring- Company name of the customer. Example: Acme Inc.
custom_fieldsarray- Custom field values, each with the name of a custom field defined in the Control Panel and a value. Example: [{"name": "loyalty_tier", "value": "gold"}].
emailstring- Email address of the customer. Example: jane@example.com.
first_namestring- First name of the customer. Example: Jane.
last_namestring- Last name of the customer. Example: Doe.
phone_numberstring- Phone number of the customer. Example: 312-555-1234.
websitestring- Website URL of the customer. Example: https://acme.example.com.
braintree_dispute_finalizeFinalize an OPEN Braintree dispute, submitting its evidence to the processor to contest it.WriteFinalize Dispute
Finalize an OPEN Braintree dispute, submitting its evidence to the processor to contest it. Returns the dispute with its new status. After this no more evidence can be added. Add evidence first with Add Dispute Text Evidence.
- Idempotent
Inputs
dispute_idstringrequired- Braintree GraphQL ID of the dispute (not the legacy ID shown in the Control Panel; convert one with Get ID From Legacy ID). Get it from Search Disputes. Example: ZGlzcHV0ZV9hYmMxMjM.
braintree_dispute_text_evidence_createAdd a piece of text evidence to an open Braintree dispute.WriteAdd Dispute Text Evidence
Add a piece of text evidence to an open Braintree dispute. Returns the evidence's id, content, category and createdAt. Add all evidence, then use Finalize Dispute to submit it. File evidence is not supported by this connector.
Inputs
contentstringrequired- Evidence text, for example a tracking number or an explanation. Example: Delivered 2026-01-05, signed by J. Doe.
dispute_idstringrequired- Braintree GraphQL ID of the dispute (not the legacy ID shown in the Control Panel; convert one with Get ID From Legacy ID). Get it from Search Disputes. Example: ZGlzcHV0ZV9hYmMxMjM.
categorystring- Evidence category Braintree requires for some dispute reasons, such as TRACKING_NUMBER, CARRIER_NAME or GENERAL. Example: TRACKING_NUMBER.one of
AVS_RESPONSECARRIER_NAMECREDIT_ISSUED_AMOUNTCREDIT_ISSUED_ARNCREDIT_ISSUED_DATE_TIMEDEVICE_IDDEVICE_NAMEDOWNLOAD_DATE_TIMEGENERALGEOGRAPHICAL_LOCATIONPRIOR_DIGITAL_GOODS_TRANSACTION_ARNPRIOR_DIGITAL_GOODS_TRANSACTION_DATE_TIMEPRIOR_DIGITAL_GOODS_TRANSACTION_IDPRIOR_NON_DISPUTED_TRANSACTION_ARNPRIOR_NON_DISPUTED_TRANSACTION_DATE_TIMEPRIOR_NON_DISPUTED_TRANSACTION_EMAIL_ADDRESSPRIOR_NON_DISPUTED_TRANSACTION_IDPRIOR_NON_DISPUTED_TRANSACTION_IP_ADDRESSPRIOR_NON_DISPUTED_TRANSACTION_PHONE_NUMBERPRIOR_NON_DISPUTED_TRANSACTION_PHYSICAL_ADDRESSPURCHASER_EMAIL_ADDRESSPURCHASER_IP_ADDRESSPURCHASER_NAMERECURRING_TRANSACTION_ARNRECURRING_TRANSACTION_DATE_TIMERECURRING_TRANSACTION_IDREFUND_IDTRACKING_NUMBER
braintree_payment_method_chargeCharge a vaulted Braintree payment method and submit the sale for settlement.WriteCharge Payment Method
Charge a vaulted Braintree payment method and submit the sale for settlement. Returns the new transaction's id, status, amount and details. This takes real money in production. Set api_request_key so a retry cannot charge twice.
Inputs
amountstringrequired- Amount to charge as a decimal string. Example: 49.99.
payment_method_idstringrequired- GraphQL ID of a vaulted payment method (or a single-use payment method nonce). Get vaulted ones from Get Customer. Example: cGF5bWVudG1ldGhvZF9jY19hYmMxMjM.
api_request_keystring- Idempotency key: a unique string per intended operation, so a retried call is not applied twice. Example: refund-order-1234.
customer_idstring- GraphQL ID of the customer to associate. Example: Y3VzdG9tZXJfYWJjMTIz.
merchant_account_idstring- Merchant account to charge through, which sets the currency. Defaults to the merchant's default account. Example: acme_USD.
order_idstring- Your order ID for the charge. Example: order-1234.
braintree_transaction_captureSubmit an authorized Braintree transaction for settlement, in full or for a lower amount.WriteCapture Transaction
Submit an authorized Braintree transaction for settlement, in full or for a lower amount. Returns the transaction's id, status and amount. This moves the customer's money. Use Search Transactions with status AUTHORIZED to find authorizations.
- Idempotent
Inputs
transaction_idstringrequired- Braintree GraphQL ID of the transaction (not the legacy ID shown in the Control Panel; convert one with Get ID From Legacy ID). Get it from Search Transactions. Example: dHJhbnNhY3Rpb25fYWJjMTIz.
amountstring- Amount to capture as a decimal string, up to the authorized amount. Leave empty to capture the full authorization. Example: 25.00.
api_request_keystring- Idempotency key: a unique string per intended operation, so a retried call is not applied twice. Example: refund-order-1234.
braintree_transaction_refundRefund a settled or settling Braintree transaction, in full or in part.WriteRefund Transaction
Refund a settled or settling Braintree transaction, in full or in part. Returns the refund's id, legacyId, status, amount and refunded transaction. This returns money to the customer. For a transaction not yet settled, use Void Transaction instead. Set api_request_key so a retry cannot refund twice.
Inputs
transaction_idstringrequired- Braintree GraphQL ID of the transaction (not the legacy ID shown in the Control Panel; convert one with Get ID From Legacy ID). Get it from Search Transactions. Example: dHJhbnNhY3Rpb25fYWJjMTIz.
amountstring- Amount to refund as a decimal string. Leave empty to refund the full settled amount. Example: 10.00.
api_request_keystring- Idempotency key: a unique string per intended operation, so a retried call is not applied twice. Example: refund-order-1234.
descriptionstring- Description of the refund. Example: Damaged item.
order_idstring- Order ID to record on the refund. Example: order-1234-refund.
braintree_customer_deleteDelete a customer from the Braintree vault, unlinking it from its past transactions.DestructiveDelete Customer
Delete a customer from the Braintree vault, unlinking it from its past transactions. Returns clientMutationId on success. Braintree refuses while the customer still has vaulted payment methods: remove them first with Delete Payment Method. This cannot be undone.
- Idempotent
Inputs
customer_idstringrequired- Braintree GraphQL ID of the customer (not the legacy ID shown in the Control Panel; convert one with Get ID From Legacy ID). Get it from Search Customers. Example: Y3VzdG9tZXJfYWJjMTIz.
braintree_dispute_acceptAccept an OPEN Braintree dispute, conceding it to the customer.DestructiveAccept Dispute
Accept an OPEN Braintree dispute, conceding it to the customer. Returns the dispute with its new status. This cannot be undone and the disputed amount is lost. To fight it, add evidence and use Finalize Dispute instead.
- Idempotent
Inputs
dispute_idstringrequired- Braintree GraphQL ID of the dispute (not the legacy ID shown in the Control Panel; convert one with Get ID From Legacy ID). Get it from Search Disputes. Example: ZGlzcHV0ZV9hYmMxMjM.
braintree_payment_method_deleteDelete a multi-use payment method from the Braintree vault.DestructiveDelete Payment Method
Delete a multi-use payment method from the Braintree vault. Returns clientMutationId on success. This cannot be undone. Check Search Subscriptions first for subscriptions billed to it.
- Idempotent
Inputs
payment_method_idstringrequired- Braintree GraphQL ID of the payment method (not the legacy ID shown in the Control Panel; convert one with Get ID From Legacy ID). Get it from Get Customer. Example: cGF5bWVudG1ldGhvZF9jY19hYmMxMjM.
braintree_refund_reverseReverse (void) a Braintree refund that has not settled yet.DestructiveReverse Refund
Reverse (void) a Braintree refund that has not settled yet. Returns the voided refund with its status. Only refunds that have not settled can be reversed.
- Idempotent
Inputs
refund_idstringrequired- Braintree GraphQL ID of the refund (not the legacy ID shown in the Control Panel; convert one with Get ID From Legacy ID). Get it from Search Refunds or Refund Transaction. Example: cmVmdW5kX2FiYzEyMw.
api_request_keystring- Idempotency key: a unique string per intended operation, so a retried call is not applied twice. Example: refund-order-1234.
braintree_subscription_cancelCancel a Braintree recurring billing subscription so it is never billed again.DestructiveCancel Subscription
Cancel a Braintree recurring billing subscription so it is never billed again. Returns the subscription with status CANCELED. This cannot be undone; a canceled subscription cannot be reactivated.
- Idempotent
Inputs
subscription_idstringrequired- Braintree GraphQL ID of the subscription (not the legacy ID shown in the Control Panel; convert one with Get ID From Legacy ID). Get it from Search Subscriptions. Example: c3Vic2NyaXB0aW9uX2FiYzEyMw.
braintree_transaction_reverseReverse a Braintree transaction: Braintree voids it if it has not settled, or refunds it in full if it has.DestructiveReverse Transaction
Reverse a Braintree transaction: Braintree voids it if it has not settled, or refunds it in full if it has. Returns the reversal, which is the voided transaction or the new refund. Use this when you want the money back without checking the settlement state first.
Inputs
transaction_idstringrequired- Braintree GraphQL ID of the transaction (not the legacy ID shown in the Control Panel; convert one with Get ID From Legacy ID). Get it from Search Transactions. Example: dHJhbnNhY3Rpb25fYWJjMTIz.
api_request_keystring- Idempotency key: a unique string per intended operation, so a retried call is not applied twice. Example: refund-order-1234.
braintree_transaction_voidVoid an authorized or submitted-for-settlement Braintree transaction so it is never settled.DestructiveVoid Transaction
Void an authorized or submitted-for-settlement Braintree transaction so it is never settled. Returns the transaction's id, status and amount. Only works before settlement. Use Refund Transaction after it has settled.
- Idempotent
Inputs
transaction_idstringrequired- Braintree GraphQL ID of the transaction (not the legacy ID shown in the Control Panel; convert one with Get ID From Legacy ID). Get it from Search Transactions. Example: dHJhbnNhY3Rpb25fYWJjMTIz.
api_request_keystring- Idempotency key: a unique string per intended operation, so a retried call is not applied twice. Example: refund-order-1234.
No tools match.