Install Bolt Connect SDK

Before you begin, install the SDK using one of the following methods:

Using npm

Using yarn

Using pnpm

Using bun

Direct download from npm registry

Alternatively, you can download the package directly from the npm registry: Package info: https://registry.npmjs.org/@boltpay/bolt-connect-sdk

Quick Start

Follow these steps to onboard sellers using the Bolt Connect SDK.

Step 1: Import the SDK

Step 2: Configure Onboarding

API Reference

Description
Set up the onboarding configuration with your credentials and event callbacks.
Parameters Example

Step 3: Start Onboarding

API Reference

Description
Starts the onboarding form as a full-age iframe within your site.
Example

Step 4: Get Seller Information and Onboarding Status

API Reference

Description
Fetches seller information and current onboarding status.
Parameters Returns Example

Caching

The SDK includes intelligent caching to improve performance:
  • Seller information is cached for improving performance.

Error Handling

The SDK provides comprehensive error handling:

Browser Support

The SDK supports all modern browsers with ES6+ support:
  • Chrome 60+
  • Firefox 55+
  • Safari 12+
  • Edge 79+