Node-sdk Documentation

README.md

@@ -74,29 +74,44 @@ instance.payments.all(
 
 ## Supported Resources
 
-- [Payments](https://github.com/razorpay/razorpay-node/wiki#payments)
+## Supported Resources
+- [Addon](documents/addon.md)
+
+- [Customer](documents/customer.md)
+
+- [Token](documents/token.md)
+
+- [Order](documents/order.md)
+
+- [Payments](documents/payment.md)
+
+- [Settlements](documents/settlement.md)
+
+- [Refunds](documents/refund.md)
+
+- [Invoice](documents/invoice.md)
 
-- [Refunds](https://github.com/razorpay/razorpay-node/wiki#refunds)
+- [Subscriptions](documents/subscription.md)
 
-- [Orders](https://github.com/razorpay/razorpay-node/wiki#orders)
+- [Payment Links](documents/paymentLink.md)
 
-- [Customers](https://github.com/razorpay/razorpay-node/wiki#customers)
+- [Smart Collect](documents/virtualAccount.md)
 
-- [Transfers](https://github.com/razorpay/razorpay-node/wiki#transfers)
+- [Route](documents/transfer.md)
 
-- [Virtual Accounts](https://github.com/razorpay/razorpay-node/wiki#virtual-accounts)
+- [QR Code](documents/qrcode.md)
 
-- [Invoices](https://github.com/razorpay/razorpay-node/wiki#invoices)
+- [Emandate](documents/emandate.md)
 
-- [Plans](https://github.com/razorpay/razorpay-node/wiki#plans)
+- [Cards](documents/card.md)
 
-- [Subscriptions](https://github.com/razorpay/razorpay-node/wiki#subscriptions)
+- [Paper NACH](documents/papernach.md)
 
-- [Addons](https://github.com/razorpay/razorpay-node/wiki#addons)
+- [UPI](documents/upi.md)
 
-- [Webhooks](https://github.com/razorpay/razorpay-node/wiki#webhooks)
+- [Register Emandate and Charge First Payment Together](documents/registerEmandate.md)
 
-- [Partner Auth](https://github.com/razorpay/razorpay-node/wiki#partner-auth)
+- [Register NACH and Charge First Payment Together](documents/registerNach.md)
 
 ---
 

dist/resources/paymentLink.js

@@ -20,7 +20,7 @@ module.exports = function paymentLinkApi(api) {
       MISSING_ID_ERROR = "Payment Link ID is mandatory";
 
   return {
-    create: function() {
+    create: function create() {
       var params = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
       var callback = arguments[1];
 
@@ -45,7 +45,7 @@ module.exports = function paymentLinkApi(api) {
         data: data
       }, callback, true);
     },
-    cancel: function(paymentLinkId, callback) {
+    cancel: function cancel(paymentLinkId, callback) {
 
       /*
        * Cancels issued paymentLink
@@ -61,13 +61,13 @@ module.exports = function paymentLinkApi(api) {
         return Promise.reject(MISSING_ID_ERROR);
       }
 
-      var url = `${BASE_URL}/${paymentLinkId}/cancel`;
+      var url = BASE_URL + "/" + paymentLinkId + "/cancel";
 
       return api.post({
         url: url
       }, callback);
     },
-    fetch: function(paymentLinkId, callback) {
+    fetch: function fetch(paymentLinkId, callback) {
 
       /*
        * Fetches paymentLink entity with given id
@@ -83,13 +83,13 @@ module.exports = function paymentLinkApi(api) {
         return Promise.reject(MISSING_ID_ERROR);
       }
 
-      var url = `${BASE_URL}/${paymentLinkId}`;
+      var url = BASE_URL + "/" + paymentLinkId;
 
       return api.get({
         url: url
       }, callback);
     },
-    all: function() {
+    all: function all() {
       var params = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
       var callback = arguments[1];
 

documents/addon.md

@@ -0,0 +1,174 @@
+## Addons
+
+### Create an addon
+
+```js
+instance.subscriptions.createAddon('sub_I55auG9GnbsR8u',{
+  item:{
+    name:"Extra appala (papadum)",
+    amount:30000,
+    currency:"INR",
+    description:"1 extra oil fried appala with meals"
+  },
+  quantity:2
+})
+```
+
+**Parameters:**
+
+| Name  | Type      | Description                                      |
+|-------|-----------|--------------------------------------------------|
+| subscriptionId*  | boolean | The subscription ID to which the add-on is being added. |
+| items*  | object | Details of the add-on you want to create. |
+| quantity*  | integer | This specifies the number of units of the add-on to be charged to the customer. |
+
+**Response:**
+```json
+{
+  "id":"ao_00000000000001",
+  "entity":"addon",
+  "item":{
+    "id":"item_00000000000001",
+    "active":true,
+    "name":"Extra appala (papadum)",
+    "description":"1 extra oil fried appala with meals",
+    "amount":30000,
+    "unit_amount":30000,
+    "currency":"INR",
+    "type":"addon",
+    "unit":null,
+    "tax_inclusive":false,
+    "hsn_code":null,
+    "sac_code":null,
+    "tax_rate":null,
+    "tax_id":null,
+    "tax_group_id":null,
+    "created_at":1581597318,
+    "updated_at":1581597318
+  },
+  "quantity":2,
+  "created_at":1581597318,
+  "subscription_id":"sub_00000000000001",
+  "invoice_id":null
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+### Fetch all addons
+
+```js
+instance.addons.all(options)
+```
+
+**Parameters:**
+
+| Name  | Type      | Description                                      |
+|-------|-----------|--------------------------------------------------|
+| from  | timestamp | timestamp after which the payments were created  |
+| to    | timestamp | timestamp before which the payments were created |
+| count | integer   | number of payments to fetch (default: 10)        |
+| skip  | integer   | number of payments to be skipped (default: 0)    |
+
+**Response:**
+```json
+{
+  "entity": "collection",
+  "count": 1,
+  "items": [
+    {
+      "id": "ao_00000000000002",
+      "entity": "addon",
+      "item": {
+        "id": "item_00000000000002",
+        "active": true,
+        "name": "Extra sweet",
+        "description": "1 extra sweet of the day with meals",
+        "amount": 90000,
+        "unit_amount": 90000,
+        "currency": "INR",
+        "type": "addon",
+        "unit": null,
+        "tax_inclusive": false,
+        "hsn_code": null,
+        "sac_code": null,
+        "tax_rate": null,
+        "tax_id": null,
+        "tax_group_id": null,
+        "created_at": 1581597318,
+        "updated_at": 1581597318
+      },
+      "quantity": 1,
+      "created_at": 1581597318,
+      "subscription_id": "sub_00000000000001",
+      "invoice_id": "inv_00000000000001"
+    }
+  ]
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+### Fetch an addon
+
+```js
+instance.addons.fetch(addonId)
+```
+
+**Parameters:**
+
+| Name            | Type    | Description                                                                  |
+|-----------------|---------|------------------------------------------------------------------------------|
+| addonId*          | string | addon id to be fetched                                               |
+**Response:**
+```json
+{
+  "id":"ao_00000000000001",
+  "entity":"addon",
+  "item":{
+    "id":"item_00000000000001",
+    "active":true,
+    "name":"Extra appala (papadum)",
+    "description":"1 extra oil fried appala with meals",
+    "amount":30000,
+    "unit_amount":30000,
+    "currency":"INR",
+    "type":"addon",
+    "unit":null,
+    "tax_inclusive":false,
+    "hsn_code":null,
+    "sac_code":null,
+    "tax_rate":null,
+    "tax_id":null,
+    "tax_group_id":null,
+    "created_at":1581597318,
+    "updated_at":1581597318
+  },
+  "quantity":2,
+  "created_at":1581597318,
+  "subscription_id":"sub_00000000000001",
+  "invoice_id":null
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+### Delete an addon
+
+```js
+instance.addons.delete(addonId)
+```
+
+**Parameters:**
+
+| Name            | Type    | Description                                                                  |
+|-----------------|---------|------------------------------------------------------------------------------|
+| addonId*          | string | addon id to be deleted |
+
+**Response:**
+```json
+[]
+```
+-------------------------------------------------------------------------------------------------------
+
+**PN: * indicates mandatory fields**
+<br>
+<br>
+**For reference click [here](https://razorpay.com/docs/api/subscriptions/#add-ons)**