@devtools-bp/nestjs-paystack

nestjs-paystack

The wrapper provides a convenient way to integrate Paystack payment functionality into your NestJS applications.

Installation

npm install @devtools-bp/nestjs-paystack

or

yarn add @devtools-bp/nestjs-paystack

Configuration

To use the nestjs-paystack, you need to provide your Paystack API key. You can obtain the API key from the Paystack dashboard. Once you have the API key, you can configure the wrapper in your NestJS application.

In App Module

import { Module } from '@nestjs/common';

import { NsPaystackModule } from '@devtools-bp/nestjs-paystack';

@Module({
  imports: [
    NsPaystackModule.register({
      secretKey: 'PAYSTACK_SECRET_KEY'
    })
  ]
})
export class AppModule {}

Or use async registration to access environment variables

In App Module

import { Module } from '@nestjs/common';

import { NsPaystackModule } from '@devtools-bp/nestjs-paystack';
import { ConfigService } from '@nestjs/config';

@Module({
  imports: [
    NsPaystackModule.registerAsync({
      useFactory: (configService: ConfigService) => ({
        secretKey: configService.get('PAYSTACK_SECRET_KEY')
      }),
      inject: [ConfigService]
    })
  ]
})
export class AppModule {}

Usage

In Service

import { Injectable } from '@nestjs/common';
import {
  PsTransactionsService,
  PsInitializeTransactionRequestModel,
  PsInitializeTransactionResponseModel
} from '@devtools-bp/nestjs-paystack';

@Injectable()
export class TransactionsService {
  constructor(private readonly psTransactionsService: PsTransactionsService) {}

  initializeTransaction(
    payload: PsInitializeTransactionRequestModel
  ): Promise<PsInitializeTransactionResponseModel> {
    return this.psTransactionsService.initializeTransaction(payload);
  }
}

In Controller

import { Body, Controller, Post } from '@nestjs/common';
import {
  PsInitializeTransactionRequestModel,
  PsInitializeTransactionResponseModel
} from '@devtools-bp/nestjs-paystack';
import { TransactionsService } from '../services/transactions.service';

@Controller('transaction')
export class TransactionController {
  constructor(private readonly transactionsService: TransactionsService) {}

  @Post('initialize')
  initialize(
    @Body() payload: PsInitializeTransactionRequestModel
  ): Promise<PsInitializeTransactionResponseModel> {
    return this.transactionsService.initializeTransaction(payload);
  }
}

API ENDPOINTS

• [x] Transactions ✔
  • [x] Initialize Transaction ✔
  • [x] Verify Transaction ✔
  • [x] List Transaction ✔
  • [x] Fetch Transaction ✔
  • [x] Charge Transaction ✔
  • [x] View Transaction Timeline ✔
  • [x] Transaction Totals ✔
  • [x] Export Transaction ✔
  • [x] Partial Debit ✔
• [x] Transaction Splits ✔
  • [x] Create Split ✔
  • [x] List Split ✔
  • [x] Fetch Split ✔
  • [x] Update Split ✔
  • [x] Add/Update Subaccount Split ✔
  • [x] Remove Subaccount from Split ✔
• [ ] Terminal
• [ ] Customers
• [ ] Dedicated Virtual Accounts
• [ ] Apple Pay
• [ ] Subaccounts
• [ ] Plans
• [ ] Subscriptions
• [ ] Products
• [ ] Payment Pages
• [ ] Payment Requests
• [ ] Settlements
• [ ] Transaction Recipients
• [ ] Transfers ⏳
  • [ ] Initiate Transfer ⏳
  • [ ] Finalize Transfer ⏳
  • [ ] Initiate Bulk Transfer ⏳
  • [ ] List Transfer ⏳
  • [ ] Fetch Transfer ⏳
  • [ ] Verify Transfer ⏳
• [ ] Transfers Control
• [ ] Bulk Charges
• [ ] Integration
• [ ] Charge
• [ ] Disputes
• [ ] Refunds
• [x] Verification ✔
  • [x] Resolve Account Number ✔
  • [x] Validate Account ✔
  • [x] Resolve Card BIN ✔
• [x] Miscellaneous ✔
  • [x] List Banks ✔
  • [x] List Countries ✔
  • [x] List States (AVS) ✔

Contributing

Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request on the GitHub repository. Learn how to contribute to the project.

License

The devtools-bp monorepo is released under the MIT License. Please make sure you understand its terms and conditions when using the libraries and tools provided in this repository.

Authors

• Brian Pooe