Braintree
Takes card payments online through the workspace's own Braintree account. Customers pay invoices, shop orders, event tickets and course places by card in Braintree's secure card fields, the money settles straight into your account, and refunds go back the same way.
| At a glance | |
|---|---|
| Type | Add-on module |
| Group | Bill |
| Price | Free (Braintree charges its own fees on your account) |
| Provides | Take payments online, Generate payment links |
| Needs | The Payments module |
| Offered to | Every industry pack |
| Permission | Manage add-ons (addons.manage) to switch it on; Manage settings to connect the account |
What it does
Braintree is a payment gateway add-on module of Payments. While it is on and connected, Payments can:
- take card payment online on an invoice's pay page (the shared receipt link and the customer portal), at the online shop's checkout, for event tickets, for course places and at the self-order kiosk. Pay now opens a Pay by card page whose card number, expiry date and security code fields are Braintree's own: the card details go straight to Braintree and are never seen here. A declined card is said on the page, and the customer can try another;
- let staff Collect online on an invoice, with the card page to send the customer;
- send money back through Braintree when a payment is refunded (once Braintree has started to settle it, usually the same day);
- make pay-now links, sent by text or WhatsApp (they need an SMS or WhatsApp add-on module as well);
- pay Subscriptions renewal bills automatically: the customer saves a card once in Braintree's own card fields (Braintree checks the card; nothing is charged), and each renewal bill is charged to it by itself.
Currencies. The currency of your Braintree merchant account, which must be the workspace's own currency.
Switching it on
- Switch on Payments first (Workspace → Modules). Braintree needs it, so the switch is refused while Payments is off.
- Set the filter to Add-on modules. Braintree is under Bill.
- Open its ⋮ menu, choose Enable, and press Enable in the dialog. There is nothing to fill in there.
- Choose Connect under Settings → Payments on its ⋮ menu and connect your account (below).
Connecting your Braintree account
Settings → Payments, provider Braintree:
| Field | What to enter |
|---|---|
| Public key | Braintree Control Panel → Settings → API → API keys. |
| Private key | The private key shown with it. Write-only. |
| Merchant account ID | The merchant account in this workspace's currency. Leave blank for your default merchant account. |
| Environment | Test (no real money) for a sandbox account, or Live. |
| Accept payments through this gateway | Tick it to take payments. Needs both keys. |
No webhook to set up. For card payments Braintree's answer to the charge is the proof, so nothing else is needed.
One gateway takes payments at a time. To move to another, switch this one's Accept payments off first.
Turning it off
Turn off on the ⋮ menu asks first. New online payments through Braintree stop at once, and Braintree leaves Settings → Payments. Payments already under way are still recorded when Braintree confirms them, refunds of earlier payments still go back through it, and the keys stay saved for when it is switched on again. While Braintree is on, Payments cannot be switched off.
Ready-made automations
None of its own. The moments around a payment (one that fails, a pay-now link to send) are the Payments module's ready-made automations.
In the desktop and mobile apps
Not carried. The apps take payment at the counter.