Bolt Developer

Welcome to the Bolt developer hub. You'll find comprehensive guides and documentation to help you start working with Bolt as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    Docs

Magento Commerce Integration

Supported Versions

Open Source (CE)
2.0, 2.1, 2.2, 2.3
Commerce using on prem (EE)
2.0, 2.1, 2.2, 2.3

Composer PHP Dependency Manager

1. Plugin Installation

Open command prompt, go to <MAGENTO_ROOT> folder and run the following

$ composer require boltpay/bolt-magento2
$ php bin/magento setup:upgrade
$ php bin/magento setup:di:compile
$ php bin/magento setup:static-content:deploy -f
$ php bin/magento cache:clean
$ php bin/magento cache:flush

2. Plugin configuration

Login to the store admin panel.
Navigate to StoresConfigurationSalesPayment MethodsBolt Pay.
The essential settings are described below.

  • Enabled dropdown enables / disables the Bolt Payment method.
    Select Yes to enable it.
  • Enter an appropriate Title such as Credit & Debit Cards

API credentials

The following four required values, (i.e. API Key, Signing Secret, Publishable Key - Multi Step, and Publishable Key - Payment Only can be found in your Bolt Merchant Dashboard under SettingsUsers and Keys

For production, these will be found at:

For sandbox mode, use the following URL:

  • API Key
    used for calling Bolt API from your back-end server
  • Signing Secret
    used for signature verification in checking the authenticity of webhook requests
  • Publishable Key - Multi Step
    used to open the Bolt Payment Popup typically on Shopping cart and product pages
  • Publishable Key - Payment Only
    used to open the Bolt Payment Popup typically on checkout pages
  • Sandbox Mode
    setting up testing vs. production execution environment

YES - both authorization and capture are done in a single step
NO - the funds are captured in a separate request, initiated either from the store admin panel or from the Bolt merchant dashboard

  • Replace Button Selectors
    comma separated list of CSS selectors matching the elements to be replaced with Bolt checkout buttons, or Bolt checkout buttons placed alongside them

Selector options

no suffix - the default
inserts Bolt button in place of the element and removes the element
|append suffix - example-selector|append
inserts Bolt button right after the element

|prepend suffix - example-selector|prepend
inserts Bolt button right before the element

3. Bolt Merchant Dashboard configuration

Login to the Bolt Merchant Dashboard

  • Navigate to SettingsKeys and URLs
  • Scroll down to the URL Configurations section
  • Set Webhook URL to: [store_url]/rest/V1/bolt/boltpay/order/manage
  • Set Shipping and Tax URL to: [store_url]/rest/V1/bolt/boltpay/shipping/methods


Your Bolt Payment Plugin is now installed and configured.

Magento Commerce Integration

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.