Home

Installation

Overview

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

Prerequisites

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

Install by package manager

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

  • npm
  • yarn
  • pnpm

Refer to the following commands to install your SDK package:

Card Viewer SDK

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

npm
yarn
pnpm

Checkout SDK

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

npm
yarn
pnpm

Document Upload SDK

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

npm
yarn
pnpm

Risk Application SDK

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

npm
yarn
pnpm

Secure Inputs SDK

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:

npm
yarn
pnpm

Install by CDN

You can install Highnote SDKs directly from a CDN like JSDelivr. We recommend specifying a specific version of the SDK to ensure stability and avoid potential issues caused by updates. You can replace @latest with the desired version number, such as @1.0.0.

Refer to the following <script> tags to install your SDK via CDN:

Card Viewer SDK

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

Script tag for card viewer SDK

Checkout SDK

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

Script tag for checkout SDK

Document Upload SDK

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

Script tag for document upload SDK

Risk Application SDK

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

Script tag for Risk Application SDK

Secure Inputs SDK

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

Script tag for secure inputs SDK

Next steps

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

Provide Feedback

Was this content helpful?