PHPackages                             breadfinance/module-breadcheckout - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Payment Processing](/categories/payments)
4. /
5. breadfinance/module-breadcheckout

ActiveMagento2-module[Payment Processing](/categories/payments)

breadfinance/module-breadcheckout
=================================

Offers Bread Pay financing and checkout tools for your Magento store

2.4.8(3mo ago)650.9k↓46.7%6[6 issues](https://github.com/getbread/magento-v2-bread/issues)[19 PRs](https://github.com/getbread/magento-v2-bread/pulls)MITPHPPHP ~8.1.0||~8.2.0||~8.3.0||~8.4.0

Since Sep 26Pushed 3mo ago28 watchersCompare

[ Source](https://github.com/getbread/magento-v2-bread)[ Packagist](https://packagist.org/packages/breadfinance/module-breadcheckout)[ RSS](/packages/breadfinance-module-breadcheckout/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)DependenciesVersions (181)Used By (0)

Bread Pay Checkout for Magento 2
================================

[](#bread-pay-checkout-for-magento-2)

Helping retailers acquire and convert more customers.

Bread Pay Features
------------------

[](#bread-pay-features)

- Full Funnel. Your shoppers can discover, pre-qualify, and check out from anywhere - your homepage, category page, product page, cart, or checkout.
- Real-Time Decision. Pre-qualification is quick and easy. Let your customers learn about their purchase power in seconds without ever leaving your site.

Installation
------------

[](#installation)

### Install using Zip archive

[](#install-using-zip-archive)

1. Download repository as zip file
2. Unzip contents into `app/code/Bread/BreadCheckout` folder
3. Setup files ( For Canada Merchants )

- Copy file `app/code/Bread/BreadCheckout/etc/adminhtml/system.ca.xml` to `app/code/Bread/BreadCheckout/etc/adminhtml/system.xml`
- Copy file `app/code/Bread/BreadCheckout/view/adminhtml/web/js/validation.ca.js` to `app/code/Bread/BreadCheckout/view/adminhtml/web/js/validation.js`

4. Enable module ```
    bin/magento module:enable Bread_BreadCheckout
    bin/magento setup:upgrade
    bin/magento setup:di:compile
    bin/magento setup:static-content:deploy
    ```

### Install using composer.

[](#install-using-composer)

1. Navigate to your Magento 2 root folder
2. Install the Bread Checkout module

    ```
    composer require breadfinance/module-breadcheckout
    ```
3. For Canada Merchants only

- Copy file `app/code/Bread/BreadCheckout/etc/adminhtml/system.ca.xml` to `app/code/Bread/BreadCheckout/etc/adminhtml/system.xml`
- Copy file `app/code/Bread/BreadCheckout/view/adminhtml/web/js/validation.ca.js` to `app/code/Bread/BreadCheckout/view/adminhtml/web/js/validation.js`

4. Enable module ```
    bin/magento module:enable Bread_BreadCheckout
    bin/magento setup:upgrade
    bin/magento setup:di:compile
    bin/magento setup:static-content:deploy
    ```

Usage instructions:
-------------------

[](#usage-instructions)

### For US Merchants

[](#for-us-merchants)

See documentation at Contact your Bread Pay representative for login credentials.

### For Canada Merchants

[](#for-canada-merchants)

See documentation at Contact your Payplan representative for login credentials.

Development Environment Setup
-----------------------------

[](#development-environment-setup)

This guide sets up a local Magento environment using [markshust/docker-magento](https://github.com/markshust/docker-magento). Refer to the repository for more details, configuration options, and available commands.

### 1. Create Project Directory &amp; Download Docker Template

[](#1-create-project-directory--download-docker-template)

```
mkdir docker-magento
cd docker-magento
curl -s https://raw.githubusercontent.com/markshust/docker-magento/master/lib/template | bash
```

### 2. Configure environment and versions

[](#2-configure-environment-and-versions)

Open the compose.yaml file and confirm the PHP and DB versions matches your target environment.

For PHP 8.2, ensure the following line is present:

```
phpfpm:
  image: markoshust/magento-php:8.2-fpm-4

```

For MySQL, ensure compatible version is used. Magento currently (As of 6/2025) supports:

MySQL 8.0

MySQL 5.7

MariaDB 10.2 – 10.6

### 2a. Trust Internal Root CA (e.g. Netskope) in Container

[](#2a-trust-internal-root-ca-eg-netskope-in-container)

If you're on a corporate network that intercepts HTTPS traffic (e.g., via Netskope), you may encounter SSL errors like:

```
curl: (60) SSL certificate problem: self-signed certificate in certificate chain

```

To fix this, you must import your organization's root certificate into the container.

- Visit  in Chrome.
- Click the padlock icon → "Certificate is valid".
- In the Certification Path tab, select the top-level certificate (e.g., ca.alliancedata.goskope.com).
- Click View Certificate → Details → Copy to File.
- Save as Base-64 encoded X.509 (.CER) — name it netskope\_root.cer.
- Place the file in the project root.
- Run these commands

```
docker cp  phpfpm:/usr/local/share/ca-certificates/netskope_root.crt

```

```
docker exec -u 0 -it phpfpm bash
update-ca-certificates

```

- This will copy the cert into the phpfpm container and update the container’s trusted certificate store.
- You should now be able to run bin/download and composer install without SSL errors.

### 3. Download Magento

[](#3-download-magento)

Download the Magento version you want (replace 2.4.8 with your desired version):

```
bin/download 2.4.8

```

### 4. Set Up Magento Environment

[](#4-set-up-magento-environment)

Run the following commands to complete setup and install sample data:

```
bin/setup magento.test
bin/magento sampledata:deploy
bin/magento setup:upgrade

```

Disable Two-Factor Authentication for local development:

```
bin/composer require markshust/magento2-module-disabletwofactorauth
bin/magento module:enable MarkShust_DisableTwoFactorAuth
bin/magento setup:upgrade

```

### 5. Install Bread Magento Extension

[](#5-install-bread-magento-extension)

Clone the Bread extension into app/code and enable the module:

```
cd src/app/code
mkdir Bread
cd Bread
git clone git@github.com:getbread/magento-v2-bread.git BreadCheckout
cd ../../../../

bin/magento module:enable Bread_BreadCheckout
bin/magento setup:upgrade
bin/magento cache:flush

```

Resetting Your Local Magento Environment
----------------------------------------

[](#resetting-your-local-magento-environment)

To completely remove your local Magento installation and start fresh:

### 1. Navigate to the root of your Magento project:

[](#1-navigate-to-the-root-of-your-magento-project)

```
cd /path/to/your/magento-docker-dev

```

### 2. Run the cleanup script and delete all files (including hidden ones):

[](#2-run-the-cleanup-script-and-delete-all-files-including-hidden-ones)

```
bin/removeall
rm -rf .[^.]* *

```

⚠️ Warning: This will permanently delete all files and directories in the current folder. Make sure you’re in the correct location before running this command.

###  Health Score

61

—

FairBetter than 99% of packages

Maintenance62

Regular maintenance activity

Popularity36

Limited adoption so far

Community28

Small or concentrated contributor base

Maturity100

Battle-tested with a long release history

 Bus Factor3

3 contributors hold 50%+ of commits

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~53 days

Recently: every ~136 days

Total

54

Last Release

90d ago

Major Versions

1.1.19 → 2.0.12022-06-14

PHP version history (12 changes)v1.0.4PHP ~5.6.0|7.0.2|~7.0.6

v1.0.5PHP 7.0.2|7.0.4|~7.0.6|~7.1.0

1.1.0PHP ~7.1.3||~7.2.0

1.1.2PHP ~5.6.5||7.0.2||7.0.4||~7.0.6||~7.1.0||~7.1.3||~7.2.0

1.1.10PHP ~7.0.13||~7.1.0||~7.1.3||~7.2.0

1.1.11PHP ~7.0.13||~7.1.0||~7.1.3||~7.2.0||~7.3.0

1.1.17PHP ~7.0.13||~7.1.0||~7.1.3||~7.2.0||~7.3.0||~7.4.0

2.0.1PHP ~7.0.13||~7.1.0||~7.1.3||~7.2.0||~7.3.0||~7.4.0||~8.0.0||~8.1.0

2.3.1PHP ~7.0.13||~7.1.0||~7.1.3||~7.2.0||~7.3.0||~7.4.0||~8.0.0||~8.1.0||8.2.0

2.3.2PHP ~7.0.13||~7.1.0||~7.1.3||~7.2.0||~7.3.0||~7.4.0||~8.0.0||~8.1.0||~8.2.0

2.4.6PHP ~7.0.13||~7.1.0||~7.1.3||~7.2.0||~7.3.0||~7.4.0||~8.0.0||~8.1.0||~8.2.0||~8.3.0

2.4.8PHP ~8.1.0||~8.2.0||~8.3.0||~8.4.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/06a7d97e92e89f53ff11e9a14ce580b3501def09f1f7c04837e0631952b7bc35?d=identicon)[kiprotich.maritim](/maintainers/kiprotich.maritim)

![](https://www.gravatar.com/avatar/bfca7a8072c20c78993c943f50868f387c660f72c81541421c81f84e6749e3bc?d=identicon)[jkeller](/maintainers/jkeller)

![](https://www.gravatar.com/avatar/762ad06913f993d27a589504527c4b95e64c93fe66d91bb689105e08b2c02141?d=identicon)[el.mehdi](/maintainers/el.mehdi)

![](https://www.gravatar.com/avatar/2efdd75f0f273fb76e1136ec8fc08cef350f8a2c408ad034d237713756387f17?d=identicon)[fkhan](/maintainers/fkhan)

---

Top Contributors

[![fkhan-bread](https://avatars.githubusercontent.com/u/126727411?v=4)](https://github.com/fkhan-bread "fkhan-bread (138 commits)")[![aleksa-andersinnovation](https://avatars.githubusercontent.com/u/37845675?v=4)](https://github.com/aleksa-andersinnovation "aleksa-andersinnovation (133 commits)")[![KiprotichMaritim](https://avatars.githubusercontent.com/u/12558727?v=4)](https://github.com/KiprotichMaritim "KiprotichMaritim (97 commits)")[![mirandajohnson](https://avatars.githubusercontent.com/u/19955568?v=4)](https://github.com/mirandajohnson "mirandajohnson (53 commits)")[![dfroneberger](https://avatars.githubusercontent.com/u/12517084?v=4)](https://github.com/dfroneberger "dfroneberger (39 commits)")[![omgitsdev](https://avatars.githubusercontent.com/u/7592820?v=4)](https://github.com/omgitsdev "omgitsdev (35 commits)")[![JelenaAndersInnovations](https://avatars.githubusercontent.com/u/36050928?v=4)](https://github.com/JelenaAndersInnovations "JelenaAndersInnovations (29 commits)")[![alexnick173](https://avatars.githubusercontent.com/u/30112365?v=4)](https://github.com/alexnick173 "alexnick173 (20 commits)")[![alexxss1986](https://avatars.githubusercontent.com/u/13381082?v=4)](https://github.com/alexxss1986 "alexxss1986 (14 commits)")[![nenadstojic](https://avatars.githubusercontent.com/u/4557206?v=4)](https://github.com/nenadstojic "nenadstojic (4 commits)")[![weigao10](https://avatars.githubusercontent.com/u/32995660?v=4)](https://github.com/weigao10 "weigao10 (2 commits)")[![dksimon](https://avatars.githubusercontent.com/u/8008640?v=4)](https://github.com/dksimon "dksimon (2 commits)")[![sampurcell](https://avatars.githubusercontent.com/u/9835549?v=4)](https://github.com/sampurcell "sampurcell (2 commits)")[![jdunn-bread](https://avatars.githubusercontent.com/u/127771709?v=4)](https://github.com/jdunn-bread "jdunn-bread (1 commits)")[![jenlesamuel](https://avatars.githubusercontent.com/u/3932353?v=4)](https://github.com/jenlesamuel "jenlesamuel (1 commits)")

### Embed Badge

![Health badge](/badges/breadfinance-module-breadcheckout/health.svg)

```
[![Health](https://phpackages.com/badges/breadfinance-module-breadcheckout/health.svg)](https://phpackages.com/packages/breadfinance-module-breadcheckout)
```

###  Alternatives

[omnipay/paypal

PayPal gateway for Omnipay payment processing library

3156.8M53](/packages/omnipay-paypal)[eduardokum/laravel-boleto

Biblioteca com boletos para o laravel

626351.9k2](/packages/eduardokum-laravel-boleto)[tbbc/money-bundle

This is a Symfony bundle that integrates moneyphp/money library (Fowler pattern): https://github.com/moneyphp/money.

1961.9M](/packages/tbbc-money-bundle)[2checkout/2checkout-php

2Checkout PHP Library

83740.3k2](/packages/2checkout-2checkout-php)[smhg/sepa-qr-data

Generate QR code data for SEPA payments

61717.2k5](/packages/smhg-sepa-qr-data)[omnipay/dummy

Dummy driver for the Omnipay payment processing library

271.2M33](/packages/omnipay-dummy)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
