razorpay 3.0.0 → 3.1.0

data/documents/card.md

@@ -53,7 +53,7 @@ Razorpay::Customer.create(para_attr)
 ### Create Order
 
 ```rb
-param_attr = {
+para_attr = {
    "amount":100,
    "currency": "INR",
    "customer_id": "cust_4xbQrmEoA5WJ01",
@@ -150,8 +150,7 @@ Razorpay::SubscriptionRegistration.create(para_attr)
 
 | Name            | Type    | Description                                                                  |
 |-----------------|---------|------------------------------------------------------------------------------|
-| customer   | object      | Details of the customer to whom the registration link will be sent. |
-| type*  | string | the value is `link`. |
+| customer   | object  | All keys listed [here](https://razorpay.com/docs/api/recurring-payments/cards/authorization-transaction/#121-create-a-registration-link) are supported  |
 | amount*   | integer      | The amount to be captured (should be equal to the authorized amount, in paise) |
 | currency*   | string  | The currency of the payment (defaults to INR)  |
 | description*  | string      | A brief description of the payment.   |
@@ -304,7 +303,7 @@ para_attr = {
     "note_key 2": "Tea. Earl Gray. Hot."
   }
 }
-Razorpay::Payment.createRecurringPayment(para_attr)
+Razorpay::Payment.create_recurring_payment(para_attr)
 ```
 **Parameters:**
 
@@ -344,7 +343,7 @@ invoiceId = "inv_JDdNb4xdf4gxQ7"
 
 medium = "email" 
 
-Razorpay::Invoice.notifyBy(invoiceId, medium)
+Razorpay::Invoice.notify_by(invoiceId, medium)
 ```
 **Parameters:**
 
@@ -493,7 +492,7 @@ Razorpay::Payment.fetch(paymentId)
 ```rb
 customerId = "cust_1Aa00000000004"
 
-Razorpay::Customer.fetchTokens(customerId)
+Razorpay::Customer.fetch(customerId).fetchTokens
 ```
 **Parameters:**
 
@@ -549,10 +548,34 @@ Razorpay::Customer.fetchTokens(customerId)
 ```
 -------------------------------------------------------------------------------------------------------
 
+## Delete tokens
+
+```rb
+customerId = "cust_1Aa00000000004"
+
+tokenId = "token_Hxe0skTXLeg9pF"
+
+Razorpay::Customer.fetch(customerId).deleteToken(tokenId)
+```
+**Parameters:**
+
+| Name            | Type    | Description                                                                  |
+|-----------------|---------|------------------------------------------------------------------------------|
+| customerId*   | string      | The id of the customer to be fetched |
+| tokenId*   | string      | The id of the token to be fetched |
+
+**Response:**
+```json
+{
+    "deleted": true
+}
+```
+-------------------------------------------------------------------------------------------------------
+
 ### Fetch card
 
 ```rb
-cardId = ""
+cardId = "card_JXPULjlKqC5j0i"
 
 Razorpay::Card.fetch(cardId)
 ```
@@ -566,43 +589,64 @@ Razorpay::Card.fetch(cardId)
 **Response:**
 ```json
 {
-  "id": "card_JXPULjlKqC5j0i",
-  "entity": "card",
-  "name": "gaurav.kumar",
-  "last4": "4366",
-  "network": "Visa",
-  "type": "credit",
-  "issuer": "UTIB",
-  "international": false,
-  "emi": true,
-  "sub_type": "consumer",
-  "token_iin": null
+    "id": "card_JXPULjlKqC5j0i",
+    "entity": "card",
+    "name": "Gaurav",
+    "last4": "4366",
+    "network": "Visa",
+    "type": "credit",
+    "issuer": "UTIB",
+    "international": false,
+    "emi": true,
+    "sub_type": "consumer",
+    "token_iin": null
 }
-
+```
 -------------------------------------------------------------------------------------------------------
-
-## Delete tokens
+## Using Card Number/ Tokenised Card Number
 
 ```rb
-customerId = "cust_1Aa00000000004"
+Razorpay::Card.request_card_reference({"number":"4111111111111111"});
+```
+**Parameters:**
 
