LokiCheckout_BreadPay

This integration is available in the paid plans for the Loki Checkout. Support for this integration is provided as is, because we are depending upon the original vendor as well. High priority support is only available on an hourly basis.
Integration
Payment
Professional
PHP 8.2 - 8.5
Magento 2.4.6 - 2.4.9
CSP Yes
Integration Tests 43
Functional Tests 7
PHPStan 5
Magento PHPCS 7
License OSL-3.0
Latest Release 0.0.1

This Magento 2 module is an add-on package to the LokiCheckout.

Installation

Install this package via composer:

composer require loki-checkout/magento2-bread-pay

Next, enable this module:

bin/magento module:enable LokiCheckout_BreadPay

Features

  • Adds the Bread Pay payment methods of the module breadfinance/module-breadcheckout (Bread_BreadCheckout) to the Loki Checkout: breadcheckout (Bread Pay, USD) and rbccheckout (PayPlan by RBC, CAD). The method that is shown follows the tenant that Bread derives from the store currency.
  • Supports the Bread Platform API (api_version = bread_2) only; the classic Bread API is not supported.
  • Modal flow: when the shopper places the order, the Bread application opens in a popup. Embedded flow (Enable Embedded Checkout): the application is rendered inside the payment method form and needs to be completed before placing the order.
  • The Bread transaction is verified server-side (via the Bread API) against the quote total and currency before the order can be placed. When the cart changes afterwards, the shopper needs to complete the application again.
  • When Show "as low as" pricing or Enabled on Cart Overview Page is enabled, a "See if you prequalify" button is added to the fast checkout block. This never places an order.
  • Bread Pay and PayPlan by RBC payment icons.

Configuration

Configure Bread Pay under Stores > Configuration > Sales > Payment Methods > Bread Pay Checkout as documented by Bread. Make sure that API Version is set to the Bread Platform and that Display as Payment Method on Checkout is enabled. The integration key is used in the browser; the API secret key never leaves the server.

Testing

The Playwright tests stub the Bread SDK and use the test-only module LokiCheckout_BreadPayTestFixture (in Test/Fixture, installed by hersir-additional.sh) to replace the Bread API client. Never install this fixture module in production.

Current status

pipeline success

Support

For getting support, create an Issue under the following project URL:

https://gitlab.loki-extensions.com/loki-checkout/LokiCheckout_BreadPay.git

Loki Components

The following LokiComponents are created or references in this module:

loki-checkout.payment.methods.breadcheckout.form loki-checkout.payment.methods.rbccheckout.form
Module Dependencies

The following dependencies are declared in the module its `etc/module.xml` file:

Bread_BreadCheckout LokiCheckout_Core Loki_Base Loki_Components Loki_CssUtils Loki_FieldComponents Magento_AdminNotification Magento_Backend Magento_Catalog Magento_CatalogInventory Magento_Checkout Magento_CheckoutAgreements Magento_Cms Magento_Config Magento_Csp Magento_Customer Magento_Directory Magento_Eav Magento_Indexer Magento_MediaGalleryUiApi Magento_Newsletter Magento_Payment Magento_Quote Magento_Rule Magento_Sales Magento_SalesRule Magento_SalesSequence Magento_Shipping Magento_Store Magento_Tax Magento_Theme Magento_Ui Magento_User Magento_Variable Magento_Vault Magento_Widget Yireo_CspUtilities
Composer details
Magento module name
LokiCheckout_BreadPay
Composer name
loki-checkout/magento2-bread-pay
Composer version
No release yet
Default branch
main
Requirements
breadfinance/module-breadcheckout: ^2.5 || dev-master
ext-pcre: *
loki-checkout/magento2-core: ^2.8.0
loki/magento2-components: ^2.8
loki/magento2-css-utils: ^1.0
magento/framework: ^103.0
magento/module-checkout: ^100.4
magento/module-quote: ^101.2
magento/module-store: ^101.1
php: >=8.2 <8.6
psr/log: ^1.0 || ^2.0 || ^3.0
Releases
0.0.1 22 November 2026
Changelog

[0.0.1] - 16 November 2026

Initial release

  • Add Bread Pay prequalify button to the fast checkout block
  • Add Bread Pay checkout modal and embedded flow with payment icons
  • Add Bread Pay and RBC PayPlan payment components with server-side transaction validation

Last modified: November 16, 2026