Installation & Configuration

The official Node.js SDK for the Felloh payments API. Use it to manage bookings, transactions, payment links, and all other Felloh resources from your server.

- NPM Package

- Github Repository

Installation

The SDK requires Node.js 18 or later.

npm install @felloh-org/node-sdk

Quick Start

import { FellohClient } from '@felloh-org/node-sdk';

const client = new FellohClient({
  publicKey: process.env.FELLOH_PUBLIC_KEY,
  privateKey: process.env.FELLOH_PRIVATE_KEY,
});

// List bookings
const bookings = await client.bookings.list({
  organisation: 'your-org-id',
});
console.log(bookings.data);

Configuration Options

import { FellohClient } from '@felloh-org/node-sdk';

const client = new FellohClient({
  publicKey: 'your-public-key',
  privateKey: 'your-private-key',
  baseUrl: 'https://api.felloh.com',
  timeout: 30000,
  maxRetries: 2,
  tokenRefreshBuffer: 60,
  logger: (entry) => {
    console.log(
      `${entry.method} ${entry.url} → ${entry.statusCode} (${entry.durationMs}ms)`
    );
  },
});

Token Management

The SDK automatically handles JWT token acquisition and refresh. Tokens are cached in memory and proactively refreshed before expiry based on the tokenRefreshBuffer setting. No manual token management is needed.

If a request receives a 401 response, the SDK will automatically refresh the token and retry the request once.

Available Resources

Every resource on the Felloh API is accessible through a property on the client instance.