@zitterorg/illum-quidem
v1.1.22
Published
[![npm](https://img.shields.io/npm/v/@zitterorg/illum-quidem.svg?maxAge=2592000?style=flat-square)](https://www.npmjs.com/package/@zitterorg/illum-quidem)
Downloads
977
Maintainers
Keywords
Readme
Razorpay Node SDK
Official nodejs library for Razorpay API.
Read up here for getting started and understanding the payment flow with Razorpay: https://docs.@zitterorg/illum-quidem.com/docs/getting-started
Installation
npm i @zitterorg/illum-quidem
Documentation
Documentation of Razorpay's API and their usage is available at https://docs.@zitterorg/illum-quidem.com
Basic Usage
Instantiate the @zitterorg/illum-quidem instance with key_id
& key_secret
. You can obtain the keys from the dashboard app (https://dashboard.@zitterorg/illum-quidem.com/#/app/keys)
const Razorpay = require('@zitterorg/illum-quidem');
var instance = new Razorpay({
key_id: 'YOUR_KEY_ID',
key_secret: 'YOUR_KEY_SECRET',
});
The resources can be accessed via the instance. All the methods invocations follows the namespaced signature
// API signature
// {@zitterorg/illum-quidemInstance}.{resourceName}.{methodName}(resourceId [, params])
// example
instance.payments.fetch(paymentId);
Every resource method returns a promise.
instance.payments
.all({
from: '2016-08-01',
to: '2016-08-20',
})
.then(response => {
// handle success
})
.catch(error => {
// handle error
});
If you want to use callbacks instead of promises, every resource method will accept a callback function as a last parameter. The callback functions will behave as Error First Callbacks
instance.payments.all(
{
from: '2016-08-01',
to: '2016-08-20',
},
(error, response) => {
if (error) {
// handle error
} else {
// handle success
}
}
);
Supported Resources
Development
npm install
Testing
npm test
Release
- Switch to
master
branch. Make sure you have the latest changes in the local master - Update the
CHANGELOG.md
& bump the version inpackage.json
- Commit
- Tag the release & push to Github
- Create a release on GitHub using the website with more details about the release
- Publish to npm with
npm publish
command
Licence
MIT Licensed. See LICENSE.txt for more details