razorpay 3.0.1 → 3.2.0

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,7 @@ 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)

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,32 @@
 # 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.1'.freeze
+  VERSION = '3.2.0'.freeze
+  ENTITIES_LIST =  {
+    "cards" => "card",
+    "invoices" => "invoice",
+    "refunds" => "refund",
+    "orders" => "order",
+    "payments" => "payment",
+    "customers" => "customer",
+    "plans" => "plan",
+    "virtual_accounts" => "virtualAccount",
+    "addons" => "addon",
+    "subscriptions" => "subscriptions",
+    "subscription_registrations" => "subscription_registrations",
+    "transfers" => "transfers",
+    "payment_links" => "payment_links",
+    "settlements" => "settlements",
+    "qr_codes" => "qr_codes",
+    "items" => "items",
+    "fund_accounts" => "fund_accounts",
+    "webhooks" => "webhook",
+    "payment_methods" => "payment_methods",
+    "products" => "products",
+    "tokens" => "tokens",
+    "iins" => "iins",
+    "stakeholders" => "stakeholders",
+    "accounts" => "accounts"
+  }
 end

data/lib/razorpay/generic.rb

@@ -0,0 +1,39 @@
+require 'razorpay/request'
+
+
+module Razorpay
+  class Generic
+    def initialize(entity)
+      @entity = entity
+    end
+
+    def request()
+      Razorpay::Request.new(@entity)
+    end
+
+    def do(url="", method="Get", options={}, version="v1")
+      r = self.request
+      r.doesEntityExist(@entity)
+
+      case method
+      when "Get"          
+        r.get url, options, version
+
+      when "Post"
+        r.post url, options, version
+
+      when "Patch"
+        r.patch url, options, version
+        
+      when "Put"
+        r.put url, options, version 
+      
+      when "Delete"
+        r.delete url, version
+      
+      else
+        warn("Unsupported method or error occurred") 
+      end   
+    end
+  end
+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/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 = {})
@@ -115,5 +115,11 @@ module Razorpay
       # We got an unknown error, cast it to Error for now
       raise Razorpay::Error.new, 'Unknown Error'
     end
+
+    def doesEntityExist(entity)
+      if (Razorpay::ENTITIES_LIST.include?(entity))
+        warn("Warning: The entity already has a specific function. Consider using it instead.")
+      end
+    end 
   end
 end

data/lib/razorpay/stakeholder.rb

@@ -0,0 +1,39 @@
+require 'razorpay/request'
+require 'razorpay/entity'
+
+module Razorpay
+  # Stakeholder API allows you to add stakeholders for an account. 
+  class Stakeholder < Entity
+
+    @@versions = "v2"
+
+    def self.request
+      Razorpay::Request.new('accounts')
+    end
+
+    def self.create(account_id, options)
+      request.post "#{account_id}/stakeholders", options, @@versions
+    end
+
+    def self.fetch(account_id, id)
+      request.fetch "#{account_id}/stakeholders/#{id}", @@versions
+    end
+
+    def self.all(account_id)
+      request.get "#{account_id}/stakeholders",{}, @@versions
+    end   
+
+    def self.edit(account_id, id, options = {})
+      request.patch "#{account_id}/stakeholders/#{id}", options, @@versions
+    end
+
+    def self.upload_stakeholder_doc(account_id, id,options)
+      r = request
+      r.request :post, "/#{@@versions}/accounts/#{account_id}/stakeholders/#{id}/documents", options
+    end
+
+    def self.fetch_stakeholder_doc(account_id, id)
+      request.fetch "#{account_id}/stakeholders/#{id}/documents", @@versions
+    end
+  end
+end

data/lib/razorpay/token.rb

@@ -0,0 +1,28 @@
+require 'razorpay/request'
+require 'razorpay/entity'
+
+module Razorpay
+  
+  class Token < Entity
+
+    def self.request
+      Razorpay::Request.new('tokens')
+    end
+
+    def self.create(options)
+      request.create options
+    end
+
+    def self.fetch(options)
+      request.post "fetch", options
+    end 
+
+    def self.delete(options)
+      request.post "delete", options
+    end
+
+    def self.process_payment_on_alternate_pa_or_pg(options)
+      request.post "service_provider_tokens/token_transactional_data", options
+    end
+  end
+end

data/lib/razorpay/virtual_account.rb

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

data/lib/razorpay/webhook.rb

@@ -0,0 +1,50 @@
+require 'razorpay/request'
+require 'razorpay/entity'
+
+module Razorpay
+  # Webhook API allows you create, fetch, update and delete
+  class Webhook < Entity
+
+    @@versions = "v2"
+
+    def self.request
+      Razorpay::Request.new('accounts')
+    end
+
+    def self.create(options, account_id = nil)
+      if(account_id)
+       return request.post "#{account_id}/webhooks", options, @@versions
+      end
+
+      r = request
+      return r.request :post, "/v1/webhooks", options
+    end
+
+    def self.all(options = {}, account_id = nil)
+      if(account_id)
+       return request.get "#{account_id}/webhooks" , options , @@versions
+      end
+
+      r = request
+      return r.request :get, "/v1/webhooks", options
+    end
+
+    def self.fetch(id, account_id)
+      request.fetch "#{account_id}/webhooks/#{id}", @@versions
+    end
+
+    def self.edit(options, id, account_id = nil)
+      if(account_id)  
+       return request.patch "#{account_id}/webhooks/#{id}", options, @@versions
+      end
+
+      r = request
+      return r.request :put, "/v1/webhooks/#{id}" , options
+    end
+
+    def self.delete(id, account_id)
+      request.delete "#{account_id}/webhooks/#{id}", @@versions
+    end
+  end
+end
+

data/lib/razorpay.rb

@@ -20,6 +20,13 @@ require 'razorpay/fund_account'
 require 'razorpay/item'
 require 'razorpay/qr_code'
 require 'razorpay/payment_method'
+require 'razorpay/webhook'
+require 'razorpay/iin'
+require 'razorpay/token'
+require 'razorpay/product'
+require 'razorpay/stakeholder'
+require 'razorpay/account'
+require 'razorpay/generic'
 
 # Base Razorpay module
 module Razorpay