Install and Configure the Bread App

Find the Bread App in Marketplace

Get started by logging into your BigCommerce store. From the left-hand menu, select Apps > Marketplace. Search for “Bread” and click on the result that displays the Bread logo:

Click on the logo to see the Bread App details page. From here, click Install to add the Bread App to your store. After you install the App, please send a note to integrations@breadfinance.com with the email subject “BigCommerce App Installed”. While we take care of one other back-end task for you, please proceed to complete the rest of the configuration.

Configure the Bread App Settings

Once the Bread App is installed, you can find it in your store under Apps > My Apps > Bread Finance.

Click on Bread Finance to access the app, then click on App Settings from within the app.

Enter Your API Keys

Your Bread API keys, which tie transactions made from your store to your Bread account, should be entered into API Key and API Secret under API Configuration. First, find your sandbox API keys in your Bread merchant portal. This is your sandbox merchant portal — you should be able to log in with credentials provided by your main success point of contact.

Your API and Secret key will be listed within the merchant portal under Account > API & Secret Keys. Copy the API Key here and paste it into API Key within BigCommerce app. Similarly, copy the Secret Key here and paste it into API Secret within the BigCommerce app.

Additionally, make sure Use Sandbox Mode? is enabled. Once these changes have been made, hit the Save button in the lower right corner.

Insert the Application Link Code

Scroll to the bottom of the settings page and find the Application Link Code section. Highlight and copy the Link Code.

Next, back out of the Apps menu and then select Advanced Settings > Web Analytics. Make sure Google Analytics is enabled and then select the Google Analytics menu. Scroll to the bottom of Tracking Code (if necessary), make a new line and then paste the Link Code that was copied from the settings page. Save your changes.

Next Steps

Below you will find a reference guide to all of the settings, but for now proceed to the next topic: Enable Bread on Product Detail Pages.

Settings Reference

API Confirmation

Enter your API key and secret here. While integrating and testing, you should use your sandbox API key and secret and make sure Use Sandbox Mode? is enabled. Health Care Mode should only be enabled for merchants selling health-related products.

Targeted Financing

This option allows you to offer an alternative loan program for products or cart sizes above a price threshold. For instance, you could offer promotional 0% financing for high priced items or carts. To enable this option, enter your alternative financing program ID and a price threshold. Please ask your main success point of contact to configure your alternative financing program.

Button Configuration

Use Custom CSS to style your Bread buttons. Please read Style the Bread Button for guidance on forming your CSS. Note – your CSS should be minified using a tool such as https://cssminifier.com.

Product Details Page

Enable Display Bread Button? to show Bread buttons on product pages and allow customers to pre-qualify for financing.

  • Display Lowest Available APR? will set the Bread button to show an “As low as” monthly price.
  • Button Identifier specifies the Bread button HTML ID attribute used on your product page template.

Cart Page

Enable Display Bread Button? to show a Bread button on the cart overview page and allow customers to pre-qualify for financing.

  • Display Lowest Available APR? will set the Bread button to show an “As low as” monthly price.
  • Button Identifier specifies the Bread button HTML ID attribute used on your cart page template.

Checkout

To enable Bread on your checkout page and allow customers to complete their purchase with Bread, you have to first create a “proxy” payment method from within Store Setup > Payments. Once the proxy payment method has been created in your store admin, navigate back to the Bread App settings page and select this payment method from the Proxy Payment Method drop down menu. This step is required for Bread to override a payment method and display on your checkout page. Note that if you are using BigCommerce Optimized One Step Checkout you must enable the Cash On Delivery payment,  set the “display name” to be “Bread # Pay Over Time” and select this as your proxy payment method.

 

  • Enable Display Lowest Available APR? to display an “As low as” monthly price next to the Bread payment method.
  • Enable Auto Settle Payments? to automatically settle Bread transactions. Please see if you qualify for auto-settlement with your main success point of contact.
  • Specify Payment Instructions to guide customers through the Bread check out flow.

Application Link Code

This section displays a script customized for your store that should be included in the Google Analytics section of your Web Analytics panel. This script is responsible for including the bread.js library.