Skip to content
Kordiva Docs

SDK installation

Published release: SDK 0.1.3 is publicly available on npm. Package installation does not activate new backend features.

All active paid Business/Sole Trader plans—Basic, Professional and Enterprise—include API and SDK integration. Individual Creator (free), Pro and approved Scale configurations include API for their own websites and applications, subject to their separate approval and environment rules. Preview does not automatically grant LIVE API access. Individual sales remain approved digital products only, with Kordiva as Full Merchant of Record and its hosted checkout, tax, refund, dispute, reserve and payout controls.

Install with pnpm

Section titled “Install with pnpm”

Publicly available 0.1.3 packages: @kordiva/sdk, @kordiva/checkout, and @kordiva/react.

  1. Use Node 20+ for the server SDK. React requires React 18.2 or 19 in your application.
  2. Install the server client in your backend:
Терминал
pnpm add @kordiva/[email protected]
  1. For React checkout navigation, install:
Терминал
pnpm add @kordiva/[email protected] @kordiva/[email protected]

Use the official public npm registry. No package token, Kordiva subscription or Store API key is needed to download a public package. Remove any old @kordiva:registry override pointing to a private registry. Do not put Store API keys in .npmrc.

Authorize your integration

Section titled “Authorize your integration”

Create a store-specific key in CMS → Settings → API Keys. Set KORDIVA_STORE_ID, the configured KORDIVA_API_ORIGIN and the matching KORDIVA_TEST_API_KEY or KORDIVA_LIVE_API_KEY in protected server configuration. Follow the quickstart.

Public installation grants no API access. Existing backend authentication enforces store ownership, TEST/LIVE separation, revocation and account eligibility. Keep @kordiva/sdk exclusively in Node server routes; React and checkout helpers receive only approved checkout URLs from your backend. Never use NEXT_PUBLIC_ or VITE_ variables for keys.

Verify installation from public npm

Section titled “Verify installation from public npm”

Use a clean project outside the Kordiva repository to verify installation of the public 0.1.3 packages:

Терминал
pnpm add @kordiva/[email protected] @kordiva/[email protected] @kordiva/[email protected]
pnpm list @kordiva/sdk @kordiva/react @kordiva/checkout

React projects also require React 18.2+ or 19; the React package declares it as a peer dependency. All three packages ship ESM and TypeScript declarations; use import, not require. Never put a Store API key in client code. The optional Node webhook verifier is not for browser or Edge environments.

The source monorepo still sets private: true to prevent accidental publication from development; that flag does not mean the public npm release tarballs are private.

Troubleshooting

Section titled “Troubleshooting”
  • npm 404: confirm the exact @kordiva/... name, requested version and public npm registry. Version 0.1.3 is public; confirm registry availability before retrying and do not install an unofficial replacement.
  • 401/403 from Kordiva: verify the Store ID, key environment, revocation status and applicable subscription or Individual approval. Reinstalling the SDK does not change authorization.
  • Browser import fails: move @kordiva/sdk into a protected server route; use @kordiva/react or @kordiva/checkout in the browser.
Section titled “Related guides”

Authentication · Quickstart · React · Security

Business subscriptions · Merchant webhooks · Verification