📍 Bolt Help / Core Products / Managed Checkout / Manage Bolt for Adobe Commerce / Set Up Bolt for Adobe Commerce

Set Up Bolt for Adobe Commerce

Bolt has launched a new Merchant Dashboard experience, which is currently in Beta. See this page for help documentation that reflects the new dashboard.


Before You Start

  • If you are migrating from a different cart platform, see the Re-platforming section.
  • See the table below to ensure compatibility between Bolt and your version of Magento.

Supported Versions


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. Log into 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.
  5. Send Magento 2 API Keys to Bolt. Go to Advanced Options, then click Create and send API keys to Bolt. This will send your M2 API credentials directly to Bolt to establish an OAuth connection. In the M2 dashboard, go to Advanced options to create and send API keys to Bolt.

Why do I need to send my Magento 2 API keys to Bolt?


Bolt 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. The publishable key is a long string of lower and upper case letters and numbers that consists of three sections. 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

Do not perform this step if you are using the Native API Integration.

  1. Log into 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 URL to: https://[store_url]/rest/V1/bolt/boltpay/shippingoptions
    • Set the Tax URL to: https://[store_url]/rest/V1/bolt/boltpay/tax
    • Set the Create Order URL to: https://[store_url]/rest/V1/bolt/boltpay/order/create

Your Bolt Payment Plugin is now installed and configured.

Optional Configuration

Fraud Only

If you are using Bolt’s Fraud-Only offering, complete the following steps in addition to those previously listed:

  1. Log into the store admin.
  2. Navigate to Store > Configuration > Sales > Payment Methods > Bolt Pay.
  3. Insert your Bolt key credentials for all of the following:
    • API key
    • Signing Secret
    • Publishable Key - Payment Only
  4. Scroll to the Where to add Bolt? section.
  5. Enable all of the following:
    • Native Checkout Page
  6. Uncheck all of the other options.
  7. Ensure there is no CSS in the Global CSS section. (In particular, any styling that might prevent the original checkout button from displaying.)

Embeddable Account Editing

It is possible to let customers manage their Bolt accounts within your Magento store. Contact your CSM to set up this feature.

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.

Re-platforming

When re-platforming, you must keep in mind all of the following:

  • Use the Merchant Dashboard for order refunds. Do not use a platform-specific backoffice flow that’s connected to a deprecated account division.
  • Disable all of your old webhooks for the deprecated account division.
📖On This Page
Filter by Section
Filter by Topic