About the Merchant API

The Merchant API is a general endpoint on your ecommerce server that Bolt can use to make synchronous calls and retrieve information. This information includes details on shipping, tax, and viable discounts codes.

How to Connect Bolt to Your Merchant API Endpoint

  1. Log in to your Merchant Dashboard.
  2. Navigate to Developers > Keys.
  3. Scroll to URL Configurations.
  4. Select Edit next to your platform and input the URL (example: www.mystore.com/boltpay/).
  5. Select Update.

Repeat to set up your Merchant Sandbox environment.

API Format & Details

Use our official API Reference to see request and response formats for each API type.

Merchant API Types

  • order.create: Verifies that an order can be created before payment authorization.
  • order.shipping_and_tax: Retrieves shipping and tax options for a given order.
  • discount.code.apply: Applies any discounts entered in the Bolt Checkout.

Request Verification

All requests sent from Bolt to your Merchant API are signed by HMAC to ensure authenticity. You must verify these request signatures using the Signing Secret found in your Merchant Dashboard > Developers > API > Keys.

$hmac_header = $_SERVER['X-Bolt-Hmac-Sha256'];

function verify_webhook($payload, $hmac_header) {
  $computed_hmac = base64_encode(hash_hmac('sha256', $payload, BOLT_SIGNING_SECRET, true));
  return ($computed_hmac == $hmac_header);

Errors & Troubleshooting

To send back specific errors in merchant api responses visit the error codes reference article.

📖On This Page