Node.js SDK

The official Simiz Node.js SDK provides a typed, promise-based client for the Simiz API. Built with TypeScript, it works seamlessly in Node.js and serverless environments.
Package: @simiz/node-sdk · Version: 1.0.0 · npm

Installation

Install and initialize the Simiz Node.js SDK:
npm install @simiz/node-sdk
import { Simiz } from '@simiz/node-sdk';

const simiz = new Simiz(process.env.SIMIZ_SECRET_KEY);

Configuration options

import { Simiz } from '@simiz/node-sdk';

const simiz = new Simiz(process.env.SIMIZ_SECRET_KEY, {
  apiVersion: '2024-01',   // API version
  timeout: 30000,          // Request timeout (ms)
  maxRetries: 3,           // Automatic retry count
});
OptionTypeDefaultDescription
apiVersionstring'2024-01'API version to use
timeoutnumber30000Request timeout in milliseconds
maxRetriesnumber3Number of automatic retries on 5xx errors

Quick example

// Create a payment
const transaction = await simiz.transactions.create({
  amount: 5000,
  currency: 'XAF',
  payment_method: 'ORANGE_MONEY',
  payer: {
    phone: '237690000000',
    name: 'John Doe',
  },
  description: 'Order #12345',
  callback_url: 'https://your-site.com/webhooks/simiz',
});

console.log(transaction.id);     // tx_xxx
console.log(transaction.status); // PENDING

TypeScript support

The SDK is fully typed. All methods, parameters, and responses have TypeScript definitions:
import {
  Simiz,
  Transaction,
  TransactionCreateParams
} from '@simiz/node-sdk';

const params: TransactionCreateParams = {
  amount: 5000,
  currency: 'XAF',
  payment_method: 'ORANGE_MONEY',
  payer: { phone: '237690000000' },
};

const transaction: Transaction = await simiz.transactions.create(params);

Available resources

ResourceMethods
simiz.transactionscreate, retrieve, list, cancel
simiz.refundscreate, retrieve, list
simiz.subscriptionscreate, retrieve, list, update, cancel
simiz.planscreate, retrieve, list, update, delete
simiz.payoutscreate, retrieve, list
simiz.paymentLinkscreate, retrieve, list, disable
simiz.webhooksconstructEvent

Next steps

Payments

Create, retrieve, list, and cancel payments.

Webhooks

Verify signatures and handle webhook events.

Changelog

Version history

VersionDateChanges
1.0.02026-02-27Initial pre-release — transactions, refunds, customers, webhook utilities, TypeScript