devtools-bp/libs/ns-paystack/README.md

ns-paystack

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

Installation

npm install @bp-devtools/ns-paystack

or

yarn add @bp-devtools/ns-paystack

Configuration

To use the ns-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.

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

import { NsPaystackModule } from '@bp-devtools/ns-paystack';
import { ConfigService } from '@nestjs/config';
import { TransactionsService } from './transactions/services/transactions.service';
import { TransactionController } from './transactions/controllers/transaction.controller';

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

Using async registration to access environment variables

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

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

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

Usage

In Service

import { Injectable } from '@nestjs/common';
import {
  PsTransactionsService,
  PsInitializeTransactionRequestModel,
  PsInitializeTransactionResponseModel,
} from '@bp-devtools/ns-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 {
  PsFetchTransactionResponseModel,
  PsInitializeTransactionRequestModel,
  PsInitializeTransactionResponseModel,
} from '@bp-devtools/ns-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

• Transactions ✔
  • Initialize Transaction ✔
  • Verify Transaction ✔
  • List Transaction ✔
  • Fetch Transaction ✔
  • Charge Transaction ✔
  • View Transaction Timeline ✔
  • Transaction Totals ✔
  • Export Transaction ✔
  • Partial Debit ✔
• Transaction Splits
• Terminal
• Customers
• Dedicated Virtual Accounts
• Apple Pay
• Subaccounts
• Plans
• Subscriptions
• Products
• Payment Pages
• Payment Requests
• Settlements
• Transaction Recipients
• Transfers
• Transfers Control
• Bulk Charges
• Integration
• Charge
• Disputes
• Refunds
• Verification
• Miscellaneous

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.

License

The bp-devtools 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.