Volusion Integration Steps

Locate your 2.0 api key, api secret, and integration keys

In order to integrate with Bread you will need 2.0 Access Keys. These keys are available in your new Merchant Portal. Sandbox versions of these keys are located in the Preview portal and can be used to run test transactions. It is recommended to work with the preview keys first. Access to the Merchant Portals will be setup by the Integration Manager supporting you during the upgrade. You can learn more about logging into the Merchant Portal here

Bread 2.0 Live Credentials: https://merchants.platform.breadpayments.com
Bread 2.0 Preview Credentials: https://merchants-preview.platform.breadpayments.com

Once logged in, first click on "Account Settings". Then click on the Account Settings drop down and select "Access Keys" to view your credentials. Keep this page open as you will need to reference these keys shortly

Create Your Volusion SFTP Account

  1. Follow the instructions at this link to set up and use your Volusion SFTP account

Download the Bread Pay Plugin

  1. Navigate to this link and download the zip containing the Bread Pay plugin
  2. Unzip the file and save in a place where it can be easily referenced in future steps
  3. Find the file located at bread/dashboard/settings.default.inc and rename the file to bread/dashboard/settings.inc

Upload the Bread Pay Plugin to Volusion

  1. Using the SFTP, upload the contents of the folder from the previous step into a folder named bread
  2. In the schema folder, there are two files called orderHistory.sql and orderHistory.xsd. Use the SFTP program to add those to /vspfiles/schema/Generic.

Add Bread Scripts to Your Theme Template

  1. Log into the Volusion administration page
  2. Edit the theme template at the following path Design > File Editor > Template_xxx.html
  3. Add the following script tag to the bottom of the template just before the closing tag
    <script type="text/javascript" src="/v/bread/js/bread.controller.js"></script>
  4. Add the following lines to the top of the template just before the closing tag:
    <link rel="preconnect" href="https://fonts.googleapis.com">
    <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
    <link href="https://fonts.googleapis.com/css2?family=Poppins&display=swap" rel="stylesheet">


Removing Bread Classic

This directory is designed to be used with Bread Pay 2.0 or Platform instances. It is not compatible with Bread Pay Classic. Any Volusion Store set up after May 2023 will be on Bread Pay 2.0 or later. If you're not sure which version you're using, speak to our Customer Support team or your Solutions Engineer

In the event you integrated with Bread Classic, you will need to uninstall the Classic modules

Configure Volusion Settings

  1. Navigate to Settings > Checkout and ensure Premium Checkout is NOT selected
  2. Create a payment method for Bread Pay
    1. Navigate to Settings > Payment
  1. Copy the following: Bread Pay™ - Pay Over Time. Click Add
    1. This is the payment type your customers will choose when they checkout with Bread Pay
    2. Note the ID associated with this payment type. You will need it later when filling out your Bread plugin settings

Navigate to Your Bread Pay Dashboard

  1. Once you've installed Bread Pay via SFTP, your Bread Pay Dashboard can be found at the URL following this naming convention: https://your-store-url.com/v/bread/dashboard
    1. Note: replace your-store-url with the homepage of your Volusion store website
    2. Ask your contact at Bread Pay for the store password
    3. Enter a new password in the Password and Update Password fields, select Update Password, scroll the bottom of the page and click Save


jQuery Version Requirement

If your Volusion site does not contain a reference to a version of jQuery greater than or equal to 1.11.x in the window.jQuery variable, the following code must also be added just before the bread.controller.js script tag

<script type="text/javascript" src="//ajax.googleapis.com/ajax/libs/jquery/1.11.1/jquery.min.js"></script>
<script type="text/javascript">
$jQueryModern = jQuery.noConflict(true);

Configure Bread Pay Plugin Settings

Bread Pay Integration Settings

  1. Select the Environment based on the current phase in your integration

    Sandbox(Preview)Using the sandbox environment makes requests against the Bread Pay sandbox api. It should only be used for testing using sandbox credentials provided by Bread Pay
    ProductionThe production environment is used for real transactions and requires live api credentials
  2. Add your Integration Keys

    1. The Bread API keys and secret are provided from your account interface in the Bread Pay Merchant Portal. Work with your integration or success manager to get you access to the Portal
  3. Add the Bread Pay Authorization

    1. The authorization to the Bread Pay API must be obtained using a basic authorization header generator such as: https://www.blitter.se/utils/basic-authentication-header-generator/
    2. Your api key is the username and your secret key is the password. Copy any paste the authorization string starting with the word "Basic"
  4. Add the Payment Method ID and Name

    1. In Volusion under Settings > Payment, create a payment type for your customers to use to check out using Bread Pay. Click on "View List" in the top right to see the ID number. Copy the ID and Name into these fields. They will be reflected on your Volusion store checkout page
  5. Scroll to the bottom of the page and click Save

Bread Pay Settings

  1. The Bread Pay plugin contains a set of fields which can be configured based on your needs. Descriptions of the fields functionality can be found under the fields in the app
  2. Scroll to the bottom of the page and click Save

Bread Pay Volusion API Settings

  1. These fields are required in order to connect to your Volusion Store, as well as to make sure that your customers get email confirmations from Volusion when they checkout with Bread Pay
Field NameDescription
Store NameThe name of your store
API URL, Domain, Login, and Password- To get your api url, you must do a sample export from your volusion admin:
- Inventory > Import/Export > Volusion API > Generic > Run
- Then click the Run button in the top right of the page
- Copy the provided url and then paste it into the volusion API URL configuration field on the bread configuration dashboard.
- The Domain, Login, and Password will be filled in automatically
Send Order Confirmation FromEmail confirmations will be sent to your customers from this address when they complete a Bread Pay checkout
Send Order Merchant Confirmation ToWhen a new order is placed via Bread Pay, a confirmation email will also be sent to this address
  1. Scroll to the bottom of the page and click Save

Bread Pay Service Tools

  1. The following fields can be enabled if desired:

    Field NameDescription
    Debug ToolsChecking this box will enable logs that can be used for troublshooting problems. These log files will be generated in your files under v/bread/asp
    Disable AutoloadIf this box is checked, no Bread Pay buttons will appear on your site, unless you add ?bread_test to the end of the page URL
  2. Scroll to the bottom of the page and click Save

Refreshing Bread Pay


Ongoing Maintenance

  • Volusion does not send data to the Bread Pay Merchant Portal automatically. Click the Refresh Bread Pay to send data on order changes such as settlements, cancellations, and refunds to the Bread Pay Merchant Portal


Resetting the Volusion API

Volusion's API can occassionally fail. If you click the Refresh button but don't see a change, or don't see the updates you expect, reset the Volusion API by following the following steps:

  • In your Volusion Dashboard, open Inventory > Volusion API
  • Click "Run" next to Generic/Orders
  • Choose a date from the "Select Date" dropdown based on how far back you want to reset the API
    Note: Volusion can only send 100 lines of data at a time from its API. If you have had many new or updated orders, you may want to do several resets over a smaller time in order to be sure that Volusion is able to share them. Remember that managing your orders directly in the Bread Pay Merchant Portal is also possible
  • If needed, choose a particular order ID to reset. This will only reset that one order, and is helpful if you're only seeing one or two orders not updating as expected
  • Click "Reset Export," and then return to your Bread Pay Dashboard and click "Refresh Bread" again.
    If you still aren't seeing the updates you expect, please reach out to Bread Financial Support

Integration Complete!

You may now proceed to Testing or Go-live depending on the status of your integration project