You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 39 Next »

Prerequisite alert!

Prerequisites:

  • Merchant account with Braintree.
  • If offering third party options such as PayPal, Google Pay and Apple Pay, merchant accounts with each provider.
  • Website version on 4.30+. Contact Commerce Vision to request a site version upgrade.



Overview

Once Braintree Payments has been implemented and enabled for your site by Commerce Vision, settings for the Braintree feature including available payment options, vaulting (saving a payment for future use) and fraud protection, can be configured.    

Using surcharges or token management?

The Customer Self Service eCommerce Platform's credit card surcharge facility and token management feature have been integrated into Braintree Payments.

  • If any surcharge applies to an order, it will automatically be calculated, displayed and added to the total during checkout.

  • If Braintree Payments is enabled, it will be used for saving a Customer credit card. This tokenised card can be used for future payment of account invoices. 



Step by Step Guide

1. Configure General Settings 

  1. You will need your Sandbox or Production credentials (API keys and Merchant ID) for this step. You can retrieve these from your Braintree Sandbox and Production accounts.
  2. For any setting displaying the Overrides option , Overrides can be used to configure different settings against specific Users, Roles or Customers instead of just one global one.


To configure Braintree Payment Settings:

  1. Navigate to SettingsPayment & CheckoutBraintree Payment.
  2. If the Available in CMS toggle is not enabled, toggle it ON. 

  3. Click Configure.

  4. In Braintree Payment Settings, configure General Settings
      
    1. 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. 

    2. In Mode, select 'Sandbox' if you are on the testing Stage site or 'Production' if 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. 

    3. Enter credentials for either 'Sandbox' or 'Production'. You will need the following from your Braintree account:
      - Merchant ID - this is the default ID used to verify the account. If your business has 
      several Merchant Account IDs and you want to specify one of them, enter it in the Merchant Account ID field instead of here.  
      - Public Key 
      Private Key 
      - Merchant Account ID - leave blank if the 'Merchant ID' is to be used.

  5. If you want to allow Users to be able to delete a saved (vaulted) payment, toggle ON Allow Vault Management. When this setting is enabled, in the Payments panel during checkout, Users will see an Edit link on the top right side.  
     

    When the User clicks on Edit, the delete function appears for each payment. The User can click on it to remove the saved payment.  
       
    If the toggle is OFF, the Edit link is not displayed. To delete a vaulted payment, Users will need to contact your customer service and have the saved payment deleted in your Braintree account.

  6. If the vaulted payment is to be preselected during checkout, toggle ON Preselect Vaulted Payment Method. The preselected payment is foregrounded and has a tick next to it. If this toggle is OFF, the last entered payment will be preselected.


  7. If the nominated default payment option (set in the Braintree account) is to be displayed at the top of the list, toggle ON Show Default Payment Method First.

    To flag as default

    To mark a payment as default, in your Braintree account, go to the Vault and find the User. Click on the payment to be marked as default and click Edit. Tick the Default Payment Method for Customer? checkbox.

2. Configure payment options 

The next step is to configure the payment options 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. Note that each option you enable here 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 each respective provider.  


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. PayPal Express and Pay in 4 buttons are also be added to the product and cart pages. 

Credit Card Settings

Braintree Payments is currently set up to accept Visa, Mastercard and American Express. Specific settings are not required for each credit card type as that is managed by Braintree. You can decide whether the following vaulting options occur or not at checkout:

  • automatically vault (save) a credit card for future purchases when it is first used successfully, and
  • allow the User to override the default setting. 

  1. Enable Credit Card - toggle ON to offer payment by credit card on your site. When enabled, in the Payments panel during checkout, 'Pay with card' displays as an option, and the logos of the credit cards currently accepted are automatically listed. 
  2. Allow Vault Credit Card and Allow Vault Credit Card Override work together to determine the default vaulting setting and whether Users are permitted to override it.
    1. Allow Vault Credit Card sets the default vaulting option when a credit card is used successfully. Toggle ON to vault a card by default.
    2. Allow Vault Credit Card Override allows the User to override the default option set in Allow Vault Credit Card. If toggled ON, a Save card checkbox is displayed for the User to override the default. Whether the checkbox is preselected or not depends on the default settings. 

      This table summarises the four possible vaulting configurations:


      Allow Vault Credit Card
      Allow Vault Credit Card OverrideONOFF
      ON

      Default vaulting: yes

      Checkbox: displayed, not ticked

      • A card will be vaulted by default unless the User unticks the checkbox. 

      Default vaulting: no

      Checkbox: displayed, ticked

      • A card will not be vaulted by default unless the User ticks the checkbox.
      OFF

      Default vaulting: yes

      Checkbox: not displayed

      • A card will be vaulted by default. The User cannot override this.

      Default vaulting: no

      Checkbox: not displayed

      • A card will be not be vaulted. The User cannot override this.
    3. 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 Name in the transaction record in your Braintree account will be left blank.   


    4. To save your settings, click Save.

