Paystack SDK

This library is based on the official Paystack payment gateway APIs.
This will serve as a Software Development Kit (SDK) for handling payments.

Table of Content

• Paystack SDK
  • Table of Content
  • Technical Info
  • Installation
  • Features
  • Test
  • Conventional Commit and Release Management

Technical Info

Things to note:

• This project was built with Bun runtime.
• Many script commands are executed with Bun.
• Note: You do not have to use Bun to use this library.
• Bun may only be required when working on the library itself and not when using it in your projects.

Installation

This package can be installed with many package managers:

  # deno
  deno add @irabeny/paystack-sdk

  # npm (use any of npx, yarn dlx, pnpm dlx, or bunx)
  npx jsr add @irabeny/paystack-sdk

visit JSR for more info: https://jsr.io/@irabeny/paystack-sdk@latest

Features

Most of Paystack API features are implemented.

These are the currently implemented features:

1. Transactions
2. Transfer Recipients
3. Transfers
4. Plans
5. Subscriptions
6. Verification
7. Miscellaneous

Test

To run tests on the implemented features you need to be connected to the internet. To run tests on implemented features you will require to store your paystack test key as environment variable in PAYSTACK_TEST_PRIVATE_KEY

To run tests, just run the command below:

  # utils tests
  bun run test-utils
  # or features test - require PAYSTACK_TEST_PRIVATE_KEY
  bun run test-feats
  # or all tests - require PAYSTACK_TEST_PRIVATE_KEY
  bun test

Conventional Commit and Release Management

Cocogitto is used on this library project for conventional commit and changesets.