Tickets - Login

Set Up Bolt for Miva

How to Install

1. Upload Plugin

  1. Download the boltpayments.mvc plugin file.
  2. Log into the Miva Admin Console non-Chrome-based browser.
  3. Navigate to Menu > Modules.
  4. Select the + icon > Add Module > Upload.
  5. Select Choose File.
  6. Navigate to the boltpayments.mvc file on your hard drive and select it.
  7. Select Upload. You are then returned to the Add Module screen.
  8. Select +Add.

2. Add Bolt Module to Store

Before you can configure the Bolt module, you must first assign it to your store.

  1. Log in to the Miva Admin Console.
  2. Navigate to Menu > Payment.
  3. Select the Add/Remove Modules.
  4. Locate Available Modules > Bolt (credit card).
  5. Select +Install.

Repeat for each store that you want to integrate with Bolt.

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 the Miva Admin Console.
  2. Navigate to Menu > Payment > Bolt (credit card).
  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.

Environments

Additional Settings

  1. Log in to the Miva Admin Console.
  2. Navigate to Menu > Payment > Bolt (credit card).
  3. Update the following settings:
    • Sandbox Mode: Enable/Disables sandbox.
    • Image Code: Choose the code for the image you wish to send to Bolt; default is main.
    • Fullfillment Modules: Choose Bolt’s plugins interaction with any post-checkout fulfillment modules:
      • Template Based Emails: Template-based emails are usually order confirmation emails, but some retailers send blind drop ship emails or other emails when an order is placed
      • Custom Fields: Ties custom order fields created in MIVA back to Bolt Orders
      • Marketplace: Reduces the items purchased from inventory on external marketplaces (ebay, etsy, etc)
    • Notes Custom Field: When enabled, captures Order Notes from the Bolt Checkout.
    • Enable Logging: Allows internal Miva logging for Bolt. All logs are placed in a boltlog.txt file accessible via samplewebsite.com/boltlog.txt
  4. Select Update to save.

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
    • Set the Shipping and Tax URL

Upgrade Bolt Plugin

The process to upgrade the Bolt module on your store is similar to the installation process.

  1. Download the boltpayments.mvc plugin file.
  2. Log into the Miva Admin Console non-Chrome-based browser.
  3. Navigate to Menu > Modules.
  4. Locate Search Modules and search for bolt.
  5. Hover over the Bolt (credit card) module. Select the upload icon.
  6. Select the Files tab > Upload.
  7. Select Choose File.
  8. Navigate to the boltpayments.mvc file on your hard drive and select it.
  9. Enable the Overwrite checkbox.
  10. Select Upload. You are returned to the Edit Module screen.
  11. Select Update.

Check Version

You can quickly check the version of your software by logging into the Miva Admin Console > Apps & Themes.


Troubleshooting

Create a User Interface Item

The Bolt module requires a User Interface Item. This should be automatically created for you during installation. In case that fails, you can use the following steps to automatically create the item.

  1. Log in to the Miva Admin Console.
  2. Navigate to Menu > User Interface > Items.
  3. Select the + icon.
  4. In the Code box, enter bolt.
  5. Select Look Up to find the boltpayment module.
  6. Select +Add.
  7. Select the Pages tab.
  8. Update the item in the Assigned column to On for all customer-facing pages (usually everything but batch reports, emails, and similar).

Template Changes

The Bolt module also requires some template changes. These should be automatically added to the correct locations when you install the module. However, in case it fails, use the following steps to modify your templates.

If the templates were changed automatically, you may also desire to move the button to a different location. If so, find the code shown in step 4, on the BASK page basket template. Remove it from the bottom of that template and place it where you would like the button to appear.

  1. Log in to the Miva Admin Console.
  2. Navigate to Menu > User Interface.
  3. Find and edit the BASK page.
  4. Just before the closing </head> tag, enter the following: <mvt:item name="bolt" param="connect" />.
  5. Then wherever you would like the Bolt checkout button to appear, enter this code: <mvt:item name="bolt" param="button" /> <mvt:item name="bolt" param="callback" />.
  6. If styling changes need to be made to the button replace <mvt:item name="bolt" param="button" /> with <div class="bolt-checkout-button" style=""></div>.
  7. Select Update to save.
  8. Return to Menu > User Interface.
  9. Select Settings.
  10. In the Head Tag Content box, insert the following: <mvt:item name="bolt" param="track" />
  11. Select Update to save.

boltstatus Custom Field

The Bolt module also uses a new custom field to help you view the status on the Order Processing batch screen. This should be automatically created when you install the module. However, in case it fails, use the following steps to create the boltstatus page.

  1. Log in to the Miva Admin Console.
  2. Navigate to Menu > Utilities.
    • If there is a Custom fields tab, select it and skip to step 3.
    • If no Custom Fields tab, select the Add/Remove modules tab.
      • Find the Custom Fields module and select +Install.
      • Select the new Custom Fields tab.
  3. Select the + icon.
  4. Update the following Fields:
    • Type: Order field
    • Code: boltstatus
    • Name: Bolt Status
  5. Leave other selections at their default value. You may enter additional information if you prefer.
  6. Save.