PayPal Settings

Braintree Payments provides the option of processing PayPal payments within its gateway. This means that during checkout, PayPal is offered as an option under Braintree's 'Payment Methods' tab rather than under a separate PayPal one. The gateway can also handle PayPal's express options. You can add PayPal, Pay in 4 and Credit Card buttons in the product or cart pages. These are express options because they allow the purchaser to submit an order without going through the normal checkout process.

The integration means that you can see PayPal transactions in your Braintree account, and even opt to manage PayPal disputes there. NOTE - You still need to establish a separate PayPal merchant account as payment processing fees are charged as per your agreement with PayPal. Braintree does not charge additional fees for handling PayPal transactions. 


Offering PayPal within the Braintree gateway has been integrated in the settings here. Rather than set up PayPal separately, you can enable/disable PayPal payment options for your site. Your site can offer one or all of these PayPal options:

  • PayPal under the Braintree Payments 'Payment Methods' tab during checkout.

     In the Payments panel during checkout, 'PayPal' displays as an option under Payment Methods.

     

    The User clicks on PayPal and a PayPal button is displayed. 

    The User clicks the PayPal button. The secure PayPal login popup is displayed. 

    The User can log into their PayPal account and select from available payment options in PayPal. After selecting the option, the User is returned to your website. The PayPal account with login ID is displayed. 

    The User clicks Process Payment to complete payment for the order. If 'Allow Vault PayPal' is enabled, a successful PayPal account will be vaulted for future purchases.  

  • PayPal Express via buttons in the product detail and/or cart pages. NOTE - Adding PayPal Express through Braintree settings replaces the need to add it through the PayPal Express settings.

    PayPal Express in product pagePayPal Express in cart

  • PayPal Pay in 4 buttons in the product detail and/or cart pages. 

    PayPal Pay in 4 in product detail pagePayPal Pay in 4 in cart

  • PayPal Credit Card buttons in the product detail and/or cart pages

The User clicks on the Debit or Credit Card button to open a secured credit card form hosted by PayPal. 

The User fills out the form and clicks the Buy Now button. PayPal verifies the User. If the User is successfully verified, they are taken to the final checkout page. The User clicks the Check out with PayPal button to submit the order.




Configure PayPal 

To offer PayPal within the Braintree gateway, your business must have a PayPal account. PayPal must be enabled here and your merchant PayPal credentials entered in your Braintree account.

PayPal Testing

Please consult Braintree documentation about testing PayPal with Braintree.  

To configure PayPal for Braintree:

  1. In the PayPal Settings section, toggle ON Enable PayPal. This enables PayPal on your site.

  2. Allow Vault PayPal: toggle ON to automatically save a successful PayPal payment for future use. IMPORTANT- PayPal vaulting is incompatible with offering Pay in 4. If this toggle is enabled, PayPal Pay in 4 will not be displayed as a payment option.


  3. The next few toggles and fields set PayPal Express, including Pay in 4 button options in the product and cart pages. 
  4. To save your settings, click Save.

Google Pay Settings

Braintree Payments is set up to accept Google Pay. Google Pay allows users to make contactless payments online and with Android phones, tablets or watches. Your business must have a Google Merchant Centre account set up and Google Pay must be enabled in your Braintree account.

Sandbox testing

For Sandbox testing, Google Pay requires a real credit card. However, no funds will be taken from the card during processing and the card is not saved. 


To configure Google Pay for your website:

  1. Toggle ON Enable Google Pay


  2. In Google Pay Merchant ID, enter your Google Merchant ID from your Google Merchant Centre account. TIP - if you are testing in Sandbox, this can be left blank.

  3. To save your settings, click Save.

When Google Pay is enabled on your site...

In the Payments panel during checkout, 'Google Pay' displays as an option under Payment Methods.

 

The User clicks on Google Pay and a Google Pay button is displayed. 

The User clicks the Google Pay button to login to their Google account.

Once logged in, the secure Google Pay popup is displayed. The User selects an existing payment option or enters a new credit card.

Once saved, the User is returned to the Payment panel on your website with the Google Pay option selected. The User clicks Process Payment to complete payment for the order.  


Apple Pay Settings

Braintree Payments is set up to accept Apple Pay. Apple Pay allows users on certain Apple devices to make payments. Your business must have an Apple Pay Merchant account set up and Apple Pay must be enabled in your Braintree account.

