paystack-node
Advanced tools
A NodeJS Wrapper for Paystack
This project provides an easy-to-use object-oriented API to access endpoints delineated at https://developers.paystack.co/reference
Install from the NPM Registry
$ npm i --save paystack-node
let PayStack = require('paystack-node')
let APIKEY = 'sk_test_2hWyQ6HW73jS8p1IkXmSWOlE4y9Inhgyd6g5f2R7'
const environment = process.env.NODE_ENV
const paystack = new PayStack(APIKEY, environment)
/*
NOTE: All fields/params that require dates should be set to
instances of the `Date()` constructor as they will
eventually be turned into the ISO 8601 format (String)
using `toJSON()` method for date instances/objects
*/
const promise1 = paystack.getSettlements({
from:new Date("2017-02-09"),
to:new Date()
})
promise1.then(function(response){
var data = response.body
})
// getCustomer
const promise2 = paystack.getCustomer({
customer_id:'CUS_e24m6SqA6g3Jk889o21'
})
promise2.then(function(response){
var data = response.body
}).catch(function(error){
// deal with error
})
// createCustomer
const promise3 = paystack.createCustomer({
email:'malik.onyemah@gmail.com',
first_name:'Malik',
last_name:'Onyemah',
phone:'+2347135548369'
})
promise3.then(function(response){
return response.body
}).then( body => {
return res.status(200).json({id:body.data.id})
})
// setRiskActionOnCustomer
const promise4 = paystack.setRiskActionOnCustomer({
risk_action:'deny',
customer_id:'CUS_e24m6SqA6g3Jk889o21'
}).then(function(response){
const result = response.body
})
// createPage
const promise5 = paystack.createPage({
name:'DoorPost Pay',
description:'This is payment for every ',
amount:30000,
slug:'5nApBwZkvR',
redirect_url:'https://www.localhost.com/pay/callback',
custom_fields: ['phone', 'age']
})
app.use(async function verifications(req, res, next){
let responseBVN = await paystack.resolveBVN({
bvn:req.body.bvn //'22283643840404'
})
let responseAcctNum = await paystack.resolveAccountNumber({
account_number:req.body.acc_num, // '0004644649'
bank_code:req.body.bank_code // '075'
})
await next()
})
Each method expects an object literal with both route parameters and request parameters (query / body). Please, go through the src/endpoints folder to see the specific items that should make up the object literal for each method
MIT
See the CONTRIBUTING.md file for info
0.2.0 (2019-04-14)
<a name="0.1.0"></a>
FAQs
A NodeJS wrapper for the Paystack API
The npm package paystack-node receives a total of 395 weekly downloads. As such, paystack-node popularity was classified as not popular.
We found that paystack-node demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
New research reveals that LLMs often fake understanding, passing benchmarks but failing to apply concepts or stay internally consistent.
Security News
Django has updated its security policies to reject AI-generated vulnerability reports that include fabricated or unverifiable content.
Security News
ECMAScript 2025 introduces Iterator Helpers, Set methods, JSON modules, and more in its latest spec update approved by Ecma in June 2025.