razorpay

Razorpay Node SDK

Official nodejs library for Razorpay API.

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

Installation

npm i razorpay

Documentation

Documentation of Razorpay's 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');

var instance = new Razorpay({
  key_id: 'YOUR_KEY_ID',
  key_secret: 'YOUR_KEY_SECRET',
});

Using Access Token

Instantiate the razorpay instance with access_token. The access_token can be obtained only in case if you are a platform partner. For more information, refer page - https://razorpay.com/docs/partners/platform/.

const Razorpay = require('razorpay');

var instance = new Razorpay({
  "oauthToken": "ACCESS_TOKEN"
})

x The resources can be accessed via the instance. All the methods invocations follows 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
  });

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

• Account

• Addon

• Item

• Customer

• Token

• Order

• Payments

• Settlements

• Fund

• Refunds

• Invoice

• Subscriptions

• Payment Links

• Product Configuration

• Smart Collect

• Stakeholder

• Route

• QR Code

• Emandate

• Cards

• Paper NACH

• UPI

• Register Emandate and Charge First Payment Together

• Register NACH and Charge First Payment Together

• Payment Verification

• Webhook

• Dispute

• Document

• oAuthTokenClient

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 in package.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

Changelog

2.9.6 - 2025-02-24

feat: Added support for access token based authentication mechanism

• Added oauth APIs (getAuthURL, getAccessToken, refreshToken, revokeToken)
• Added support for onboarding signature generation
• Doc updated