VivaWallet Node SDK: TypeScript Payments Integration

Integrate VivaWallet payments, webhooks, ISV, and marketplace features into your Node.js application with this fully typed TypeScript SDK.

The VivaWallet Node SDK is a TypeScript library that lets you interact with the VivaWallet payment platform directly from your Node.js application. It covers everything from creating payment orders and managing transactions to handling webhooks, building ISV integrations, and running multi-seller marketplace platforms — all with full type safety.

Installation

Install the SDK and get your project set up in minutes

Authentication

Configure your API credentials for OAuth and Basic Auth

Payments Guide

Create payment orders and redirect customers to SmartCheckout

Webhooks Guide

Subscribe to events and handle type-safe webhook payloads

Choose Your Client

The SDK exports three client classes, each tailored to a specific integration model.

Vivawallet

Standard merchant client for payments, transactions, wallets, and more

VivaISV

ISV client for managing multiple merchant accounts and POS terminals

Marketplace

Platform client for multi-seller marketplace payments and transfers

Quick Start

1. Install the package

   npm install @nkhind/vivawallet-sdk
   
2. Create a client

   import { Vivawallet } from '@nkhind/vivawallet-sdk';
   
   const vivawallet = new Vivawallet({
     clientId: 'your-smartcheckout-client-id',
     clientSecret: 'your-smartcheckout-client-secret',
     merchantId: 'your-merchant-uuid',
     apikey: 'your-api-key',
   });
   
3. Create a payment order

   const result = await vivawallet.payments.createOrder({
     amount: 1000, // in cents — €10.00
     customerTrns: 'Order #1234',
     email: '[e-mail]',
     fullName: 'John Doe',
     phone: '[phone]',
     requestLang: 'en-GB',
   });
   
   if (!result.success) throw new Error('Failed to create order');
   const { orderCode } = result.data;
   
4. Redirect to SmartCheckout

   import { getSmartCheckout } from '@nkhind/vivawallet-sdk';
   
   const checkoutUrl = getSmartCheckout({
     orderCode: String(orderCode),
   });
   
   // Redirect your user to checkoutUrl
   

Explore the SDK

Vivawallet Client

Full reference for the standard merchant client and all its modules

ISV Client

Reference for the ISV client including connected accounts and POS

Marketplace Client

Reference for the Marketplace client with sellers and transfers

TypeScript Types

All exported TypeScript interfaces and type definitions