razorpay-node-typescript

Razorpay Node SDK

Unofficial nodejs library for Razorpay API with typescript support.

Read up here for getting started and understanding the payment flow with Razorpay: https://docs.razorpay.com/docs/getting-started

Why this library?

1. typescript support.
2. Removed legacy callbacks ( If you were using the promise API, then you don't have to change anything at all)
3. Improved code to not require any module inside the function (This was the major reason I opted to create my own library, as requiring module is CPU intensive synchronous task, and requiring it inside the function can block other requests)
4. Added support for payment-links
5. Removed deprecated request and request-promise and shifted to Axios (https://github.com/request/request/issues/3142).
6. Removed the legacy error handling where you have to handle both synchronous as well as promise errors (added the standard RazorpayError class for handling all the errors).
7. Any many more reasons

Installation

npm i razorpay-node-typescript

Documentation

Documentation of Razorpay API and their usage is available at https://docs.razorpay.com

Basic Usage

Instantiate the Razorpay instance with key_id & key_secret. You can obtain the keys from the dashboard app (https://dashboard.razorpay.com/#/app/keys)

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 follow the namespaced signature

// API signature
// {razorpayInstance}.{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
  });

Error Handling

This library comes with the standard way of handling all the errors originated by the Razorpay. The Error object comes with the following keys and value

1. message:
   1. "Missing parameter": If any mandatory key is missing
   2. "API Error": When the Error comes from the API
2. statusCode:
   1. -1: When Missing parameter
   2. HTTP Error code in all other cases
3. error:
   1. This is an object which contains the error message that came from the Razorpay API
   2. In the case of Missing parameter, it will be {message: 'parameter which is missing'}

---

Development

npm install

Testing

npm test

Release

1. Switch to the master branch. Make sure you have the latest changes in the local master
2. Update the CHANGELOG.md & bump the version in package.json
3. Commit
4. Tag the release & push it to Github
5. Create a release on GitHub using the website with more details about the release
6. Publish to npm with the npm publish command

Licence

MIT Licensed. See LICENSE.txt for more details