Nocturnal Pumpkin Maelstrom

    razorpay
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.7 • Public • Published

    Razorpay Node SDK

    npm Build Status

    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)

    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
    // {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


    Development

    npm install

    Testing

    npm test

    Release

    1. Switch to 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 to Github
    5. Create a release on GitHub using the website with more details about the release
    6. Publish to npm with npm publish command

    Licence

    MIT Licensed. See LICENSE.txt for more details

    Install

    npm i razorpay

    DownloadsWeekly Downloads

    11,537

    Version

    2.0.7

    License

    MIT

    Unpacked Size

    51.4 kB

    Total Files

    20

    Last publish

    Collaborators

    • captn3m0
    • pronav
    • razorpay-dev