Installation
Learn how to install the M-Pesa SDK for TypeScript and Python.
Installation
Get started with Singularity Payments by installing the appropriate package for your project.
Install the SDK
Pick the package for your language. The language switch in the navigation keeps every code sample on this site in sync with your choice.
npm install @singularity-payments/corePrerequisites
Before installing, make sure you have the toolchain for your language:
- TypeScript: Node.js 18+ and a package manager (npm, pnpm, yarn, bun)
- Python: Python 3.9+ and pip (or uv)
Choose Your Package
Server-Side
For Next.js, SvelteKit, Express.js, Nuxt.js, Elysia, Fastify, Hono backends
Client-Side
For React, Vue.js, Svelte applications
Server-Side
npm install @singularity-payments/nextjspnpm add @singularity-payments/nextjsyarn add @singularity-payments/nextjsbun add @singularity-payments/nextjsnpm install @singularity-payments/sveltekitpnpm add @singularity-payments/sveltekityarn add @singularity-payments/sveltekitbun add @singularity-payments/sveltekitnpm install @singularity-payments/nuxtpnpm add @singularity-payments/nuxtyarn add @singularity-payments/nuxtbun add @singularity-payments/nuxtnpm install @singularity-payments/elysiapnpm add @singularity-payments/elysiayarn add @singularity-payments/elysiabun add @singularity-payments/elysianpm install @singularity-payments/fastifypnpm add @singularity-payments/fastifyyarn add @singularity-payments/fastifybun add @singularity-payments/fastifynpm install @singularity-payments/honopnpm add @singularity-payments/honoyarn add @singularity-payments/honobun add @singularity-payments/honoClient-Side
Security Warning
Client-side packages require a backend server. Never expose M-Pesa credentials in client-side code, these packages are designed to simplify integration with the backend
npm install @singularity-payments/reactpnpm add @singularity-payments/reactyarn add @singularity-payments/reactbun add @singularity-payments/reactnpm install @singularity-payments/vuepnpm add @singularity-payments/vueyarn add @singularity-payments/vuebun add @singularity-payments/vuenpm install @singularity-payments/sveltepnpm add @singularity-payments/svelteyarn add @singularity-payments/sveltebun add @singularity-payments/svelteEnvironment Variables
After installation, set up your environment variables:
MPESA_CONSUMER_KEY=your_consumer_key
MPESA_CONSUMER_SECRET=your_consumer_secret
MPESA_SHORTCODE=your_shortcode #Use 600998 for sandbox
MPESA_PASSKEY=your_passkey # Use bfb279f9aa9bdbcf158e97dd71a467cd2e0c893059b10f78e6b72ada1ed2c919
MPESA_ENVIRONMENT=sandbox # or 'production'Never commit your .env file to version control. Add it to .gitignore.