-tokenId = "token_Hxe0skTXLeg9pF"
+| Name        | Type    | Description                                                                  |
+|-------------|---------|------------------------------------------------------------------------------|
+| number* | string | The card number whose PAR or network reference id should be retrieved. |
+| tokenised  | string | Determines if the card is saved as a token. Possible value is `true` or `false` |
+
+**Response:**
+```json
+{
+  "network": "Visa",
+  "payment_account_reference": "V0010013819231376539033235990",
+  "network_reference_id": null
+}
+```
+-------------------------------------------------------------------------------------------------------
 
-Razorpay::fetch(customerId).deleteToken(tokenId)
+## Using Razporpay token
+
+```rb
+Razorpay::Card.requestCardReference({"token":"token_4lsdksD31GaZ09"});
 ```
 **Parameters:**
 
-| Name            | Type    | Description                                                                  |
-|-----------------|---------|------------------------------------------------------------------------------|
-| customerId*   | string      | The id of the customer to be fetched |
-| tokenId*   | string      | The id of the token to be fetched |
+| Name        | Type    | Description                                                                  |
+|-------------|---------|------------------------------------------------------------------------------|
+| token* | string | The token whose PAR or network reference id should be retrieved.|
+
+
 
 **Response:**
 ```json
 {
-    "deleted": true
+  "network": "Visa",
+  "payment_account_reference": "V0010013819231376539033235990",
+  "network_reference_id": null
 }
 ```
+
 -------------------------------------------------------------------------------------------------------
 
 **PN: * indicates mandatory fields**

data/documents/customer.md

