ct-razorpayx

Razorpayx Node SDK

Unofficial nodejs library for Razorpayx API

Read up here for getting started and understanding the payout flow with Razorpayx: https://razorpay.com/docs/razorpayx/api/get-started/

Installation

Using npm

npm i ct-razorpayx

Using yarn

yarn add ct-razorpayx

Documentation

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

Basic Usage

Instantiate the razorpayx instance with key_id & key_secret.

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

Note: If you are an existing Razorpay merchant, you can use your existing API key with RazorpayX.

To generate your API Keys:

1. Log into your RazorpayX Dashboard.
2. Navigate to Account Settings → API Keys and Webhooks.
3. Click Generate Key.
4. API Keys are generated for your business account.

The resources can be accessed via the instance. All the methods invocations follows the namespaced signature

// API signature
// {razorpayxInstance}.{resourceName}.{methodName}(resourceId [, params])

// example
instance.contacts.fetch(contactId);

Development

Using npm

npm install

Using yarn

yarn install

Testing

Using npm

npm test

Using yarn

yarn test

Release

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

Licence

MIT Licensed. See LICENSE for more details