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/
Using npm
npm i ct-razorpayxUsing yarn
yarn add ct-razorpayxDocumentation of Razorpay's API and their usage is available at https://razorpay.com/docs/razorpayx/api/
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:
- Log into your RazorpayX Dashboard.
- Navigate to Account Settings → API Keys and Webhooks.
- Click Generate Key.
- 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);Using npm
npm installUsing yarn
yarn installUsing npm
npm testUsing yarn
yarn test- Switch to the
mainbranch. Make sure you have the latest changes in the local main - Update the
CHANGELOG.md& bump the version inpackage.json - Commit & push it to Github
- Create a tag & release on GitHub using the website with more details about the release
MIT Licensed. See LICENSE for more details