Zephr includes out-of-the-box integration with Braintree. Use this guide to find out how to use Braintree as your payment provider within Zephr.
Note: One-off payments are not supported.
Integrating with Braintree
Navigate to Settings > Extensions within your Zephr Admin Console, and select Braintree.
Connection Settings
Select the Connection Settings option. Here you will need to enter some configuration details based upon your pre-existing Braintree Account. You will need to provide the following details:
- Merchant ID
- Private Key
- Public Key
Finding Braintree API Details
To find this information within Braintree, navigate to the API section within your Braintree account.
Once in the API section, locate the API Keys table, then click View under the Private Key column.
This will open your Client Library Key, where you will find the Public Key, Private Key, and Merchant ID needed for your Zephr-Braintree integration.
Please note: The information above does not relate to your specific Braintree environment and is for demonstration purposes only.
Add this information to the configuration screen, as mentioned above.
Next, select if you would like to use Braintree in Sandbox Mode, which will allow you to test payments before you go live on your site.
Click Done.
Field Mappings
In this section, select if you would like to include a User’s Email Address in the call made to Braintree when a purchase is being made.
Click Done.
Configuration in Braintree
To complete your integration, you will need to set up a webhook within Braintree to fire to Zephr, sharing when there has been a successful payment.
To do this, navigate to Settings > API > Webhooks within your Braintree Admin Console.
Set up a new webhook, using the Destination URL of <https://<your-cdn-domain>/blaize/payment/braintree/subscriptionChargedCallback>. Under <your-cdn-domain>, enter the URL you have pointing to the Zephr CDN.
Under Notifications, tick Charged Successfully, then save the webhook.
Promo Codes
Promo Codes allow you to link Braintree Discount Codes to Zephr Products, making the promo code field available for use on your out-of-the-box payment forms.
Before setting these up in Zephr, you will need to create the discount options within Braintree, and link them to the relevant Product Plan (which will be used on your payment form). A guide for creating discounts within Braintree is available here.
To add a Promo Code to Zephr, enter the Promo Codes section, then select Add a Promo Code.
Set the Code you want your users to enter, for example 20Off.
Next, select the Discount Type you wish to use:
- Percentage: Will take a percentage off the total price
- Absolute: Will take a specific monetary value off the total price
Once you’ve selected your Discount Type, set the Discount Amount. For example, setting 15 as the discount amount with a Percentage Discount Type will give 15% off the price, whilst setting 15 on an Absolute Discount Type will give you £15 off (or whichever currency you are using).
The Billing Cycles section should be used to specify how many times the discount is available to the user, while the limit sets an upper limit for the amount of discount available per customer.
Finally, enter your Braintree Discount ID. This can be done by adding either the Discount ID directly from Braintree, or the Discount Name (Zephr will search for the ID within your Braintree Account).
Click Add, then click Done.
Be sure to save your Braintree set up once complete, by clicking the Save button.
Next, click the Use as Payment Provider button to use Braintree as your payment provider for all out-of-the-box Zephr payment forms.
Once complete, you will be able to use payment plans created in Braintree as payment options within Zephr. Read our Products guide for more information.
Using Promo Codes on a Payment Form
Once you have created a Promo Code, check the appropriate Recurring Billing option is linked to a Zephr Product.
Next, navigate to the Feature you wish to display a Payment Form on and add a new Outcome with a Payment Form component within it.
Give your form a Title and under ‘Select a Product’ select the Product that is linked to the relevant Recurring Billing option.
Add your Payment Options accordingly. Please note that One-Off payment options are excluded from using Promo Codes.
Next, toggle Enable Promo Codes to on.
Click Save, then save your Outcome and add it to your Feature Rule. Publish your rule accordingly.
Once complete, you will see a field on your payment form for entering a Promo Code.
A more detailed guide to creating a payment form is available here.