Set Up Braintree in the Admin Console

To integrate Zephr with Braintree, complete the following steps:

1. Select the Settings icon, which is located at the top right of all screens
2. Select Extensions
3. Select Braintree from the Payment Provider section

   The Braintree screen displays, as illustrated below:

   

4. Configure the connection, as described below:
   1. Select the Connection Settings buttonThe Connection Setting screen displays, as illustrated below:

      

   2. Enter your Braintree merchant ID in the Merchant ID text box
   3. Enter the private key for your Braintree account in the Private Key text box
   4. Enter the public key for your Braintree account in the Public Key text boxTo find your Braintree details, complete the following steps:
      1. Sign in to your Braintree Admin Console
      2. Navigate to the API section
      3. Locate the API Keys table
      4. Select View from the Private Key column
      5. The Public Key, Private Key and Merchant ID entries display in the Client Library Key
   5. If you are testing your site before going live and want to use Braintree in sandbox mode, select the Sandbox toggle
   6. Select the Done button to add the connection and return to the Braintree screen
5. If you want to include the user email address on the purchase, set the field mappings as described below:
   1. Select the Field Mappings buttonThe Field Mappings screen displays, as illustrated below:

      

   2. Select the Include User Email Address on Purchase toggle
   3. Select the Done button to add the mapping and return to the Braintree screen
6. If you want to allow the use of Braintree discount codes on your payment forms, add the promo codes as described below:
   1. Create your discounts in Braintree, as described in the Braintree Add-ons and Discounts guide
   2. Select the Promo Codes button on the Braintree screen
   3. Select the Add a Promo Code button
   4. Enter the code you want your customers to use in the Code text box; for example, 20Off
   5. Select the type of discount to apply from the Discount Type options. The options are as follows:
      • Percentage. This applies a percentage discount to the total price
      • Absolute. This reduces the total price by a specific amount
   6. Enter the amount of discount to apply in the Discount Amount text boxFor example, if you enter 15 in this text box, depending on the type of discount you have specified, this either applies a 15% discount or subtracts 15 from the total price.

      Note: Zephr uses the discount amount defined here when applying discounts and not the Discount Amount defined in Braintree.

   7. Enter the number of billing cycles to which the discount applies in the Billing Cycles text boxNote: Zephr uses the billing cycles defined here when applying discounts and not the Billing Cycles defined in Braintree.
   8. If required, enter a limit for the amount of discount available to each customer in the Limit text box
   9. Enter the Discount ID or Discount Name used by Braintree in the Braintree Discount ID text box
   10. Select the Add button to add the discount and return to the Braintree screen
7. If you want to use Google Pay and/or Apple Pay, configure your mobile payment providers, as described below:
   1. Select the Mobile Payment button

      The Mobile Payment List screen displays, as illustrated below:

      

   2. Select the Add a Mobile Payment button

      The Add Mobile Payment screen displays, as illustrated below:

      

   3. Select the payment provider from the Type radio buttons. The options are as follows:
      • Google Pay

        Select this to configure Google Pay as a mobile payment provider.

        A further field displays, as illustrated below:

        

        Enter your Google Merchant ID in the Google Merchant Id text box.

      • Apple Pay

        Select this to configure Apply Pay as a mobile payment provider.

   4. Select the Save button to save your mobile payment provider and return to the Mobile Payment List screen. Selecting the Cancel button displays the Mobile Payment List screen without saving your changes
   5. Select the Done button to save the mobile payment provider settings and return to the Braintree screen
8. If Braintree is not your current payment provider, select the Use as Payment Provider button

   Note: If Braintree is already set as your payment provider this button is disabled and labelled Active Payment Provider.

   If you currently have a different payment provider activated, a warning dialog box displays, as illustrated below:

   

   Select the Confirm button to save your settings and activate Braintree as the payment provider. Selecting the Cancel button returns you to the Braintree screen without changing the payment provider.

9. Select the Save button

For information on using the discount on your payment form, see the Use a Promo Code on a Payment Form topic.