Sandbox testing

For Sandbox testing, refer to Apple's Sandbox Testing documentation for details.  


To configure Apple Pay for your website:

  1. Toggle ON Enable Apple Pay


  2. In Apple Pay Display Name, enter a meaningful name for your store Google Merchant ID from your Google Merchant Centre account. NOTE - If this is left blank, the User will see an error message and cannot use Apple Pay.

  3. To save your settings, click Save.

When Apple Pay is enabled on your site...

In the Payments panel during checkout, 'Apple Pay' displays as an option under Payment Methods.

 

The User clicks on Apple Pay and an Apple Pay button is displayed. 

The User clicks the Pay button and any saved cards in the User's Apple Pay Wallet are displayed for selection. A new card can also be entered. Once a card is selected, the User undergoes any required security check, e.g., entering their Passcode. 

Once security is passed, the User is returned to the Payments panel on your site with the Apple Pay option ticked. They click Process Payment to complete the order.



3. Fraud Protection Settings for Order Payment

Braintree Payments has three fraud protection modes, and one must be selected. Information provided here is limited to setting up an option for your website. Details about fraud protection options are available from the Braintree website. (NOTE - Advanced and Kount are options that incur additional fees.) In addition, 3D Secure, which provides an extra layer of security by prompting a User to authenticate card ownership by entering a PIN, can be enabled.

  1. In Braintree Payment Settings, scroll down to the Fraud Protection Settings for Order Payment section.

  2. In Fraud Protection Mode, select Basic, Advanced or Kount. NOTE - The mode enabled her must be the same as the mode enabled in your Braintree account.
    Basic - all fraud protection is handled by Braintree and no further configuration is required here.


  3. (For 'Advanced' or 'Knout' only.) In Treat Decision 'Not Evaluated' As, select 'Review' or 'Approve'. 
    Review: the transaction with this status is treated as suspicious and put on hold subject to further verification
    Approve: the transaction with this status is treated as a successful one and the order is released.  

  4. (For 'Knout' only.) In Treat Decision 'Escalate' As, select 'Review' or 'Approve'.
    Review: the transaction with this status is treated as suspicious and put on hold subject to further verification
    Approve: the transaction with this status is treated as a successful one and the order is released

  5. To use 3D Secure, toggle ON Enable 3D Secure. NOTE - This feature adds another layer of security for payments that use credit cards, including Google Pay. It is applicable only to cardholders who have enrolled in 3D Secure with their issuer. 

    During the checkout process, if the cardholder is enrolled in 3D Secure, the issuing bank will decide whether the cardholder's identity can be verified using data supplied regarding the cardholder and their device, or if an additional authentication process is necessary. If additional authentication is necessary, Braintree will begin a process provided by the issuing bank to verify the cardholder’s identity via SMS one-time passcode, the issuing bank's mobile app, biometric methods, or other means.


    3D Secure can shift liability for fraud-related chargebacks from the merchant to the card issuer. For example, if the issuer does not participate in 3D Secure but the card brand supports this extra protection (i.e. Visa or Mastercard), the liability for fraud-related chargebacks will shift to the issuer.

    NOTE - 3D Secure does not shift liability for all fraudulent chargebacks. You can determine whether or not liability shift occurred by the 3D Secure status code returned for the authentication.


    Example of 3D Secure popup:


    If the credit card payment passes 3D Secure, the order will be completed. If the payment is rejected by 3D Secure, the User will see a 'Rejected by Gateway' popup error message on your site:

     
    This status is also recorded in the Braintree account. 



  6. (For use with 3D Secure only). The 3D Secure Review Status List provides all 3D Secure statuses that will not reject the order if 3D is not required. it allows you to put such orders on hold for further verification. For instance, 'authenticate_attempt_successful' means that the card brand passed the attempt because the issuer's authentication server was unavailable. You can add one or more such statuses. NOTE - For a list of what each of the statuses mean, refer to the Braintree website.

    Click on the list, then click to select all required statuses. These statuses will populate the field.  
     
    For cards that cannot be authenticated and the status is on this list, payment will not be processed and the User will see this message: 
     

Additional Information

 

Minimum Version Requirements


4.30

Prerequisites


Braintree Account, third party payment accounts

Self Configurable


Yes

Business Function


Payment Types

BPD Only?


Yes

B2B/B2C/Both


Both

Ballpark Hours From CV (if opting for CV to complete self config component)


Contact Commerce Vision

Ballpark Hours From CV (in addition to any self config required)


Contact Commerce Vision

Third Party Costs


Fees may apply

CMS Category


Payment & Checkout


Related help



  • No labels