RazorpayX NodeJS SDK
Note: This is not an official sdk.
Official documentation: https://razorpay.com/docs/razorpayx/api/
Repository documenation: https://razorpayx-docs.netlify.app/
Installation
npm install razorpayx-nodejs-sdk
or
yarn add razorpayx-nodejs-sdk
Usage
const { Contact } = require("razorpayx-nodejs-sdk")("key", "secret");
// create new contact
Contact.create({
name: "Demo User",
email: "demo@example.com",
contact: "12131213113"
})
Services
Contact
A Contact is an entity to whom payouts can be made through supported modes such as UPI, IMPS, NEFT and RTGS.
Available Methods
create - Create a contact.
Example:
Contact.create(contactInfo)
update - updates a contact
Example:
Contact.update("contact_id", contactInfo)
You can find contactInfo possibles values here.
getAll - Get all contacts
Example:
Contact.getAll(filterOptions)
You can find filterOptions possibles values here
get - Get contact by contact id
Example:
Contact.get("contact_id")
activate - Activate contact by contact id
Contact.activate("contact_id")
deactivate - Deactivate contact by contact id
Contact.deactivate("contact_id")
FundAccount
Fund accounts are accounts associated with a contact. Payouts are made to fund accounts.
Available Methods
create - Create a fund account.
Example:
FundAccount.create(accountInfo)
You can find accountInfo possibles values here
getAll - Fetches all the fund accounts
FundAccount.getAll(filterOptions)
You can find filterOptions possibles values here
get - Get fund account by account id
Example:
FundAccount.get("account_id")
validate - Validate the account
FundAccount.validate(account)
You can find account possibles values for validating bank here and for validating VPA here
activate - Activate fund account by account id
FundAccount.activate("account_id")
deactivate - Deactivate fund account by account id
FundAccount.deactivate("account_id")
Payout
A payout is the transfer of funds from your business account to a contact's fund account.
Available Methods
create - Create a payout.
Example:
Payout.create(payoutInfo)
You can find payoutInfo possibles values here
getAll - Fetches all the payouts
Payout.getAll(account_number, filterOptions)
account_number: The account from which you want to make the payout.
Account details can be found on the RazorpayX Dashboard. For example, 7878780080316316.
You can find filterOptions possibles values here
get - Fetches details of a payout by payout id
Example:
Payout.get("payout_id")
cancel - Cancels a queued payout.
Note: You can only cancel payouts that are in the queued state. It is not possible to cancel payouts that have any other status.
Payout.cancel("payout_id")
PayoutLink
Payout Links enable you to make payouts to those contacts whose fund accounts details are not readily available with you. You can use these links to collect the customer's fund account details and then process refunds, reimbursement and cashbacks to them without additional follow up.
Available Methods
create - Create a payout link.
Example:
PayoutLink.create(payoutLinkInfo)
You can find payoutLinkInfo possibles values here
getAll - Fetches all the payout links
PayoutLink.getAll(filterOptions)
You can find filterOptions possibles values here
get - Fetches details of a payout link by payout link id
Example:
PayoutLink.get("payout_link_id")
cancel - Cancels a issued payout link.
Note: You can only cancel payout links in the issued state.
PayoutLink.cancel("payout_link_id")
Transactions
The inflow of funds to your business account, payouts to a contact's fund account and reversals are all recorded as transactions against your business account. You can fetch details of a particular transaction or details of all transactions via the below APIs.
Available Methods
getAll - Fetches all the transactions
Transactions.getAll(accountNumber, filterOptions)
account_number: The account from which you want to get the transaction details.
Account details can be found on the RazorpayX Dashboard. For example, 7878780080316316.
You can find filterOptions possibles values here
get - Fetches details of a transaction by transaction id
Example:
Transactions.get("transaction_id")
Issues
If you find any issue please add it to the issues tab.
Missing any important feature? Create an issue here: here
PRs are welcome.