razorpay 2.4.0 → 3.2.4

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

@@ -13,12 +13,20 @@ module Razorpay
       request.fetch id
     end
 
+    def self.all(options = {})
+       request.all options
+    end
+
     def self.create(subscription_id, options)
       r = request
       # 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,11 @@
 # 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 = '2.4.0'.freeze
+  VERSION  = '3.2.4'.freeze
+  AUTH_URL = 'https://auth.razorpay.com'.freeze
+  API_HOST = 'API'.freeze
+  AUTH_HOST    = 'AUTH'.freeze
+  PRIVATE_AUTH = 'Private'.freeze
+  OAUTH        = 'OAuth'.freeze
 end

data/lib/razorpay/customer.rb

@@ -23,5 +23,36 @@ module Razorpay
     def self.all(options = {})
       request.all options
     end
+    
+    # Fetch token by customerId
+    # https://razorpay.com/docs/api/recurring-payments/upi/tokens/#22-fetch-tokens-by-customer-id 
+    def fetchTokens
+      self.class.request.get "#{id}/tokens" 
+    end
+ 
+   # Fetch specific token 
+    def fetchToken(tokenId)
+      self.class.request.get "#{id}/tokens/#{tokenId}" 
+    end
+
+    def deleteToken(tokenId)
+      self.class.request.delete "#{id}/tokens/#{tokenId}" 
+    end
+
+    def self.add_bank_account(id, options = {})
+      request.post "#{id}/bank_account", options
+    end
+
+    def self.delete_bank_account(id, bankAccountId)
+      request.delete "#{id}/bank_account/#{bankAccountId}" 
+    end
+
+    def self.request_eligibility_check(options = {})
+       request.post "eligibility", options
+    end
+
+    def self.fetch_eligibility(eligibilityId)
+      request.get "eligibility/#{eligibilityId}" 
+    end
   end
 end

data/lib/razorpay/dispute.rb

@@ -0,0 +1,26 @@
+require 'razorpay/request'
+require 'razorpay/entity'
+
+module Razorpay
+  class Dispute < Entity
+    def self.request
+      Razorpay::Request.new('disputes')
+    end
+
+    def self.fetch(id)
+      request.fetch id
+    end
+
+    def self.all(options = {})
+       request.all options
+    end
+
+    def self.accept(id, options={})
+       request.post "#{id}/accept", options
+    end
+
+    def self.contest(id, options)
+       request.patch "#{id}/contest", options
+    end
+  end
+end

data/lib/razorpay/document.rb

@@ -0,0 +1,19 @@
+require 'razorpay/request'
+require 'razorpay/entity'
+
+module Razorpay
+  # Document API allows you to create and fetch document on Razorpay
+  class Document < Entity
+    def self.request
+      Razorpay::Request.new('documents')
+    end
+
+    def self.create(options)
+      request.create options
+    end
+
+    def self.fetch(id)
+      request.fetch id
+    end
+  end
+end

data/lib/razorpay/fund_account.rb

@@ -0,0 +1,19 @@
+require 'razorpay/request'
+require 'razorpay/entity'
+
+module Razorpay
+  # FundAccount API allows you to create and fetch a fund account for a customer. 
+  class FundAccount < Entity
+    def self.request
+      Razorpay::Request.new('fund_accounts')
+    end
+
+    def self.create(options)
+      request.create options
+    end
+
+    def self.all(data = {})
+      request.all data
+    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/invoice.rb

@@ -56,5 +56,13 @@ module Razorpay
     def cancel!
       with_a_bang { cancel }
     end
+
+    def self.notify_by(id, medium)
+      request.post "#{id}/notify_by/#{medium}"
+    end
+    
+    def self.delete(id)
+      request.delete "#{id}" 
+    end
   end
 end

data/lib/razorpay/item.rb

@@ -0,0 +1,34 @@
+require 'razorpay/request'
+require 'razorpay/entity'
+
+module Razorpay
+  # Item API allows you to create and fetch customers on Razorpay
+  class Item < Entity
+    def self.request
+      Razorpay::Request.new('items')
+    end
+
+    def self.create(options)
+      request.create options
+    end
+
+    def self.fetch(id)
+      request.fetch id
+    end
+
+    def self.edit(id, options = {})
+      if(!options.is_a?(String) && options.key?(:active))
+        options[:active] = (options[:active] ? 1 : 0)
+      end 
+      request.patch id, options
+    end
+
+    def self.all(options = {})
+      request.all options
+    end
+
+    def self.delete(id)
+        request.delete id
+    end    
+  end
+end

