razorruby 3.0.1

data/documents/fund.md

@@ -0,0 +1,89 @@
+## Funds
+
+```rb
+require "razorpay"
+Razorpay.setup('key_id', 'key_secret')
+```
+
+### Create a fund account
+```rb
+para_attr = {
+  "customer_id": "cust_Aa000000000001",
+  "account_type": "bank_account",
+  "bank_account":{
+    "name": "Gaurav Kumar",
+    "account_number": "11214311215411",
+    "ifsc": "HDFC0000053"
+  }
+}
+
+Razorpay::FundAccount.create(para_attr)
+```
+
+**Parameters:**
+
+| Name          | Type        | Description                                 |
+|---------------|-------------|---------------------------------------------|
+| customerId*   | string      | The id of the customer to be fetched  |
+| account_type* | string      | The bank_account to be linked to the customer ID  |
+| bank_account* | object      | A key-value pair  |
+
+**Response:**
+```json
+{
+  "id": "fa_JcXaLomo4ck5IY",
+  "entity": "fund_account",
+  "customer_id": "cust_JZse2vlC5nK9AQ",
+  "account_type": "bank_account",
+  "bank_account": {
+      "ifsc": "HDFC0000053",
+      "bank_name": "HDFC Bank",
+      "name": "Gaurav Kumar",
+      "notes": [],
+      "account_number": "11214311215411"
+  },
+  "batch_id": null,
+  "active": true,
+  "created_at": 1654154246
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+### Fetch all fund accounts
+
+```rb
+para_attr = {
+    "customer_id": "cust_I3FToKbnExwDLu"
+}
+Razorpay::FundAccount.all(para_attr)
+```
+
+**Parameters:**
+
+| Name          | Type        | Description                                 |
+|---------------|-------------|---------------------------------------------|
+| customerId*   | string      | The id of the customer to be fetched  |
+
+**Response:**
+```json
+{
+  "id":"fa_Aa00000000001",
+  "entity":"fund_account",
+  "customer_id":"cust_Aa000000000001",
+  "account_type":"bank_account",
+  "bank_account":{
+    "name":"Gaurav Kumar",
+    "account_number":"11214311215411",
+    "ifsc":"HDFC0000053",
+    "bank_name":"HDFC Bank"
+  },
+  "active":true,
+  "created_at":1543650891
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+**PN: * indicates mandatory fields**
+<br>
+<br>
+**For reference click [here](https://razorpay.com/docs/payments/customers/customer-fund-account-api/)**

data/documents/items.md

@@ -0,0 +1,208 @@
+## items
+
+```rb
+require "razorpay"
+Razorpay.setup('key_id', 'key_secret')
+```
+
+### Create item
+
+```rb
+Razorpay::Item.create({
+  "name": "Book / English August",
+  "description": "An indian story, Booker prize winner.",
+  "amount": 20000,
+  "currency": "INR"
+});
+```
+
+**Parameters:**
+
+| Name            | Type    | Description                                                                  |
+|-----------------|---------|------------------------------------------------------------------------------|
+| name*          | string | Name of the item.                    |
+| description        | string  | A brief description of the item.  |
+| amount         | integer  | Amount of the order to be paid     |
+| currency*           | string  | Currency of the order. Currently only `INR` is supported.    |
+
+**Response:**
+```json
+{
+  "id": "item_Jf5MlwKlPMOKBV",
+  "active": true,
+  "name": "Book / English August",
+  "description": "An indian story, Booker prize winner.",
+  "amount": 20000,
+  "unit_amount": 20000,
+  "currency": "INR",
+  "type": "invoice",
+  "unit": null,
+  "tax_inclusive": false,
+  "hsn_code": null,
+  "sac_code": null,
+  "tax_rate": null,
+  "tax_id": null,
+  "tax_group_id": null,
+  "created_at": 1654709890
+}
+```
+
+-------------------------------------------------------------------------------------------------------
+
+### Fetch all items
+
+```rb
+options = {"count":1}
+
+Razorpay::Item.all(options)
+```
+**Parameters:**
+
+| Name  | Type      | Description                                      |
+|-------|-----------|--------------------------------------------------|
+| from  | timestamp | timestamp after which the item were created  |
+| to    | timestamp | timestamp before which the item were created |
+| count | integer   | number of item to fetch (default: 10)        |
+| skip  | integer   | number of item to be skipped (default: 0)    |
+| name        | string | Name of the item.                    |
+| description        | string  | A brief description of the item.  |
+| amount         | integer  | Amount of the order to be paid     |
+| currency           | string  | Currency of the order. Currently only `INR` is supported.    |
+| active   | boolean  | Possible values is `0` or `1` |
+
+**Response:**
+```json
+{
+    "entity": "collection",
+    "count": 1,
+    "items": [
+        {
+            "id": "item_JnjKnSWxjILdWu",
+            "active": true,
+            "name": "Book / English August",
+            "description": "An indian story, Booker prize winner.",
+            "amount": 20000,
+            "unit_amount": 20000,
+            "currency": "INR",
+            "type": "invoice",
+            "unit": null,
+            "tax_inclusive": false,
+            "hsn_code": null,
+            "sac_code": null,
+            "tax_rate": null,
+            "tax_id": null,
+            "tax_group_id": null,
+            "created_at": 1656597363
+        }
+    ]
+}
+```
+-------------------------------------------------------------------------------------------------------
+### Fetch particular item
+
+```rb
+itemId = "item_7Oxp4hmm6T4SCn"
+
+Razorpay::Item.fetch(itemId)
+```
+**Parameters**
+
+| Name     | Type   | Description                         |
+|----------|--------|-------------------------------------|
+| itemId* | string | The id of the item to be fetched |
+
+**Response:**
+```json
+{
+    "id": "item_JnjKnSWxjILdWu",
+    "active": true,
+    "name": "Book / English August",
+    "description": "An indian story, Booker prize winner.",
+    "amount": 20000,
+    "unit_amount": 20000,
+    "currency": "INR",
+    "type": "invoice",
+    "unit": null,
+    "tax_inclusive": false,
+    "hsn_code": null,
+    "sac_code": null,
+    "tax_rate": null,
+    "tax_id": null,
+    "tax_group_id": null,
+    "created_at": 1656597363
+}
+```
+
+-------------------------------------------------------------------------------------------------------
+
+### Update item
+
+```rb
+itemId = "item_JDcbIdX9xojCje"
+
+para_attr = {
+  "name": "Book / Ignited Minds - Updated name!",
+  "description": "New descirption too. :).",
+  "amount": 20000,
+  "currency": "INR",
+  "active": true
+}
+
+Razorpay::Item.edit(itemId,para_attr)
+```
+**Parameters**
+
+| Name     | Type   | Description                         |
+|----------|--------|-------------------------------------|
+| itemId* | string | The id of the item to be fetched |
+| name       | string | Name of the item.                    |
+| description  | string  | A brief description of the item.  |
+| amount         | integer  | Amount of the order to be paid     |
+| currency           | string  | Currency of the order. Currently only `INR` is supported.    |
+| active   | boolean  | Possible values is `0` or `1` |
+
+**Response:**
+```json
+{
+  "id": "item_JInaSLODeDUQiQ",
+  "active": true,
+  "name": "Book / Ignited Minds - Updated name!",
+  "description": "New descirption too.",
+  "amount": 20000,
+  "unit_amount": 20000,
+  "currency": "INR",
+  "type": "invoice",
+  "unit": null,
+  "tax_inclusive": false,
+  "hsn_code": null,
+  "sac_code": null,
+  "tax_rate": null,
+  "tax_id": null,
+  "tax_group_id": null,
+  "created_at": 1649843796
+}
+```
+-------------------------------------------------------------------------------------------------------
+### Delete item
+
+```rb
+itemId = "item_Jc7wDjjQ4x305A"
+
+Razorpay::Item.delete(itemId)
+```
+**Parameters**
+
+| Name     | Type   | Description                         |
+|----------|--------|-------------------------------------|
+| itemId* | string | The id of the item to be fetched |
+
+**Response:**
+```json
+[]
+```
+-------------------------------------------------------------------------------------------------------
+
+**PN: * indicates mandatory fields**
+<br>
+<br>
+**For reference click [here](https://razorpay.com/docs/api/items)**

data/documents/order.md

@@ -0,0 +1,281 @@
+## Orders
+
+```rb
+require "razorpay"
+Razorpay.setup('key_id', 'key_secret')
+```
+
+### Create order
+
+```rb
+
+para_attr = {
+  "amount": 50000,
+  "currency": "INR",
+  "receipt": "receipt#1",
+  "notes": {
+    "key1": "value3",
+    "key2": "value2"
+  }
+}
+
+Razorpay::Order.create(para_attr)
+```
+
+**Parameters:**
+
+| Name            | Type    | Description                                                                  |
+|-----------------|---------|------------------------------------------------------------------------------|
+| amount*          | integer | Amount of the order to be paid                                               |
+| currency*        | string  | Currency of the order. Currently only `INR` is supported.                      |
+| receipt         | string  | Your system order reference id.                                              |
+| notes           | object  | A key-value pair                                                             |
+
+**Response:**
+
+```json
+{
+  "id": "order_EKwxwAgItmmXdp",
+  "entity": "order",
+  "amount": 50000,
+  "amount_paid": 0,
+  "amount_due": 50000,
+  "currency": "INR",
+  "receipt": "receipt#1",
+  "offer_id": null,
+  "status": "created",
+  "attempts": 0,
+  "notes": [],
+  "created_at": 1582628071
+}
+```
+
+-------------------------------------------------------------------------------------------------------
+
+### Create order (Third party validation)
+
+```rb
+para_attr = {
+  "amount": 500,
+  "method": "netbanking",
+  "receipt": "BILL13375649",
+  "currency": "INR",
+  "bank_account": {
+    "account_number": "765432123456789",
+    "name": "Gaurav Kumar",
+    "ifsc": "HDFC0000053"
+  }
+}  
+
+Razorpay::Order.create(para_attr)
+```
+
+**Parameters:**
+
+| Name            | Type    | Description                                                                  |
+|-----------------|---------|------------------------------------------------------------------------------|
+| amount*          | integer | Amount of the order to be paid                                               |
+| method        | string  | The payment method used to make the payment. If this parameter is not passed, customers will be able to make payments using both netbanking and UPI payment methods. Possible values is `netbanking` or `upi`|
+| currency*        | string  | Currency of the order. Currently only `INR` is supported.       |
+| receipt         | string  | Your system order reference id.                                              |
+|bank_account | array  | All keys listed [here](https://razorpay.com/docs/payments/third-party-validation/#step-2-create-an-order) are supported |
+| notes           | object  | A key-value pair    |
+
+**Response:**
+
+```json
+{
+  "id": "order_GAWN9beXgaqRyO",
+  "entity": "order",
+  "amount": 500,
+  "amount_paid": 0,
+  "amount_due": 500,
+  "currency": "INR",
+  "receipt": "BILL13375649",
+  "offer_id": null,
+  "status": "created",
+  "attempts": 0,
+  "notes": [],
+  "created_at": 1573044247
+}
+```
+
+-------------------------------------------------------------------------------------------------------
+
+### Fetch all orders
+
+```rb
+option = {"count":1}
+
+Razorpay::Order.all(option)
+```
+
+**Parameters**
+
+| Name       | Type      | Description                                                  |
+|------------|-----------|--------------------------------------------------------------|
+| from       | timestamp | timestamp after which the orders were created              |
+| to         | timestamp | timestamp before which the orders were created             |
+| count      | integer   | number of orders to fetch (default: 10)                    |
+| skip       | integer   | number of orders to be skipped (default: 0)                |
+| authorized | boolean   | Orders for which orders are currently in authorized state. |
+| receipt    | string    | Orders with the provided value for receipt.                  |
+| expand[]   | string    |  Used to retrieve additional information about the payment. Possible value is `payments`,`payments.card`,`transfers` or `virtual_account` |
+
+**Response:**
+
+```json
+{
+  "entity": "collection",
+  "count": 1,
+  "items": [
+    {
+      "id": "order_EKzX2WiEWbMxmx",
+      "entity": "order",
+      "amount": 1234,
+      "amount_paid": 0,
+      "amount_due": 1234,
+      "currency": "INR",
+      "receipt": "Receipt No. 1",
+      "offer_id": null,
+      "status": "created",
+      "attempts": 0,
+      "notes": [],
+      "created_at": 1582637108
+    }
+  ]
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+### Fetch particular order
+
+```rb
+orderId = "order_DaaS6LOUAASb7Y"
+
+Razorpay::Order.fetch(orderId)
+```
+**Parameters**
+
+| Name     | Type   | Description                         |
+|----------|--------|-------------------------------------|
+| orderId* | string | The id of the order to be fetched |
+
+**Response:**
+
+```json
+{
+  "id":"order_DaaS6LOUAASb7Y",
+  "entity":"order",
+  "amount":2200,
+  "amount_paid":0,
+  "amount_due":2200,
+  "currency":"INR",
+  "receipt":"Receipt #211",
+  "status":"attempted",
+  "attempts":1,
+  "notes":[],
+  "created_at":1572505143
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+### Fetch payments for an order
+
+```rb
+orderId = "order_DaaS6LOUAASb7Y"
+
+Razorpay::Order.fetch("order_JCRhAvzvZQPkwT").payments
+```
+**Parameters**
+
+| Name     | Type   | Description                         |
+|----------|--------|-------------------------------------|
+| orderId* | string | The id of the order to be retrieve payment info |
+
+**Response:**
+```json
+{
+  "entity":"collection",
+  "count":1,
+  "items":[
+    {
+      "id":"pay_DaaSOvhgcOfzgR",
+      "entity":"payment",
+      "amount":2200,
+      "currency":"INR",
+      "status":"captured",
+      "order_id":"order_DaaS6LOUAASb7Y",
+      "invoice_id":null,
+      "international":false,
+      "method":"card",
+      "amount_refunded":0,
+      "refund_status":null,
+      "captured":true,
+      "description":"Beans in every imaginable flavour",
+      "card_id":"card_DZon6fd8J3IcA2",
+      "bank":null,
+      "wallet":null,
+      "vpa":null,
+      "email":"gaurav.kumar@example.com",
+      "contact":"+919999999988",
+      "notes":[],
+      "fee":44,
+      "tax":0,
+      "error_code":null,
+      "error_description":null,
+      "created_at":1572505160
+    }
+  ]
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+### Update order
+
+```rb
+orderId = "order_DaaS6LOUAASb7Y"
+
+para_attr = {
+  "notes": {
+    "key1": "value3",
+    "key2": "value2"
+  }
+}
+
+Razorpay::Order.edit(orderId,para_attr)
+```
+**Parameters**
+
+| Name     | Type   | Description                         |
+|----------|--------|-------------------------------------|
+| orderId* | string | The id of the order to be retrieve payment info |
+| notes*   | object  | A key-value pair                    |
+
+**Response:**
+```json
+{
+  "id":"order_DaaS6LOUAASb7Y",
+  "entity":"order",
+  "amount":2200,
+  "amount_paid":0,
+  "amount_due":2200,
+  "currency":"INR",
+  "receipt":"Receipt #211",
+  "offer_id":null,
+  "status":"attempted",
+  "attempts":1,
+  "notes":{
+    "notes_key_1":"Tea, Earl Grey, Hot",
+    "notes_key_2":"Tea, Earl Grey… decaf."
+  },
+  "created_at":1572505143
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+
+**PN: * indicates mandatory fields**
+<br>
+<br>
+**For reference click [here](https://razorpay.com/docs/api/orders/)**