Skip to main content

​
Installation

VaultSaaS SDK is distributed as an npm package and can be installed using any Node.js package manager.

​
Package managers

Install @vaultsaas/core using your preferred package manager: 
npm install @vaultsaas/core

​
Requirements

​
Node.js version

VaultSaaS SDK requires Node.js 20 or later: 
node --version
# Should output v20.0.0 or higher
Node.js 18 and earlier are not supported. The SDK uses modern JavaScript features that require Node.js 20+.

​
Bun support

The SDK is fully compatible with Bun 1.1+: 
bun --version
# Should output 1.1.0 or higher

​
TypeScript support

VaultSaaS SDK is written in TypeScript and includes full type definitions out of the box. No additional @types packages are needed.

​
TypeScript configuration

For the best experience, use TypeScript 5.0 or later with the following compiler options:
tsconfig.json
{
  "compilerOptions": {
    "target": "ES2022",
    "module": "ES2022",
    "moduleResolution": "bundler",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true
  }
}
TypeScript is optional. You can use VaultSaaS SDK with plain JavaScript, but you’ll miss out on type safety and autocomplete.

​
Module formats

The package exports both ESM and CommonJS formats:
package.json
{
  "type": "module",
  "main": "./dist/index.cjs",
  "module": "./dist/index.js",
  "types": "./dist/index.d.ts"
}

import { VaultClient, StripeAdapter } from '@vaultsaas/core';

​
CommonJS

const { VaultClient, StripeAdapter } = require('@vaultsaas/core');

​
Provider dependencies

VaultSaaS SDK has zero runtime dependencies. All provider adapters are included in the core package:
  • StripeAdapter - Stripe integration
  • DLocalAdapter - dLocal integration
  • PaystackAdapter - Paystack integration
You don’t need to install separate Stripe, dLocal, or Paystack SDKs. VaultSaaS SDK communicates with providers directly via their REST APIs.

​
Verify installation

Verify the installation by importing the SDK:
verify.ts
import { VaultClient, StripeAdapter } from '@vaultsaas/core';

console.log('VaultSaaS SDK installed successfully!');
console.log('VaultClient:', typeof VaultClient);
console.log('StripeAdapter:', typeof StripeAdapter);
Run the verification: 
npx tsx verify.ts
Expected output: 
VaultSaaS SDK installed successfully!
VaultClient: function
StripeAdapter: function

​
Version compatibility

VaultSaaS SDKNode.jsBunTypeScript
0.1.x20+1.1+5.0+
Check the changelog for version-specific updates and breaking changes.

​
Next steps

Quickstart

Create your first payment in under 10 minutes

Configuration

Learn how to configure the VaultClient for your use case

Stripe setup

Configure the Stripe adapter

API Reference

Explore the complete API documentation

Build docs developers (and LLMs) love

Get started for freeTalk to us