Paystack TypeScript SDK

A type-safe, platform-agnostic SDK for the Paystack API. Built with modern TypeScript and Zod for runtime validation.

            {`import { Paystack } from '@efobi/paystack';

                        const paystack = new Paystack(
                        'sk_test_your_secret_key'
                        );

                        const transaction = 
                        await paystack.transaction.initialize({
                          email: 'customer@email.com',
                          amount: 50000 // ₦500.00
                        });`}

Quick start

Get up and running with Paystack in minutes

Install the package using your preferred package manager: ```bash npm theme={null} npm install @efobi/paystack ``` ```bash yarn theme={null} yarn add @efobi/paystack ``` ```bash pnpm theme={null} pnpm add @efobi/paystack ``` ```bash bun theme={null} bun add @efobi/paystack ``` Create a new Paystack instance with your secret key: ```typescript theme={null} import { Paystack } from '@efobi/paystack'; const paystack = new Paystack(process.env.PAYSTACK_SECRET_KEY); ``` Get your secret key from the [Paystack Dashboard](https://dashboard.paystack.com/#/settings/developer). Use `sk_test_*` for testing and `sk_live_*` for production. Create your first payment transaction: ```typescript theme={null} const result = await paystack.transaction.initialize({ email: 'customer@example.com', amount: 50000, // Amount in kobo (₦500.00) currency: 'NGN' }); if (result.data) { console.log('Payment URL:', result.data.data.authorization_url); // Redirect customer to result.data.data.authorization_url } ``` The SDK returns a type-safe result object. Check for `result.data` for success or `result.error` for validation errors.

Key features

Everything you need for payment integration

Full TypeScript support with strict typing and IntelliSense Works in Node.js, Bun, browsers, and edge runtimes Input/output validation using Zod schemas for data integrity Built-in webhook verification and event listeners Transactions, transfers, virtual accounts, and more Clean, promise-based API with async/await support

Explore by topic

Deep dive into specific payment workflows

Initialize, verify, and manage payment transactions Send money to bank accounts and manage recipients Create dedicated virtual accounts for customers Verify account numbers and resolve card BINs Handle real-time payment events securely Secure your API keys and handle authorization

Ready to get started?

Follow our quickstart guide to integrate Paystack payments into your application in minutes.

Start building