Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/stitchng/paystack

A NodeJS Wrapper for Paystack
https://github.com/stitchng/paystack

api-endpoints nodejs payments paystack rest-api

Last synced: 3 months ago
JSON representation

A NodeJS Wrapper for Paystack

Awesome Lists containing this project

README 

          
# Paystack



[![NPM Version][npm-image]][npm-url]

[![Build Status][travis-image]][travis-url]



A NodeJS Wrapper for [Paystack](https://www.paystack.com)



## Overview

This project provides an easy-to-use object-oriented API to access endpoints delineated at https://developers.paystack.co/reference



## Getting Started



>Install from the NPM Registry



```bash



    $ npm i --save paystack-node



```



# Usage



```js



let PayStack = require('paystack-node')



let APIKEY = 'sk_live_2hWyQ6HW73jS8p1IkXmSWOlE4y9Inhgyd6g5f2R7'

const environment = process.env.NODE_ENV



const paystack = new PayStack(APIKEY, environment)



const feesCalculator = new PayStack.Fees();

const feeCharge = feesCalculator.calculateFor(250000) // 2,500 Naira



/* 

  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 promise_0 = paystack.getSettlements({

  from:new Date("2017-02-09"), 

  to:new Date()

})



promise_0.then(function(response){

  var data = response.body.data;

}).catch(function (error){

  // deal with error

})



// listBanks



try {

  let { body: { status, message, data } } =  await paystack.listBanks({

    currency: 'NGN'

  });



  if(status === false){

    throw new Error(message);

  }

}catch(ex){

  console.error(ex.message);

}



// addPageProduct



const promise1 = paystack.addPageProduct({

  id: '0826739',

  products: [473, 292]

})



promise1.then(function(response){

   // Error Handling

   if(response.body.status === false){

     console.error(response.body.message);

   }

   var data = response.body.data;

}).catch(function (error) {

  // deal with error

})



// 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'

})



promise4.then(function (response){

   const result = response.body

}).catch(function (error){

  // deal with error

})



// createPage



const promise5 = paystack.createPage({

  name:'DoorPost Pay',

  description:'This is payment for every ',

  amount:300000, // Amount in kobo

  slug:'5nApBwZkvR',

  redirect_url:'https://www.localhoster.com/pay/callback',

  custom_fields: ['phone_number', 'age']

})



promise5.then(function (response){

 console.log(response.body);

}).catch(function (error){

  // deal with error

})



// initializeTransaction



const promise6 = paystack.initializeTransaction({

  reference: "7PVGX8MEk85tgeEpVDtD",

  amount: 500000, // 5,000 Naira (remember you have to pass amount in kobo)

  email: "seun045olayinka@gmail.com",

  subaccount: "ACCT_8f4s1eq7ml6rlzj"

})



promise6.then(function (response){

  console.log(response.body);

}).catch(function (error){

  // deal with error

})



// verifyTransaction



const promise7 = paystack.verifyTransaction({

  reference: "7PVGX8MEk85tgeEpVDtD"

})



promise7.then(function (response){

 console.log(response.body);

}).catch(function (error){

  // deal with error

})



// listInvoices



const promise8 = paystack.listInvoices({

  customer: "CUS_je02lbimlqixzax",

  status: "pending",

  paid: false,

  currency: "NGN"

})



promise8.then(function (response){

 console.log(response.body);

}).catch(function (error){

  // deal with error

})



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'

    })



    next()

})



```



### Mocking the Instance (for Unit/Integration Tests)

>Setting up mocks for testing with the paystack instance is now as easy as fliping a switch like so:



```js



let PayStack = require('paystack-node')



let APIKEY = 'sk_live_2hWyQ6HW73jS8p1IkXmSWOlE4y9Inhgyd6g5f2R7'

const environment = process.env.NODE_ENV



const paystack = new PayStack(APIKEY, environment)



// call the real API methods

const { body } = paystack.chargeCard({

  card:{

    number: '5399837841116788', // mastercard

    cvv: '324',

    expiry_year: '2024',

    expiry_month: '08'

  },

  email: 'me.biodunch@xyz.ng',

  amount: 15600000 // 156,000 Naira in kobo

})



// mocking call made on the constructor

// start mocking

PayStack.engageMock()



// call the mock API methods

const { body } = await paystack.chargeBank({

  bank: {

    code: "050", // Eco Bank

    account_number: "0000000000"

  },

  email: 'me.biodunch@xyz.ng',

  amount: 1850000 // 18,500 Naira in kobo

})



// replace mocked methods (! don't use arrow functions !)

PayStack.mockMacro(

  'getCustomers', 

  async function getCustomers (reqPayload = {}) {

    // validation for (reqPayload) is already taken care of!



    // @TODO: optionally, connect to a in-memory db (redis) for mocking purposes



    // return mocked response object

    return { status: 200, body: { status: "success", data: reqPayload } };

})



const { body } = await paystack.getCustomers({

  customer_id:'CUS_e24m6SqA6g3Jk889o21'

})



// stop mocking

// mocking call made on the constructor

PayStack.disengageMock()

```



## API Resources



>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



- customers

  - paystack.createCustomer()

  - paystack.getCustomer()

  - paystack.listCustomer()

  - paystack.updateCustomer()

  - paystack.deactivateAuthOnCustomer()

  - paystack.setRiskActionOnCustomer()

- disputes

  - paystack.listDisputes()

- dedicated nuban

  - paystack.createDedicatedNuban()

  - paystack.listDedicatedNubans()

  - paystack.fetchDedicatedNuban()

  - paystack.deactivateDedicatedNuban()

- invoices

  - paystack.createInvoice()

  - paystack.getMetricsForInvoices()

  - paystack.sendInvoiceNotification()

  - paystack.listInvoice()

  - paystack.updateInvoice()

  - paystack.verifyInvoice()

  - paystack.finalizeInvoiceDraft()

  - paystack.archiveInvoice()

  - paystack.markInvoiceAsPaid()

- settlements

  - paystack.getSettlements()

- payment sessions {control panel}

  - paystack.getPaymentSessionTimeout()

  - paystack.updatePaymentSessionTimeout()

- pages

  - paystack.createPage()

  - paystack.listPages()

  - paystack.getPage()

  - paystack.updatePage()

  - paystack.checkSlugAvailability()

  - paystack.addPageProduct()

- products

  - paystack.createProduct()

  - paystack.listProduct()

  - paystack.getProduct()

  - paystack.updateProduct()

- transactions

  - paystack.initializeTransaction()

  - paystack.chargeAuthorization()

  - paystack.getTransaction()

  - paystack.listTransaction()

  - paystack.viewTransactionTimeline()

  - paystack.transactionTotals()

  - paystack.exportTransaction()

  - paystack.requestReauthorization()

  - paystack.checkAuthorization()

  - paystack.verifyTransaction()

  - paystack.partialDebit()

- plans

  - paystack.createPlan()

  - paystack.getPlan()

  - paystack.listPlan()

  - paystack.updatePlan()

- refunds

  - paystack.createRefund()

  - paystack.getRefund()

  - paystack.listRefund()

- subscriptions

  - paystack.createSubscription()

  - paystack.disableSubscription()

  - paystack.enableSubscription()

  - paystack.getSubscription()

  - paystack.listSubscription()

- subaccounts

  - paystack.createSubaccount()

  - paystack.getSubaccount()

  - paystack.listSubaccount()

  - paystack.updateSubaccount()

- verifications

  - paystack.resolveBVN()

  - paystack.resolveBVNPremium()

  - paystack.matchBVN()

  - paystack.resolveAccountNumber()

  - paystack.resolveCardBin()

  - paystack.resolvePhoneNumber()

- transfers

  - paystack.initiateTransfer()

  - paystack.listTransfers()

  - paystack.fetchTransfer()

  - paystack.finalizeTransfer()

  - paystack.initiateBulkTransfer()

- transfer_recipients

  - paystack.createTransferRecipient()

  - paystack.listTransferRecipients()

  - paystack.updateTransferRecipient()

  - paystack.deleteTransferRecipient()

- charges

  - paystack.chargeCard()

  - paystack.chargeBank()

  - paystack.chargeUssd()

  - paystack.chargeMobileMoney()

  - paystack.submitPIN()

  - paystack.submitOTP()

  - paystack.submitPhone()

  - paystack.submitBirthday()

  - paystack.submitAddress()

  - paystack.checkPendingCharge()

- miscellanous

  - paystack.listBanks()

  - paystack.listProviders()

  - paystack.listCountries()



# License



MIT



# Credits



- [Ifeora Okechukwu](https://twitter.com/isocroft)

- [Ahmad Abdul-Aziz](https://twitter.com/dev_amaz)



# Contributing



See the [CONTRIBUTING.md](https://github.com/stitchng/paystack/blob/master/CONTRIBUTING.md) file for info



[npm-image]: https://img.shields.io/npm/v/paystack-node.svg?style=flat-square

[npm-url]: https://npmjs.org/package/paystack-node



[travis-image]: https://img.shields.io/travis/stitchng/paystack/master.svg?style=flat-square

[travis-url]: https://travis-ci.org/stitchng/paystack



## Support 



**Coolcodes** is a non-profit software foundation (collective) created by **Oparand** - parent company of StitchNG, Synergixe based in Abuja, Nigeria. You'll find an overview of all our work and supported open source projects on our [Facebook Page](https://www.facebook.com/coolcodes/).



>Follow us on facebook if you can to get the latest open source software/freeware news and infomation.



Does your business depend on our open projects? Reach out and support us on [Patreon](https://www.patreon.com/coolcodes/). All pledges will be dedicated to allocating workforce on maintenance and new awesome stuff.