Git Product home page Git Product logo

razorpay-typescript's Introduction

Razorpay Node SDK

npm

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 (request/request#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).

Installation

Using npm

npm i razorpay-node-typescript

Using yarn

yarn add 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)

const Razorpay = require('razorpay-node-typescript');

const 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

razorpay-typescript's People

Contributors

aseerkt avatar

Stargazers

Mullayam avatar  avatar vikas gupta avatar

Watchers

James Cloos avatar vikas gupta avatar Pop Moore avatar

Forkers

aseerkt

razorpay-typescript's Issues

VS Code Format On Save

I use prettier in vs code.
I am curious whether you are using eslint formatter or prettier for this project.
So I am having trouble formatting files on save causing unnecessary git diffs.
Can you provide your prettier config or commit the .prettierrc file to your repo?.
@vikasg603

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.