Skip to content

README.md

Latest commit

 

History

History
50 lines (37 loc) · 1.56 KB

README.md

File metadata and controls

50 lines (37 loc) · 1.56 KB
Raw

Paystack SDK

npm version TypeScript License

Modern TypeScript SDK for the Paystack payments API. Full type safety, Promise-based, covers 18+ API modules — transactions, transfers, customers, subscriptions, settlements, and more.

Built because existing Paystack libraries were untyped, abandoned, or lagging behind the API. This is the one you install when you need reliability in production.

Quick Start

npm install paystack-sdk
# or
yarn add paystack-sdk
import Paystack from 'paystack-sdk';

const paystack = new Paystack('sk_live_...');

// Charge a card
const charge = await paystack.charge.initialize({
  email: 'customer@example.com',
  amount: 500000, // NGN 5,000
});

// Verify a transaction
const tx = await paystack.transaction.verify('tx_ref_abc123');

Supported Modules

Module Status Module Status
Transactions ✅ Transfers ✅
Customers ✅ Transfer Recipients ✅
Plans ✅ Subaccounts ✅
Subscriptions ✅ Transaction Splits ✅
Charge ✅ Settlements ✅
Refunds ✅ Invoices ✅
Verification ✅ Bulk Charges ✅
Apple Pay ✅ Dedicated Virtual Accounts ✅
Miscellaneous ✅ Transfers Control ✅

License

MIT