razorpay 3.0.0 → 3.1.0

data/documents/upi.md

@@ -10,6 +10,7 @@ Razorpay.setup('key_id', 'key_secret')
 para_attr = {
   "name": "Razorpay User",
   "email": "customer@razorpay.com",
+  "fail_existing": 0,
   "contact": 9123456780,
   "notes": {
     "notes_key_1": "Tea, Earl Grey, Hot",
@@ -52,23 +53,19 @@ Razorpay::Customer.create(para_attr)
 
 ```rb
 para_attr = {
-  "amount": 0,
+  "amount": 100,
   "currency": "INR",
+  "customer_id": "cust_4xbQrmEoA5WJ01",
   "method": "upi",
-  "customer_id": "cust_1Aa00000000001",
+  "token": {
+    "max_amount": 200000,
+    "expire_at": 2709971120,
+    "frequency": "monthly"
+  },
   "receipt": "Receipt No. 1",
   "notes": {
-    "notes_key_1": "Beam me up Scotty",
-    "notes_key_2": "Engage"
-  },
-  "token": {
-    "auth_type": "netbanking",
-    "max_amount": 9999900,
-    "expire_at": 4102444799,
-    "notes": {
-      "notes_key_1": "Tea, Earl Grey, Hot",
-      "notes_key_2": "Tea, Earl Grey… decaf."
-    }
+    "notes_key_1": "Tea, Earl Grey, Hot",
+    "notes_key_2": "Tea, Earl Grey… decaf."
   }
 }
 Razorpay.Order.create(para_attr)
@@ -83,7 +80,7 @@ Razorpay.Order.create(para_attr)
 | method*        | string  | The authorization method. In this case the value will be `emandate`                      |
 | receipt         | string  | Your system order reference id.                                              |
 | notes           | object  | A key-value pair                                                             |
-| token           | object  | A key-value pair                                                             |
+| token           | object  | All parameters listed [here](https://razorpay.com/docs/api/payments/recurring-payments/upi/create-authorization-transaction#112-create-an-order) are supported |
 
 **Response:**
 ```json
@@ -147,17 +144,16 @@ 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/upi/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.                      |
-|sms_notify           | array  | Details of the line item that is billed in the invoice.  |
-|email_notify           | array  | Details of the line item that is billed in the invoice.  |
-|expire_by           | array  | Details of the line item that is billed in the invoice.  |
-|receipt         | string  | Your system order reference id.  |
-|notes           | object  | A key-value pair                                                             |
+| subscription_registration      | object  | All parameters listed [here](https://razorpay.com/docs/api/payments/recurring-payments/upi/create-authorization-transaction/#121-create-a-registration-link) are supported |
+| sms_notify  | boolean  | SMS notifications are to be sent by Razorpay (default : 1)  |
+| 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. |
+| notes | object  | A key-value pair  |
 
 
 **Response:**
@@ -227,7 +223,7 @@ invoiceId = "inv_JDdNb4xdf4gxQ7"
 
 medium = "email" 
 
-Razorpay::Invoice.notifyBy(invoiceId, medium)
+Razorpay::Invoice.notify_by(invoiceId, medium)
 ```
 
 **Parameters:**
@@ -322,9 +318,9 @@ Razorpay::Invoice.cancel(invoiceId)
 ### Fetch token by payment ID
 
 ```rb
-customerId = "cust_1Aa00000000004"
+paymentId = "pay_FHfAzEJ51k8NLj"
 
-Razorpay::Customer.fetchTokens(customerId)
+Razorpay::Payment.fetch(paymentId)
 ```
 
 **Parameters:**
@@ -382,7 +378,7 @@ Razorpay::Customer.fetchTokens(customerId)
 ```rb
 customerId = "cust_1Aa00000000004"
 
-Razorpay::Customer.fetchTokens(customerId)
+Razorpay::Customer.fetch(customerId).fetchTokens
 ```
 
 **Parameters:**
@@ -433,7 +429,7 @@ customerId = "cust_1Aa00000000004"
 
 tokenId = "token_Hxe0skTXLeg9pF"
 
-Razorpay::fetch(customerId).deleteToken(tokenId)
+Razorpay::Customer.fetch(customerId).deleteToken(tokenId)
 ```
 
 **Parameters:**
@@ -458,6 +454,7 @@ para_attr{
   "amount": 1000,
   "currency": "INR",
   "receipt": "Receipt No. 1",
+  "payment_capture": true,
   "notes": {
     "notes_key_1": "Tea, Earl Grey, Hot",
     "notes_key_2": "Tea, Earl Grey… decaf."
@@ -473,8 +470,8 @@ Razorpay::Order.create(para_attr)
 | 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.                                              |
+| 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                                                             |
-
 **Response:**
 ```json
 {
@@ -512,7 +509,7 @@ para_attr = {
   "description": "Creating recurring payment for Gaurav Kumar"
 }
 
-Razorpay::Payment.createRecurringPayment(para_attr)
+Razorpay::Payment.create_recurring_payment(para_attr)
 ```
 
 **Parameters:**

data/documents/virtualAccount.md

@@ -342,7 +342,7 @@ Razorpay::VirtualAccount.fetch(virtualId).payments(options)
 ```rb
 paymend_id = "pay_Di5iqCqA1WEHq6"
 
-Razorpay::Razorpay::Payment.fetch(paymend_id).bank_transfer
+Razorpay::Payment.fetch(paymend_id).bank_transfer
 ```
 
 **Parameters:**
@@ -403,6 +403,8 @@ Razorpay::Razorpay::Payment.fetch(paymend_id).bank_transfer
 
 ### Refund payments made to a virtual account
 ```rb
+paymend_id = "pay_Di5iqCqA1WEHq6"
+
 options = {
   "amount": "100",
   "speed": "normal",
@@ -413,7 +415,7 @@ options = {
   "receipt": "Receipt No. 31"
 }
 
-Razorpay::Payment.fetch(@payment_id).refund(options)
+Razorpay::Payment.fetch(payment_id).refund(options)
 ```
 
 **Parameters:**
@@ -429,20 +431,22 @@ Razorpay::Payment.fetch(@payment_id).refund(options)
 **Response:**
 ```json
 {
-  "id": "rfnd_E6j36ZEKvsWsEn",
+  "id": "rfnd_FP8QHiV938haTz",
   "entity": "refund",
-  "amount": 100,
+  "amount": 500100,
+  "receipt": "Receipt No. 31",
   "currency": "INR",
-  "payment_id": "pay_E54n391WnEAV9H",
-  "notes": {
-    "key_1": "value1",
-    "key_2": "value2"
-  },
+  "payment_id": "pay_FCXKPFtYfPXJPy",
+  "notes": [],
   "receipt": null,
   "acquirer_data": {
-    "rrn": null
+    "arn": null
   },
-  "created_at": 1579522301
+  "created_at": 1597078866,
+  "batch_id": null,
+  "status": "processed",
+  "speed_processed": "normal",
+  "speed_requested": "normal"
 }
 ```
 -------------------------------------------------------------------------------------------------------
@@ -469,7 +473,7 @@ Razorpay::VirtualAccount.add_receiver(virtualId, para_attr)
 |-------|-----------|--------------------------------------------------|
 | virtualId*  | string    | The id of the virtual to be updated  |
 | types*  | object | The receiver type to be added to the virtual account. Possible values are `vpa` or `bank_account`  |
-| vpa    | object | This is to be passed only when `vpa` is passed as the receiver types. |
+| vpa.descriptor    | string | Descriptor should be 10 characters only. |
 
 **Response:**
 For add receiver to an existing virtual account response please click [here](https://razorpay.com/docs/api/smart-collect/#add-receiver-to-an-existing-virtual-account)
@@ -560,7 +564,7 @@ Razorpay::VirtualAccount.delete_allowed_payer(virtualId,allowedPayersId)
 
 **Response:**
 ```json
-{}
+null
 ```
 -------------------------------------------------------------------------------------------------------
 ### Close virtual account
@@ -578,6 +582,7 @@ Razorpay::VirtualAccount.close(virtualId)
 
 **Response:**
 For close virtual account response please click [here](https://razorpay.com/docs/api/smart-collect/#close-a-virtual-account)
+
 -------------------------------------------------------------------------------------------------------
 
 **PN: * indicates mandatory fields**

data/documents/webhook.md

@@ -0,0 +1,224 @@
+## Webhook
+
+### Create a Webhook
+```rb
+accountId = "acc_GP4lfNA0iIMn5B"
+
+Razorpay::Webhook.create({
+  "url": "https://google.com",
+  "alert_email": "gaurav.kumar@example.com",
+  "secret": "12345",
+  "events": [
+    "payment.authorized",
+    "payment.failed",
+    "payment.captured",
+    "payment.dispute.created",
+    "refund.failed",
+    "refund.created"
+  ]
+}, accountId)
+```
+
+**Parameters:**
+
+| Name          | Type        | Description                                 |
+|---------------|-------------|---------------------------------------------|
+| accountId* | string      | The unique identifier of a sub-merchant account generated by Razorpay.  |
+| url*        | string      | The URL where you receive the webhook payload when an event is triggered. The maximum length is 255 characters.  |
+| alert_email          | string  | This is the email address to which notifications must be sent in case of webhook failure. |
+| secret      | string | A secret for the webhook endpoint that is used to validate that the webhook is from Razorpay.  |
+| events | string | The required events from the list of Active Events. For example `payment.authorized`, `payment.captured`, `payment.failed`, `payment.dispute.created`, `refund.failed`, `refund.created` and so on. |
+
+**Response:**
+```json
+{
+  "id": "JebiXkKGYwua5L",
+  "created_at": 1654605478,
+  "updated_at": 1654605478,
+  "service": "beta-api-live",
+  "owner_id": "JOGUdtKu3dB03d",
+  "owner_type": "merchant",
+  "context": [],
+  "disabled_at": 0,
+  "url": "https://google.com",
+  "alert_email": "gaurav.kumar@example.com",
+  "secret_exists": true,
+  "entity": "webhook",
+  "active": true,
+  "events": [
+    "payment.authorized",
+    "payment.failed",
+    "payment.captured",
+    "payment.dispute.created",
+    "refund.failed",
+    "refund.created"
+  ]
+}
+```
+
+-------------------------------------------------------------------------------------------------------
+
+### Edit Webhook
+```rb
+webhookId = "HK890egfiItP3H"
+
+accountId = "acc_GP4lfNA0iIMn5B"
+
+Razorpay::Webhook.edit({
+  "url": "https://www.linkedin.com",
+  "events": [
+    "refund.created"
+  ]
+}, webhookId, accountId)
+```
+
+**Parameters:**
+
+| Name          | Type        | Description                                 |
+|---------------|-------------|---------------------------------------------|
+| accountId* | string    | The unique identifier of a sub-merchant account generated by Razorpay.  |
+| webhookId* | string    | The unique identifier of the webhook whose details are to be updated |    
+| url        | string      | The URL where you receive the webhook payload when an event is triggered. The maximum length is 255 characters.  |
+| events | string | The required events from the list of Active Events. For example `payment.authorized`, `payment.captured`, `payment.failed`, `payment.dispute.created`, `refund.failed`, `refund.created` and so on. |
+
+**Response:**
+```json
+{
+  "id": "HK890egfiItP3H",
+  "created_at": 1623060358,
+  "updated_at": 1623067148,
+  "service": "beta-api-test",
+  "owner_id": "H3kYHQ635sBwXG",
+  "owner_type": "merchant",
+  "context": [],
+  "disabled_at": 0,
+  "url": "https://www.linkedin.com",
+  "alert_email": "gaurav.kumar@example.com",
+  "secret_exists": true,
+  "entity": "webhook",
+  "active": true,
+  "events": [
+    "refund.created"
+  ]
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+### Delete an account
+```rb
+accountId = "acc_GP4lfNA0iIMn5B"
+
+webhookId = "HK890egfiItP3H"
+
+Razorpay::Webhook.delete(webhookId, accountId)
+```
+
+**Parameters:**
+
+| Name          | Type        | Description                                 |
+|---------------|-------------|---------------------------------------------|
+| accountId* | string   | The unique identifier of a sub-merchant account that must be deleted.  |
+| webhookId* | string    | The unique identifier of the webhook whose details are to be updated | 
+
+**Response:**
+```json
+[]
+```
+
+-------------------------------------------------------------------------------------------------------
+
+### Fetch a webhook
+```rb
+accountId = "acc_GP4lfNA0iIMn5B";
+
+webhookId = "HK890egfiItP3H";
+
+Razorpay::Webhook.fetch(webhookId, accountId);
+```
+
+**Parameters:**
+
+| Name        | Type        | Description                                 |
+|-------------|-------------|---------------------------------------------|
+| accountId* | string      | The unique identifier of a sub-merchant account generated by Razorpay.  |
+| webhookId* | string    | The unique identifier of the webhook whose details are to be updated | 
+
+**Response:**
+```json
+{
+  "id": "HK890egfiItP3H",
+  "created_at": 1623060358,
+  "updated_at": 1623060358,
+  "owner_id": "H3kYHQ635sBwXG",
+  "owner_type": "merchant",
+  "context": [],
+  "disabled_at": 0,
+  "url": "https://en1mwkqo5ioct.x.pipedream.net",
+  "alert_email": "gaurav.kumar@example.com",
+  "secret_exists": true,
+  "entity": "webhook",
+  "active": true,
+  "events": [
+    "payment.authorized",
+    "payment.failed",
+    "payment.captured",
+    "payment.dispute.created",
+    "refund.failed",
+    "refund.created"
+  ]
+}
+```
+
+-------------------------------------------------------------------------------------------------------
+
+### Fetch all Webhooks
+```rb
+accountId = "acc_GP4lfNA0iIMn5B";
+
+Razorpay::Webhook.all({
+ "count": 1
+}, accountId);
+```
+
+**Parameters:**
+
+| Name        | Type        | Description                                 |
+|-------------|-------------|---------------------------------------------|
+| accountId* | string      | The unique identifier of a sub-merchant account generated by Razorpay.  |
+| from  |  integer | Timestamp, in seconds, from when the webhooks are to be fetched.  |
+| to    |  integer | Timestamp, in seconds, till when the webhooks are to be fetched. |
+| count |  integer   | Number of webhooks to be fetched. The default value is `10` and the maximum value is `100`. This can be used for pagination, in combination with `skip`.       |
+| skip  |  integer   | Number of records to be skipped while fetching the webhooks. This can be used for pagination, in combination with `count`.    |
+
+**Response:**
+```json
+{
+  "id": "HK890egfiItP3H",
+  "created_at": 1623060358,
+  "updated_at": 1623060358,
+  "owner_id": "H3kYHQ635sBwXG",
+  "owner_type": "merchant",
+  "context": [],
+  "disabled_at": 0,
+  "url": "https://en1mwkqo5ioct.x.pipedream.net",
+  "alert_email": "gaurav.kumar@example.com",
+  "secret_exists": true,
+  "entity": "webhook",
+  "active": true,
+  "events": [
+    "payment.authorized",
+    "payment.failed",
+    "payment.captured",
+    "payment.dispute.created",
+    "refund.failed",
+    "refund.created"
+  ]
+}
+```
+
+-------------------------------------------------------------------------------------------------------
+
+**PN: * indicates mandatory fields**
+<br>
+<br>
+**For reference click [here](https://razorpay.com/docs/api/partners/webhooks)**

data/lib/razorpay/account.rb

@@ -0,0 +1,39 @@
+require 'razorpay/request'
+require 'razorpay/entity'
+
+module Razorpay
+  # Account API allows you to create a sub-merchant account.  
+  class Account < Entity
+    
+    @@versions = "v2"
+
+    def self.request
+      Razorpay::Request.new('accounts')
+    end
+
+    def self.create(options)
+      request.create options, @@versions
+    end
+
+    def self.fetch(id)
+      request.fetch id, @@versions
+    end
+
+    def self.edit(id, options = {})
+      request.patch id, options, @@versions
+    end
+
+    def self.delete(id)
+      request.delete "#{id}", @@versions
+    end
+
+    def self.upload_account_doc(id,options)
+      r = request
+      r.request :post, "/#{@@versions}/accounts/#{id}/documents", options
+    end
+    
+    def self.fetch_account_doc(id)
+      request.fetch "#{id}/documents", @@versions
+    end
+  end
+end

data/lib/razorpay/addon.rb

@@ -22,7 +22,11 @@ module Razorpay
       # POST /addons is not supported
       # Addon creation endpoint is:
       # POST subscriptions/{sub_id}/addons
-      r.request :post, "/subscriptions/#{subscription_id}/addons", options
+      r.request :post, "/v1/subscriptions/#{subscription_id}/addons", options
+    end
+
+    def self.delete(id)
+      request.delete id
     end
   end
 end

data/lib/razorpay/card.rb

@@ -13,5 +13,9 @@ module Razorpay
     def self.fetch(id)
       request.fetch id
     end
+
+    def self.request_card_reference(options)
+      request.post 'fingerprints', options
+    end
   end
 end

data/lib/razorpay/constants.rb

@@ -1,6 +1,6 @@
 # Version and other constants are defined here
 module Razorpay
-  BASE_URI = 'https://api.razorpay.com/v1/'.freeze
+  BASE_URI = 'https://api.razorpay.com'.freeze
   TEST_URL = 'https://api.razorpay.com/'.freeze
-  VERSION = '3.0.0'.freeze
+  VERSION = '3.1.0'.freeze
 end

data/lib/razorpay/iin.rb

@@ -0,0 +1,15 @@
+require 'razorpay/request'
+require 'razorpay/entity'
+
+module Razorpay
+  # IIN API allows you to fetch card properties using token IIN.
+  class Iin < Entity
+    def self.request
+      Razorpay::Request.new('iins')
+    end
+
+    def self.fetch(id)
+      request.fetch id
+    end
+  end
+end

data/lib/razorpay/order.rb

@@ -23,7 +23,7 @@ module Razorpay
 
     def payments(options = {})
       r = self.class.request
-      r.request :get, "/orders/#{id}/payments", options
+      r.request :get, "/v1/orders/#{id}/payments", options
     end
     
     def self.edit(id, options = {})

data/lib/razorpay/payment.rb

@@ -104,5 +104,13 @@ module Razorpay
     def otp_resend
       self.class.request.post "#{id}/otp/resend"
     end
+
+    def self.create_upi(data={})
+      request.post "create/upi" , data
+    end
+    
+    def self.validate_vpa(data={})
+      request.post "validate/vpa" , data
+    end
   end
 end

data/lib/razorpay/payment_method.rb

@@ -0,0 +1,17 @@
+require 'razorpay/request'
+require 'razorpay/refund'
+require 'razorpay/entity'
+
+module Razorpay
+  # Payment Methods class is allows you to create
+  # to fetch all payment methods
+  class PaymentMethods < Entity
+    def self.request
+      Razorpay::Request.new('methods')
+    end
+    
+    def self.all(options = {})
+      request.all options
+    end
+  end
+end

data/lib/razorpay/product.rb

@@ -0,0 +1,37 @@
+require 'razorpay/request'
+require 'razorpay/entity'
+
+module Razorpay
+  # Product API allows you to enable sub-merchants request for a product.
+  class Product < Entity
+
+    @@versions = "v2"
+
+    def self.request
+      Razorpay::Request.new('accounts')
+    end
+
+    def self.request_product_configuration(account_id, options)
+      if(!options.is_a?(String) && options.key?(:tnc_accepted))
+        options[:tnc_accepted] = (options[:tnc_accepted] ? 1 : 0)
+      end
+      request.post "#{account_id}/products", options, @@versions
+    end
+
+    def self.fetch(account_id, id)
+      request.fetch "#{account_id}/products/#{id}", @@versions
+    end 
+
+    def self.edit(account_id, id, options = {})
+      if(!options.is_a?(String) && options.key?(:tnc_accepted))
+        options[:tnc_accepted] = (options[:tnc_accepted] ? 1 : 0)
+      end
+      request.patch "#{account_id}/products/#{id}", options, @@versions
+    end
+
+    def self.fetch_tnc(productName)
+      r = request
+      r.request :get, "/#{@@versions}/products/#{productName}/tnc", {}
+    end
+  end
+end

data/lib/razorpay/request.rb

@@ -27,36 +27,36 @@ module Razorpay
       }
     end
 
-    def fetch(id)
-      request :get, "/#{@entity_name}/#{id}"
+    def fetch(id, version="v1")
+      request :get, "/#{version}/#{@entity_name}/#{id}"
     end
 
-    def all(options)
-      request :get, "/#{@entity_name}", options
+    def all(options, version="v1")
+      request :get, "/#{version}/#{@entity_name}", options
     end
 
-    def post(url, data = {})
-      request :post, "/#{@entity_name}/#{url}", data
+    def post(url, data = {}, version="v1")
+      request :post, "/#{version}/#{@entity_name}/#{url}", data
     end
 
-    def get(url, data = {})
-      request :get, "/#{@entity_name}/#{url}", data
+    def get(url, data = {}, version="v1")
+      request :get, "/#{version}/#{@entity_name}/#{url}", data
     end
     
-    def delete(url)
-      request :delete, "/#{@entity_name}/#{url}"
+    def delete(url, version="v1")
+      request :delete, "/#{version}/#{@entity_name}/#{url}"
     end
 
-    def put(id, data = {})
-      request :put, "/#{@entity_name}/#{id}", data
+    def put(id, data = {}, version="v1")
+      request :put, "/#{version}/#{@entity_name}/#{id}", data
     end
 
-    def patch(id, data = {})
-      request :patch, "/#{@entity_name}/#{id}", data
+    def patch(id, data = {}, version="v1")
+      request :patch, "/#{version}/#{@entity_name}/#{id}", data
     end
 
-    def create(data)
-      request :post, "/#{@entity_name}", data
+    def create(data, version="v1")
+      request :post, "/#{version}/#{@entity_name}", data
     end
 
     def request(method, url, data = {})