📍 Bolt / Developers / Developer Guides / Checkout Setup / Managed Checkout Setup / Set Up Bolt for Magento Commerce
👎

Set Up Bolt for Magento Commerce

How to Install

The location of the Magento 2 root folder depends on where you originally installed Magento and is also driven by your webhosting company. If you navigate to your Magento 2 root, you’ll see the following folders:

  • app
  • bin
  • dev
  • lib
  • pub
  • var
  • vendor

1. Upload Plugin

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

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

2. Configure Plugin

  1. Login to the store admin panel.
  2. Navigate to Stores > Configuration > Sales > Payment Methods > Bolt Pay.
  3. Set the Enabled dropdown to Yes.
  4. Enter an appropriate Title such as Credit & Debit Cards.

API credentials

The following values can be found in the Bolt Merchant Dashboard by navigating to Developer > API > Keys. You must set up at least one Publishable key.

Key Description Required?
API Key Calls Bolt API from your back-end server Yes
Signing Secret Verifies signature by checking the authenticity of webhook requests Yes
Publishable Key - Multi-Step Opens the Bolt Payment Popup typically on Shopping cart and product pages No
Publishable Key - Payment Only Opens the Bolt Payment Popup typically on checkout pages No
Publishable Key - Back-office Used in the back office of Magento for manually-created orders. No

Each Publishable Key type requires a separate division is set up for your account.

Environments

Additional Settings

  • Sandbox Mode: Setting up testing vs. production execution environment
    • YES: Accepts test cards when placing an order
    • NO: Requires real credit cards to place an order
  • Replace Button Selectors: A comma-separated list of CSS selectors matching the elements to be replaced with Bolt Checkout buttons or Bolt checkout buttons placed alongside them:
    • no suffix (default): inserts Bolt button in place of the element and removes the element
    • append suffix: Inserts Bolt button right after the element (example-selector|append)
    • prepend suffix: Inserts Bolt button right before the element (example-selector|prepend)

3. Add Webhook Endpoints in Merchant Dashboard

  1. Login to the Bolt Production Merchant Dashboard and Sandbox Merchant Dashboard.
  2. Navigate to Developer > Webhooks
  3. Scroll to Webhook Endpoints.
    • Set the Webhook URL to: https://[store_url]/rest/V1/bolt/boltpay/order/manage
    • Set the Shipping and Tax URL to: https://[store_url]/rest/V1/bolt/boltpay/shipping/methods
    • Set the Create Order URL to: https://[store_url]/rest/V1/bolt/boltpay/order/create

Your Bolt Payment Plugin is now installed and configured.

Review Order Statuses & Platform Operations

You can review Magento Commerce order statuses and platform operations in our Platform Operations guide.


Update Plugin

Use the following script with Composer to upgrade to the latest Bolt M2 Plugin Version.

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

To upgrade to a specific Bolt M2 Plugin Version, please replace the first command with:

composer require boltpay/bolt-magento2:version

Check Version

See Magento Commerce’s documentation for more information.

Supported Versions

Bolt Plugin Version Release Date Supported Until Open Source (CE) Commerce (EE)
2.21.2 05/12/2021 05/12/2022 ≥ 2.3 ≥ 2.3
2.21.0 04/08/2021 04/08/2022 ≥ 2.3 ≥ 2.3
2.20.0 03/04/2021 03/04/2022 ≥ 2.3 ≥ 2.3
2.19.0 02/10/2021 02/10/2022 ≥ 2.3 ≥ 2.3
2.18.0 01/07/2021 01/07/2022 ≥ 2.3 ≥ 2.3
2.17.0 11/03/2020 11/03/2021 ≥ 2.3 ≥ 2.3
2.16.0 10/19/2020 10/19/2021 ≥ 2.3 ≥ 2.3
2.15.0 10/05/2020 10/05/2021 ≥ 2.3 ≥ 2.3
2.14.0 09/15/2020 09/15/2021 ≥ 2.3 ≥ 2.3
2.13.0 08/26/2020 08/26/2021 ≥ 2.3 ≥ 2.3
2.12.0 08/11/2020 08/11/2021 ≥ 2.3 ≥ 2.3
2.11.0 07/29/2020 07/29/2021 ≥ 2.3 ≥ 2.3
2.10.0 07/20/2020 07/20/2021 ≥ 2.3 ≥ 2.3
2.9.0 06/24/2020 06/24/2021 ≥ 2.3 ≥ 2.3
2.8.1 06/17/2020 06/17/2021 2.2 & Above 2.2 & Above
2.8.0 06/04/2020 06/04/2021 2.2 & Above 2.2 & Above
2.7.0 05/12/2020 05/12/2021 2.2 & Above 2.2 & Above
2.6.0 04/24/2020 04/24/2021 2.2 & Above 2.2 & Above
2.5.0 04/10/2020 04/10/2021 2.2 & Above 2.2 & Above
2.4.1 03/20/2020 03/20/2021 2.2 & Above 2.2 & Above
2.4.0 03/20/2020 03/20/2021 2.2 & Above 2.2 & Above
2.3.0 02/25/2020 02/25/2021 2.2 & Above 2.2 & Above
2.2.0 02/03/2020 02/03/2021 2.2 & Above 2.2 & Above
2.1.0 09/21/2019 09/21/2020 2.2 & Above 2.2 & Above
2.0.2 10/08/2019 10/08/2020 2.2 & Above 2.2 & Above
2.0.1 09/06/2019 09/06/2020 2.2 & Above 2.2 & Above

Disable Bolt Plugin

You must have access to the root drive of your Magento installation in order to disable the Bolt plugin.

  1. Log in via SSH/CLI to your domain and navigate to the <MAGENTO_ROOT>.
  2. Run bin/magento module:disable Bolt_Boltpay.
  3. Run bin/magento setup:upgrade.

Uninstall Bolt Plugin

You must have access to the root drive of your Magento installation in order to disable the Bolt plugin.

  1. Log in via SSH/CLI to your domain and navigate to the <MAGENTO_ROOT>.
  2. Run bin/magento module:disable Bolt_Boltpay.
  3. Run bin/magento setup:upgrade.
  4. Run composer remove boltpay/bolt-magento2.
📖 On This Page