Set Up Bolt for Drupal


The minimal set of activated Drupal modules required for the plugin to run is as follows:

Module Dependencies

The commerce_bolt module is dependent on the following modules:

  • commerce
  • commerce_customer
  • commerce_line_item
  • commerce_price
  • commerce_product
  • commerce_order
  • commerce_payment
  • addressfield
  • entity
  • rules

How to Install

1. Upload Plugin

  1. Download or clone the source code.
  2. Upload the commerce_bolt directory to your modules directory.
  3. Enable all of the dependency modules.
  4. Enable all of the commerce_bolt module.

2. Enable Bolt Module

You can enable the module from the store admin panel or with the drush command:

drush en commerce_bolt -y

3. Configure Bolt Module

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.

  1. Log in to your Admin Console.
  2. Navigate to Boltpay > Bolt Payment Configuration.
  3. Update your API keys.
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.


Additional Settings

  1. Log in to your Admin Console.
  2. Navigate to Boltpay > Bolt Payment Configuration.
  3. Review the following options:
    • Enabled: Enables / Disable the Bolt Payment method.
    • Sandbox Mode: Setting up testing vs. production execution environment.
    • Automatic Capture Mode: Fund capture configuration
      • YES: Authorization and capture are done in a single step
      • NO: Funds are captured in a separate request, initiated either from the store admin panel or from the Bolt merchant dashboard
    • BOLT Checkout Pages: Pages in the commerce checkout flow that should display Bolt Multi-Page Checkout button
      • CHECKOUT
      • SHIPPING
  4. Select Submit to save.

3. Enable Bolt Module

  1. Log in to your Admin Console.
  2. Navigate to Payment Methods.
  3. Find Boltpay under the payment method rules.
  4. Enable Botlplay.

4. 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: [store_url]/boltpay/order_update
    • Set the Shipping and Tax URL to: [store_url]/boltpay/shipping_and_tax

Your Bolt Payment plugin is now installed and configured.


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.

How did we do?

📖On This Page