Skip to content

Configuration

Add-on settings (Add-ons > Braintree Payments)

Section titled “Add-on settings (Add-ons > Braintree Payments)”
Setting Default What it does
Enable on Off: no new payments start; read-backs, captures, voids, refunds and webhooks of existing payments still run
Marketplace owner mode (Multi-Vendor) on On: every order is paid to the owner’s Braintree account. Off: each vendor connects their own account (direct payments)
Payment action Charge at once Charge at once (chargePaymentMethod) or authorize only (authorizePaymentMethod, capture later)
Capture (authorize only) When the order reaches the capture status Or only by hand on the order page
Capture status Complete Status that captures an authorization; a payment of several vendor orders is captured once every vendor order has it (or is cancelled)
Cards (Hosted Fields) on Card fields hosted by Braintree on the pay page
PayPal off PayPal button through Braintree (PayPal must be enabled and linked in your Braintree account)
3D Secure 2 for cards on Cards go through 3D Secure 2 before the charge
Require liability shift on Refuses a card before the charge when 3D Secure could shift the liability but did not, or the result is missing; cards that cannot do 3D Secure are accepted
Charge other currencies in the default merchant account on Off: the method is hidden for currencies without their own merchant account
Order status when paid Processed Set after Braintree confirmed the transaction and the order total still matches
Order status when not paid Failed Set when the customer leaves the pay page without paying; a declined card keeps the order open for another card
Void status Canceled Voids an authorization that is not captured (Declined does the same); a payment that lands later is voided or refunded
Refund status none Gives the money of the order back (queued, cron): a charge that is not settling yet is voided as a whole; otherwise it is refunded once Braintree allows refunds (card sales settle in a daily batch; the job waits up to 7 days without using up its retries)
Dispute status none Status set when Braintree reports a new dispute
orderId prefix cs orderId sent to Braintree = prefix-order id-random part
Debug log off Logs every API call (keys, card data and personal data masked)
Log retention (days) 90
Delete payment records on uninstall off Off keeps charges, captures, voids and refunds on uninstall

Connection page (Orders > Braintree > Connection)

Section titled “Connection page (Orders > Braintree > Connection)”
Field What it is
Mode Sandbox or Production; both sets of keys are kept, every payment uses the keys of the mode it was made in
Merchant ID, public key, private key Per mode, from the Control Panel (gear icon > API > API Keys). The private key is stored encrypted and never shown again; an empty field keeps it
Merchant accounts Read by “Test connection”: id, currency, default. Choose the account for other currencies
Webhook URL Paste it into the Control Panel (gear icon > API > Webhooks). Needs HTTPS

Payment method (Administration > Payment methods)

Section titled “Payment method (Administration > Payment methods)”

Processor “Braintree (cards, PayPal)”. The method is shown at checkout only when the add-on is enabled and licensed, the account that serves the cart is connected, and there is a merchant account for the cart currency (or conversion is on). On Multi-Vendor with owner mode off it is hidden for carts with products of several vendors.

With owner mode off the money of a vendor’s order goes straight into the vendor’s own Braintree account. CS-Cart’s vendor payouts and commissions still treat the order as paid to the marketplace unless you use Multi-Vendor’s direct payments (vendor-to-customer) setup or adjust the payouts yourself. Settle commissions with your vendors accordingly.