Installation

Install the add-on. Add-ons > Manage add-ons > the gear icon > Manual installation: upload kv_braintree-1.0.0.zip, then install “Braintree Payments”. Enter your licence key in the add-on settings (Licence section).
Connect your Braintree account, sandbox first. Orders > Braintree > Connection.
- In the Braintree sandbox Control Panel open the gear icon > API > API Keys and copy the merchant ID, the public key and the private key.
- Keep the mode on Sandbox, enter the three values in the Sandbox block and press Save and test. The answer lists your merchant accounts and their currencies.
- If you have several merchant accounts, choose the one used for other currencies (default: Braintree’s default account).
Settings. Add-ons > Braintree Payments > Settings: payment action (charge at once, or authorize and capture later), capture status, cards, PayPal, 3D Secure 2 and “Require liability shift” (both recommended), conversion of other currencies, and the order statuses.
Payment method. Administration > Payment methods > add a method, choose the processor “Braintree (cards, PayPal)”, give it a name (for example “Card or PayPal”) and save. On CS-Cart Ultimate add it to each storefront that should offer it.
Webhook (recommended). Copy the webhook URL from the Connection page. In the Control Panel: gear icon > API > Webhooks > Create New Webhook, paste the URL, tick the dispute notifications (and Transaction Settled / Settlement Declined if you use ACH or SEPA), save, then press “Check URL”. The test notification appears in Orders > Braintree > Log.
Cron. Add the cron command (or the secret URL) shown in the add-on settings to your scheduler, every 5 minutes: it reads back payments without a clear answer, picks up card settlements and runs queued refunds.
Test order. Place an order with a Braintree test card (for example 4111 1111 1111 1111, any future expiry date). Sandbox orders show “SANDBOX” at checkout and on the pay page, and the order note says no money moved.
Go live. Enter the production merchant ID and keys in the Production block, switch the mode to Production, Save and test, and create the webhook in the production Control Panel too.

Multi-Vendor

Owner mode on (default): only the marketplace owner connects a Braintree account; vendors see the Braintree tab of their orders but cannot capture, void or refund.
Owner mode off: each vendor opens Orders > Braintree > Connection in the vendor panel and connects their own Braintree account. Orders of that vendor are paid to it; a cart with products of several vendors does not offer Braintree.

Updating

Upload the new package over the old one (Manual installation). The add-on brings its tables and settings up to date by itself on the next admin page view (Upgrade Synchronizer); payment records, the log, your settings and keys are kept.

Uninstalling

Uninstalling keeps the payment records (charges, authorizations, captures, voids, refunds) unless the setting “Delete payment records on uninstall” is ticked, so authorizations can still be captured or voided and payments refunded after a reinstall. The API keys are removed and must be entered again after a reinstall.