@@ -28,6 +28,8 @@ Razorpay::Customer.create({
 | name*          | string      | Name of the customer                        |
 | email        | string      | Email of the customer                       |
 | contact      | string      | Contact number of the customer              |
+| fail_existing | string | If a customer with the same details already exists, the request throws an exception by default. Possible value is `0` or `1`|
+| gstin         | string      | Customer's GST number, if available. For example, `29XAbbA4369J1PA`  |
 | notes         | object      | A key-value pair                            |
 
 **Response:**

data/documents/emandate.md

@@ -12,7 +12,6 @@ Razorpay::Customer.create({
   "contact": 9123456780,
   "email": "gaurav.kumar@example.com",
   "fail_existing": 0,
-  "gstin": "29XAbbA4369J1PA",
   "notes": {
     "notes_key_1": "Tea, Earl Grey, Hot",
     "notes_key_2": "Tea, Earl Grey… decaf."
@@ -28,6 +27,7 @@ Razorpay::Customer.create({
 | email        | string      | Email of the customer                       |
 | contact      | string      | Contact number of the customer              |
 | notes         | object      | A key-value pair                            |
+| fail_existing | string | If a customer with the same details already exists, the request throws an exception by default. Possible value is `0` or `1`|
 
 **Response:**
 ```json
@@ -50,9 +50,10 @@ Razorpay::Customer.create({
 ### Create order
 
 ```rb
-Razorpay::Customer.create({
+Razorpay::Order.create({
   "amount": 0,
   "currency": "INR",
+  "payment_capture": true,
   "method": "emandate",
   "customer_id": "cust_1Aa00000000001",
   "receipt": "Receipt No. 1",
@@ -70,7 +71,7 @@ Razorpay::Customer.create({
     },
     "bank_account": {
       "beneficiary_name": "Gaurav Kumar",
-      "account_number": 1121431121541121,
+      "account_number": "1121431121541121",
       "account_type": "savings",
       "ifsc_code": "HDFC0000001"
     }
@@ -86,12 +87,14 @@ Razorpay::Customer.create({
 | currency*        | string  | Currency of the order. Currently only `INR` is supported.                      |
 | method*        | string  | The authorization method. In this case the value will be `emandate`                      |
 | receipt         | string  | Your system order reference id.                                              |
+| customer_id*         | string  | The `customer_id` for the customer you want to charge.|
 | payment_capture  | boolean  | Indicates whether payment status should be changed to captured automatically or not. Possible values: true - Payments are captured automatically. false - Payments are not captured automatically. |
-| notes           | object  | A key-value pair   |
-| token           | object  | A key-value pair   |
+| notes           | object  | A key-value pair                                                             |
+| token  | object  | All parameters listed [here](https://razorpay.com/docs/api/payments/recurring-payments/emandate/create-authorization-transaction/#112-create-an-order) are supported|
 
 **Response:**
 Create order response please click [here](https://razorpay.com/docs/api/recurring-payments/emandate/authorization-transaction/#112-create-an-order)
+
 -------------------------------------------------------------------------------------------------------
 
 ### Create an Authorization Payment
@@ -142,16 +145,20 @@ Razorpay::SubscriptionRegistration.create(para_attr)
 
 | Name            | Type    | Description                                                                  |
 |-----------------|---------|------------------------------------------------------------------------------|
-| customer          | object | Details of the customer to whom the registration link will be sent.           |
+| customer*          | object  | All parameters listed [here](https://razorpay.com/docs/api/payments/recurring-payments/emandate/create-authorization-transaction/#121-create-a-registration-link) are supported  |
 | type*        | string  | In this case, the value is `link`.                      |
 | currency*        | string  | The 3-letter ISO currency code for the payment. Currently, only `INR` is supported. |
 | amount*         | integer  | The payment amount in the smallest currency sub-unit.                 |
 | description*    | string  | A description that appears on the hosted page. For example, `12:30 p.m. Thali meals (Gaurav Kumar`).                                                             |
-| subscription_registration           | object  | Details of the authorization payment.                      |
-| notes           | object  | A key-value pair                                                             |
+| subscription_registration  | object  | All parameters listed [here](https://razorpay.com/docs/api/payments/recurring-payments/emandate/create-authorization-transaction/#121-create-a-registration-link) are supported  |
+| email_notify | boolean  | Email notifications are to be sent by Razorpay (default : 1)  |
+| expire_by    | integer | The timestamp, in Unix format, till when the customer can make the authorization payment. |
+| receipt      | string  | Your system order reference id.  |
+| notes           | object  | A key-value pair  |
 
 **Response:**
 Create registration link response please click [here](https://razorpay.com/docs/api/recurring-payments/emandate/authorization-transaction/#121-create-a-registration-link)
+
 -------------------------------------------------------------------------------------------------------
 
 ### Send/Resend notifications
@@ -161,7 +168,7 @@ invoiceId = "inv_JDdNb4xdf4gxQ7"
 
 medium = "email" 
 
-Razorpay::Invoice.notifyBy(invoiceId, medium)
+Razorpay::Invoice.notify_by(invoiceId, medium)
 ```
 
 **Parameters:**
@@ -313,7 +320,7 @@ Razorpay::Payment.fetch(paymentId)
 ```rb
 customerId = "cust_1Aa00000000004"
 
-Razorpay::Customer.fetchTokens(customerId)
+Razorpay::Customer.fetch(customerId).fetchTokens
 ```
 
 **Parameters:**
@@ -367,7 +374,7 @@ customerId = "cust_1Aa00000000004"
 
 tokenId = "token_Hxe0skTXLeg9pF"
 
-Razorpay::fetch(customerId).deleteToken(tokenId)
+Razorpay::Customer.fetch(customerId).deleteToken(tokenId)
 ```
 
 **Parameters:**
@@ -409,6 +416,7 @@ Razorpay::Order.create(para_attr)
 | currency*        | string  | Currency of the order. Currently only `INR` is supported.                      |
 | receipt         | string  | Your system order reference id.                                              |
 | notes           | object  | A key-value pair                                                             |
+| payment_capture*  | boolean  | Indicates whether payment status should be changed to captured automatically or not. Possible values: true - Payments are captured automatically. false - Payments are not captured automatically. |
 
 **Response:**
 ```json
@@ -450,7 +458,7 @@ para_attr = {
     "note_key 2": "Tea. Earl Gray. Hot."
   }
 }
-Razorpay::Payment.createRecurringPayment(para_attr)
+Razorpay::Payment.create_recurring_payment(para_attr)
 ```
 
 **Parameters:**

data/documents/fund.md

@@ -8,16 +8,16 @@ Razorpay.setup('key_id', 'key_secret')
 ### Create a fund account
 ```rb
 para_attr = {
-  "customer_id":"cust_Aa000000000001",
-  "account_type":"bank_account",
+  "customer_id": "cust_Aa000000000001",
+  "account_type": "bank_account",
   "bank_account":{
-    "name":"Gaurav Kumar",
-    "account_number":"11214311215411",
-    "ifsc":"HDFC0000053"
+    "name": "Gaurav Kumar",
+    "account_number": "11214311215411",
+    "ifsc": "HDFC0000053"
   }
 }
 
-Razorpay::FundAccount.create(data)
+Razorpay::FundAccount.create(para_attr)
 ```
 
 **Parameters:**
@@ -31,18 +31,20 @@ Razorpay::FundAccount.create(data)
 **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"
+  "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"
   },
-  "active":true,
-  "created_at":1543650891
+  "batch_id": null,
+  "active": true,
+  "created_at": 1654154246
 }
 ```
 -------------------------------------------------------------------------------------------------------

data/documents/items.md

@@ -23,17 +23,27 @@ Razorpay::Item.create({
 | 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.    |
+| currency*           | string  | Currency of the order. Currently only `INR` is supported.    |
 
 **Response:**
 ```json
 {
-  "id": "item_7Oxp4hmm6T4SCn",
+  "id": "item_Jf5MlwKlPMOKBV",
   "active": true,
   "name": "Book / English August",
   "description": "An indian story, Booker prize winner.",
   "amount": 20000,
-  "currency": "INR"
+  "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
 }
 ```
 
@@ -63,34 +73,28 @@ Razorpay::Item.all(options)
 **Response:**
 ```json
 {
-  "entity": "collection",
-  "count": 3,
-  "items": [
-    {
-      "id": "item_7Oy8OMV6BdEAac",
-      "active": true,
-      "name": "Book / Ignited Minds",
-      "description": null,
-      "amount": 15000,
-      "currency": "INR"
-    },
-    {
-      "id": "item_7Oxp4hmm6T4SCn",
-      "active": true,
-      "name": "Book / English August",
-      "description": "An indian story, Booker prize winner.",
-      "amount": 20000,
-      "currency": "INR"
-    },
-    {
-      "id": "item_7OxoGnoxCuUKbo",
-      "active": true,
-      "name": "Book / English August",
-      "description": null,
-      "amount": 20000,
-      "currency": "INR"
-    }
-  ]
+    "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
+        }
+    ]
 }
 ```
 -------------------------------------------------------------------------------------------------------
@@ -110,12 +114,22 @@ Razorpay::Item.fetch(itemId)
 **Response:**
 ```json
 {
-  "id": "item_7Oxp4hmm6T4SCn",
-  "active": true,
-  "name": "Book / English August",
-  "description": "An indian story, Booker prize winner.",
-  "amount": 20000,
-  "currency": "INR"
+    "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
 }
 ```
 
@@ -150,12 +164,22 @@ Razorpay::Item.edit(itemId,para_attr)
 **Response:**
 ```json
 {
-  "id": "item_7Oy8OMV6BdEAac",
+  "id": "item_JInaSLODeDUQiQ",
   "active": true,
   "name": "Book / Ignited Minds - Updated name!",
-  "description": "New descirption too. :)",
-  "amount": 15000,
-  "currency": "INR"
+  "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
 }
 ```
 -------------------------------------------------------------------------------------------------------

data/documents/order.md

@@ -52,6 +52,56 @@ Razorpay::Order.create(para_attr)
 
 -------------------------------------------------------------------------------------------------------
 
+### 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
@@ -70,6 +120,7 @@ Razorpay::Order.all(option)
 | 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:**