data/lib/razorpay/oauth_token.rb

@@ -0,0 +1,109 @@
+require 'razorpay/request'
+require 'razorpay/entity'
+require 'razorpay/payload_validator'
+require 'razorpay/validation_config'
+
+module Razorpay
+  # OAuth APIs allow to you create and manage access tokens
+  class OAuthToken < Entity
+    def self.request
+      Razorpay::Request.new('token', Razorpay::AUTH_HOST)
+    end
+
+    def self.get_auth_url(options)
+      validate_auth_url_request(options)
+      uri = URI.join(Razorpay::AUTH_URL, '/authorize')
+
+      query_params = {
+        'response_type' => 'code',
+        'client_id' => options['client_id'], 
+        'redirect_uri' => options['redirect_uri'], 
+        'state' => options['state']
+      }
+
+      options['scopes'].each { |scope| query_params["scope[]"] = scope }
+
+      if options.has_key?('onboarding_signature')
+        query_params['onboarding_signature'] = options['onboarding_signature']
+      end
+      uri.query = URI.encode_www_form(query_params)
+      uri.to_s
+    end
+
+    def self.get_access_token(options)
+      validate_access_token_request(options)
+      r = request
+      r.request :post, "/token", options
+    end
+
+    def self.refresh_token(options)
+        options['grant_type'] = 'refresh_token'
+      validate_refresh_token_request(options)
+      r = request
+      r.request :post, "/token", options
+    end
+
+    def self.revoke_token(options)
+      validate_revoke_token_request(options)
+      r = request
+      r.request :post, "/revoke", options
+    end
+
+    class << self
+        
+      private
+      
+      def validate_auth_url_request(options)
+        Razorpay::PayloadValidator.validate(options, get_validations_for_auth_request_url)
+      end
+
+      def validate_access_token_request(options)
+        Razorpay::PayloadValidator.validate(options, get_validations_for_access_token_request)
+      end
+
+      def validate_refresh_token_request(options)
+        Razorpay::PayloadValidator.validate(options, get_validations_for_refresh_token_request)
+      end
+
+      def validate_revoke_token_request(options)
+        Razorpay::PayloadValidator.validate(options, get_validations_for_revoke_token_request)
+      end
+
+      def get_validations_for_auth_request_url
+        [
+          Razorpay::ValidationConfig.new('client_id', [:id]),
+          Razorpay::ValidationConfig.new('redirect_uri', [:non_empty_string, :url]),
+          Razorpay::ValidationConfig.new('scopes', [:non_null]),
+          Razorpay::ValidationConfig.new('state', [:non_empty_string])
+        ]
+      end
+
+      def get_validations_for_access_token_request
+        [
+          Razorpay::ValidationConfig.new('client_id', [:id]),
+          Razorpay::ValidationConfig.new('client_secret', [:non_empty_string]),
+          Razorpay::ValidationConfig.new('redirect_uri', [:non_empty_string, :url]),
+          Razorpay::ValidationConfig.new('grant_type', [:token_grant])
+        ]
+      end
+
+      def get_validations_for_refresh_token_request
+        [
+          Razorpay::ValidationConfig.new('client_id', [:id]),
+          Razorpay::ValidationConfig.new('client_secret', [:non_empty_string]),
+          Razorpay::ValidationConfig.new('refresh_token', [:non_empty_string]),
+          Razorpay::ValidationConfig.new('grant_type', [:token_grant])
+        ]
+      end
+
+      def get_validations_for_revoke_token_request
+        [
+          Razorpay::ValidationConfig.new('client_id', [:id]),
+          Razorpay::ValidationConfig.new('client_secret', [:non_empty_string]),
+          Razorpay::ValidationConfig.new('token', [:non_empty_string]),
+          Razorpay::ValidationConfig.new('token_type_hint', [:non_empty_string])
+        ]
+      end
+    end
+  end 
+end

data/lib/razorpay/order.rb

@@ -23,7 +23,25 @@ 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 = {})
+      request.patch id, options
+    end
+    
+    def self.fetch_transfer_order(id)
+      # Fetch Transfer for an Order
+      # Docs: https://razorpay.com/docs/api/payments/route/#fetch-transfer-for-an-order
+      request.get "#{id}/?expand[]=transfers&status"
+    end
+
+    def self.view_rto(id)
+      request.post "#{id}/rto_review"
+    end
+    
+    def self.edit_fulfillment(id, options = {})
+      request.post "#{id}/fulfillment", options
     end
   end
 end