Installation

All Highnote SDKs following semver and can be installed using the following:

• JavaScript package managers: npm, yarn, and pnpm
• Content Delivery Network (CDN) such as JSDelivr

1. A Highnote account
2. A server-side integration using an API key

Highnote's SDKs support installation using the following JavaScript package managers:

• npm
• yarn
• pnpm

Refer to the following commands to install your SDK package:

To install the Card Viewer SDK, use the command for your preferred package manager:

To install the Checkout SDK, use the command for your preferred package manager:

To install the Document Upload SDK, use the command for your preferred package manager:

To install the Risk Application SDK, use the command for your preferred package manager:

Installation steps are the same for the PIN and tokenization Secure Inputs SDKs.

To install the Secure Inputs for PINs SDK, use the command for your preferred package manager:

Note: To ensure stability and avoid potential issues caused by updates, replace @latest with a specific version number such as @1.0.0.

You can install Highnote SDKs directly from a content delivery network (CDN) such as JSDelivr.

We support both traditional script tags and modern ESM (ECMAScript Modules) imports. ESM imports require modern browsers. To support older browsers, use the traditional script tag approach with appropriate polyfills.

Use the following <script> tags to install your SDK via CDN using the traditional method:

To install the Card Viewer SDK, add the following <script> tag to your HTML file:

To install the Checkout SDK, add the following <script> tag to your HTML file:

To install the Document Upload SDK, add the following <script> tag to your HTML file:

To install the Risk Application SDK, add the following <script> tag to your HTML file:

To install the Secure Inputs SDK, add the following <script> tag to your HTML file:

For modern applications, you can use ESM imports directly with CDN links. This approach provides better tree-shaking, scope isolation, and is the recommended method for modern web applications:

To install the Card Viewer SDK, add the following ESM module to your HTML file:

To install the Checkout SDK, add the following ESM module to your HTML file:

To install the Document Upload SDK, add the following ESM module to your HTML file:

To install the Risk Application SDK, add the following ESM module to your HTML file:

To install the Secure Inputs SDK, add the following ESM module to your HTML file:

After installing your SDK, refer to the following guides for additional information:

• Card Viewer SDK
• Secure Inputs SDK
• Document Upload SDK
• Risk Application SDK