Upgrade Your Magento Store to the Bread 2.0 Platform

The Bread Pay™ 2.0 Platform is here and we’ve enhanced our product with your business in mind! This upgrade will unlock enhancements designed to drive conversion for your business.


This platform upgrade is required in 2023.

Upgrade Steps:

Step 1: Locate Your Platform API Key, API Secret, and Integration Keys

In order to Upgrade you will need Platform 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 Platform Live Credentials: https://merchants.platform.breadpayments.com
Bread Platform 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.

Step 2: Update to the Newest Version of the Bread Pay Plugin(2.3.0 or newer)

  1. The newest version of the plugin can be found here.
  2. Follow the installation instructions to make sure your version is compatible with the newest Bread features.


Site Customizations & Third Party Apps

The Bread Pay plugin was designed to work with native Magento 2 features and functionality. The plugin does not support all third party applications available on the Magento 2 marketplace. Installing these applications or performing customizations to your product, cart, category, and checkout pages can result in issues loading Bread elements.

Step 3: Configure the Bread Pay™ App for Platform

  1. From your Installed Plugins page, navigate to Stores > Configuration > SALES > Payment Methods.
  2. Within Payment Methods, under the OTHER PAYMENT METHODS section you will find a drop down for the Bread Pay Checkout app. Expand the menu to view the app settings.
    a. Click the dropdown for API Version and select Bread Platform.
    b. Note: If you will be using Preview keys for test transactions, select Sandbox in the API Version dropdown. Otherwise, select Live.


Copy Classic API Keys and Paste into Platform API Key Fields

After switching the Bread API Version to Platform, your Classic API Keys may populate in the Platform API Key Fields.

These keys should be copied and pasted in to the Classic API Key fields(If you lose your Classic API keys, they can be found in the Classic Merchant Portal or be provided by your integration manager).

This step is required to be able to manage Bread Classic orders through the Magento OMS.

c. Copy and paste the keys you located in step 1 into the corresponding fields, outlined in the red box below.

Scroll to the bottom of the settings page and click Save changes.

The checkout experience has been upgraded to Bread Pay™ Platform. All new Orders will be created on our enhanced platform.

Step 4: Configure Bread Settings and Placement/Button Styling


Previous Button Customization Using CSS

Our enhanced platform renders Bread buttons differently. Custom CSS Styling in the settings is for Bread Classic only and will not apply to the new buttons.

In order to customize button styling using CSS, you will need to add the CSS directly in to your website's code.

Applicable settings will automatically transfer over and apply to the new Platform. Additional changes can be made if needed.

Step 5: Update any Custom Integrations (Financing & Category Pages, or Banners)

Any aspects of your Classic integration that directly referenced Bread JavaScript will need to be updated to use the Bread Platform SDK. General guidance on working with the Bread SDK can be found here.

When updating your financing Page, we have an HTML template that can be used. The financing template can be found here.