Overview
Prerequisites
Prerequisite alert!
Before Braintree Payments can be offered to your customers, your website must be running version 4.30+, and you'll need a merchant account with Braintree. Contact Commerce Vision to request a site version upgrade.
Once Braintree Payments has been implemented and enabled for your site by Commerce Vision, settings for the Braintree feature, every available payment option, vaulting (saving payment for future use), and fraud protection can be configured.
Vaulting
Vaulting refers to saving of a customer payment for future use. Another name for this is tokenisation. Typically this is used in two purchasing scenarios: recurring billing such as for subscription products and future purchases so customers do not have to re-enter payment details.
Braintree is a multi-payment option system for web and mobile.
Step by Step Guide
1. Configure General Settings
NOTE - You will need your Sandbox or Production credentials (API keys and Merchant ID) for this step. You can retrieve these from your Braintree Sandbox or actual account.
To configure Braintree Payment Settings,
- Navigate to Settings → Payment & Checkout → Braintree Payment.
- If the Available in CMS toggle is not enabled, toggle it ON.
- Click Configure.
- Configure General Settings for Braintree Payments. NOTE - the Overrides feature can be used instead of global settings when offered.
- To enable Braintree for all Users on your site, toggle ON Enable Braintree Payment. TIP - Leave this global toggle off and add Role Overrides if Braintree is to be offered only to specific roles, e.g., B2C customers.
In Mode, select 'Sandbox' if you are on the testing Stage site or 'Production' on the live site.
The sandbox is an entirely separate environment from your production account. Nothing created in the sandbox (e.g. processing options, recurring billing settings) will transfer to production. Your login information, merchant ID, and API keys will also be different.
- Enter credentials for either 'Sandbox' or 'Production'. You will need the following from your Braintree account:
- Merchant ID
- Public Key
- Private Key
CHECK WHAT ABOUT MERCHANT ACCOUNT IDIf you want to allow Users to be able to delete a saved (vaulted) payment, toggle ON Allow Vault Management. When this setting is enabled, an Edit link displays next to each payment mode.
When the User clicks on Edit, the delete option appears for each payment. The User can click it to remove the saved payment.
- If the saved payment at the top of the list is to be preselected when the User pays during checkout, toggle ON Preselect Vaulted Payment Method. A preselected payment is foregrounded and has a tick
next to it. If OFF, the last saved payment will be preselected.
- If ... Show Default Payment Method First. CHECK
2. Configure payment options
The next step is to configure each payment option your site will offer. Notice there are a number of payment options available, each of which can be individually enabled or disabled at any time to suit your business requirements. Each option you enable used must also be turned on in your Braintree account.
Your Braintree account will allow you to automatically offer credit card payments. To include PayPal, Google Pay or Apple Pay, your business must also have accounts with the respective providers. CHECk
All enabled Braintree payment methods will display under a common Payment Methods tab during checkout. TIP - you can change the tab name 'Payment Methods' in the Checkout Payments Options Widget.
Credit Card Settings
Braintree Payments is currently set up to accept Visa, Mastercard and American Express. Specific settings are not required to accept each option as that is done by Braintree. You can decide whether successfully used credit cards should be saved for future purchases or not by default, or to allow the User to decide.
Enable Credit Card - toggle ON to offer payment by credit card on your site. The credit cards currently accepted by Braintree (Visa, Mastercard, American Express) are automatically listed.
Allow Vault Credit Card - toggle ON to automatically save a credit card for a User when first successfully used on your website. Saved cards will instantly be offered for future purchases without the need to re-enter details. The User just needs to click on the card to re-use it. If this setting is OFF, credit cards are used only for one time purchases and will not be saved.
Allow Vault Credit Card Override - toggle ON to display a Save card checkbox when a new credit card is being entered. This allows Allow Vault Credit Card to be overridden by the User, who can untick the checkbox.
Require Credit Card Holder Name - toggle ON if you want the cardholder's name to be entered during the payment process. TIP - if this setting is OFF, the Cardholder field for the transaction record in Braintree will be left blank.
PayPal Settings
Enable PayPal
Allow Vault PayPal
Google Pay Settings
Enable Google Pay
Google Pay Merchant ID
Apple Pay Settings
Additional Information
| Minimum Version Requirements |
|
|---|---|
| Prerequisites |
|
| Self Configurable |
|
| Business Function |
|
| BPD Only? |
|
| B2B/B2C/Both |
|
| Ballpark Hours From CV (if opting for CV to complete self config component) |
|
| Ballpark Hours From CV (in addition to any self config required) |
|
| Third Party Costs |
|
| CMS Category |
|
Related help
