ewdave/paystack

Nodejs API wrapper for Paystack

paystack

A Nodejs API wrapper for Paystack.

Installation

npm install paystack

Usage

// Require the library
var paystack = require('paystack')('secret_key');

// Make a call to the resource/method
// paystack.{resource}.{method}
paystack.customer.list(function(error, body) {
  console.log(error);
  console.log(body);
});

The resource method accepts an optional callback as the last argument. The callback returns two JSON objects - error, which will be null for successful calls, and body, the response from the API call.

For resource methods that use POST or PUT, the JSON body can be passed as the first argument.

paystack.plan.create({
  name: 'API demo',
  amount: 10000,
  interval: 'monthly'
},function(error, body) {
  console.log(error);
  console.log(body);
});

For GET, you can pass the required ID as string and optional parameters as an optioal object argument.

paystack.plan.get(90, function(error, body) {
  console.log(error);
  console.log(body);
});

paystack.transactions.list({
  perPage: 20
}, function(error, body) {
  console.log(error);
  console.log(body);
});

Resources

• customer
  • create
  • get
  • list
  • update
• transaction
  • initialize
  • charge
  • get
  • list
  • totals
  • verify
• plan
  • create
  • get
  • list
  • update
• page
  • create
  • get
  • list
  • update
• subscription
  • create
  • disable
  • enable
  • get
  • list
• subaccount
  • create
  • get
  • list
  • listBanks
  • update

Contributing

• To ensure consistent code style, please follow the editorconfig rules in .editorconfig

Tests

To run tests, add your Paystack test secret key to package.json. (The test line should look something like this: env KEY=sk_test_1a68ac96a0171fb72111a24295d8d31d41c28eed ./node_modules/.bin/mocha...). Now run:

npm test

If you are contributing to the repo, kindly update the necessary test file in /test or add a new one and ensure all tests are passed before sending a PR.

Todo

• Proper resource examples
• ES6 support