razorpay 3.2.2 → 3.2.3

data/documents/order.md

@@ -275,6 +275,77 @@ Razorpay::Order.edit(orderId,para_attr)
 -------------------------------------------------------------------------------------------------------
 
 
+### View RTO/Risk Reasons
+
+```go
+orderId = "order_XXXXXXXXXXXXX1"
+
+Razorpay::Order.view_rto(orderId)
+```
+**Parameters**
+
+| Name     | Type   | Description                                                              |
+|----------|--------|-------------------------------------                                     |
+| orderId* | string | The unique identifier of an order to access the fulfillment information. |
+
+**Response:**
+```json
+{
+  "risk_tier": "high",
+  "rto_reasons": [
+    {
+      "reason": "short_shipping_address",
+      "description": "Short shipping address",
+      "bucket": "address"
+    },
+    {
+      "reason": "address_pincode_state_mismatch",
+      "description": "Incorrect pincode state entered",
+      "bucket": "address"
+    }
+  ]
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+### Update the Fulfillment Details
+
+```rb
+order_id = "order_XXXXXXXXXXXXX1"
+
+para_attr = {
+  "payment_method": "upi",
+  "shipping": {
+    "waybill": "123456789",
+    "status": "rto",
+    "provider": "Bluedart"
+  }
+}
+
+Razorpay::Order.edit_fulfillment(order_id, para_attr)
+```
+**Parameters**
+
+| Name           | Type   | Description                                                                                                                                                                             |
+|----------------|--------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| orderId*       | string | The unique identifier of an order to access the fulfillment information.                                                                                                                |
+| payment_method | string | Payment Method opted by the customer to complete the payment. Possible values is `upi`, `card`, `wallet`, `netbanking`, `cod`, `emi`, `cardless_emi`, `paylater`, `recurring`, `other`. |
+| shipping       | object | Contains the shipping data. [here](https://razorpay.com/docs/payments/magic-checkout/rto-intelligence/#step-3-update-the-fulfillment-details) are supported                             |
+
+**Response:**
+```json
+{
+  "entity": "order.fulfillment",
+  "order_id": "EKwxwAgItXXXX",
+  "payment_method": "upi",
+  "shipping": {
+    "waybill": "123456789",
+    "status": "rto",
+    "provider": "Bluedart"
+  }
+}
+```
+-------------------------------------------------------------------------------------------------------
 **PN: * indicates mandatory fields**
 <br>
 <br>

data/documents/payment.md

@@ -863,6 +863,259 @@ Razorpay::Iin.fetch(tokenIin);
 }
 ```
 -------------------------------------------------------------------------------------------------------
+-------------------------------------------------------------------------------------------------------
+
+### Fetch a Payment (With Expanded EMI Details)
+
+```rb
+Razorpay::Payment.expand_details("pay_XXXXXXXXXXXXXX",{"expand[]": "emi"})
+```
+
+**Parameters:**
+
+| Name        | Type    | Description                                                      |
+|-------------|---------|------------------------------------------------------------------|
+| paymentId*  | integer | Unique identifier of the payment                                 |
+| expand[]    | string  | Use to expand the `emi` details when the payment method is emi.  |
+
+**Response:** <br>
+
+```json
+{
+  "id": "pay_DG4ZdRK8ZnXC3k",
+  "entity": "payment",
+  "amount": 200000,
+  "currency": "INR",
+  "status": "authorized",
+  "order_id": null,
+  "invoice_id": null,
+  "international": false,
+  "method": "emi",
+  "amount_refunded": 0,
+  "refund_status": null,
+  "captured": false,
+  "description": null,
+  "card_id": "card_DG4ZdUO3xABb20",
+  "bank": "ICIC",
+  "wallet": null,
+  "vpa": null,
+  "email": "gaurav@example.com",
+  "contact": "+919972000005",
+  "notes": [],
+  "fee": null,
+  "tax": null,
+  "error_code": null,
+  "error_description": null,
+  "error_source": null,
+  "error_step": null,
+  "error_reason": null,
+  "emi": {
+    "issuer": "ICIC",
+    "rate": 1300,
+    "duration": 6
+  },
+  "acquirer_data": {
+    "auth_code": "828553"
+  },
+  "created_at": 1568026077
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+### Fetch a Payment (With Expanded Card Details)
+
+```rb
+Razorpay::Payment.expand_details("pay_XXXXXXXXXXXXXX", {"expand[]": "card"})
+```
+
+**Parameters:**
+
+| Name        | Type    | Description                                                         |
+|-------------|---------|---------------------------------------------------------------------|
+| paymentId*  | integer | Unique identifier of the payment                                    |
+| expand[]    | string  | Use to expand the card details when the payment method is `card`.   |
+
+**Response:** <br>
+
+```json
+{
+  "id": "pay_H9oR0gLCaVlV6m",
+  "entity": "payment",
+  "amount": 100,
+  "currency": "INR",
+  "status": "failed",
+  "order_id": "order_H9o58N6qmLYQKC",
+  "invoice_id": null,
+  "terminal_id": "term_G5kJnYM9GhhLYT",
+  "international": false,
+  "method": "card",
+  "amount_refunded": 0,
+  "refund_status": null,
+  "captured": false,
+  "description": null,
+  "card_id": "card_H9oR0ocen1cmZq",
+  "card": {
+    "id": "card_H9oR0ocen1cmZq",
+    "entity": "card",
+    "name": "Gaurav",
+    "last4": "1213",
+    "network": "RuPay",
+    "type": "credit",
+    "issuer": "UTIB",
+    "international": false,
+    "emi": false,
+    "sub_type": "business"
+  },
+  "bank": null,
+  "wallet": null,
+  "vpa": null,
+  "email": "gaurav.kumar@example.com",
+  "contact": "+919000090000",
+  "notes": {
+    "email": "gaurav.kumar@example.com",
+    "phone": "09000090000"
+  },
+  "fee": null,
+  "tax": null,
+  "error_code": "BAD_REQUEST_ERROR",
+  "error_description": "Card issuer is invalid",
+  "error_source": "customer",
+  "error_step": "payment_authentication",
+  "error_reason": "incorrect_card_details",
+  "acquirer_data": {
+    "auth_code": null,
+    "authentication_reference_number": "100222021120200000000742753928"
+  },
+  "created_at": 1620807547
+}
+```
+
+-------------------------------------------------------------------------------------------------------
+
+### Fetch a Payment (With Expanded Offers Details)
+
+```rb
+Razorpay::Payment.expand_details("pay_XXXXXXXXXXXXXX", {"expand[]": "offers"})
+```
+
+**Parameters:**
+
+| Name        | Type    | Description                                                    |
+|-------------|---------|----------------------------------------------------------------|
+| paymentId*  | integer | Unique identifier of the payment                               |
+| expand[]    | string  | Use to expand the offers applied to a payment.                 |
+
+**Response:** <br>
+
+```json
+{
+  "id": "pay_G8VaL2Z68LRtDs",
+  "entity": "payment",
+  "amount": 900,
+  "currency": "INR",
+  "status": "captured",
+  "order_id": "order_G8VXfKDWDEOHHd",
+  "invoice_id": null,
+  "international": false,
+  "method": "netbanking",
+  "amount_refunded": 0,
+  "refund_status": null,
+  "captured": true,
+  "offers": {
+    "entity": "collection",
+    "count": 1,
+    "items": [
+      {
+        "id": "offer_G8VXOp0qNuEXzh"
+      }
+    ]
+  },
+  "description": "Purchase Shoes",
+  "card_id": null,
+  "bank": "KKBK",
+  "wallet": null,
+  "vpa": null,
+  "email": "gaurav.kumar@example.com",
+  "contact": "+919000090000",
+  "customer_id": "cust_DitrYCFtCIokBO",
+  "notes": [],
+  "fee": 22,
+  "tax": 4,
+  "error_code": null,
+  "error_description": null,
+  "error_source": null,
+  "error_step": null,
+  "error_reason": null,
+  "acquirer_data": {
+    "bank_transaction_id": "0125836177",
+    "authentication_reference_number": "100222021120200000000742753928"
+  },
+  "created_at": 1606985740
+}
+```
+
+-------------------------------------------------------------------------------------------------------
+
+### Fetch a Payment (With Expanded UPI Details)
+
+```rb
+Razorpay::Payment.expand_details("pay_XXXXXXXXXXXXXX", {"expand[]": "upi"})
+```
+
+**Parameters:**
+
+| Name        | Type    | Description                                                   |
+|-------------|---------|---------------------------------------------------------------|
+| paymentId*  | integer | Unique identifier of the payment                              |
+| expand[]    | string  | Use to expand the UPI details when the payment method is upi. |
+
+**Response:** <br>
+
+```json
+{
+  "id": "pay_DG4ZdRK8ZnXC3k",
+  "entity": "payment",
+  "amount": 100,
+  "currency": "INR",
+  "status": "captured",
+  "order_id": "order_GjCr5oKh4AVC51",
+  "invoice_id": null,
+  "international": false,
+  "method": "upi",
+  "amount_refunded": 0,
+  "refund_status": null,
+  "captured": true,
+  "description": "Payment for Adidas shoes",
+  "card_id": null,
+  "bank": null,
+  "wallet": null,
+  "vpa": "gaurav.kumar@upi",
+  "email": "gaurav.kumar@example.com",
+  "contact": "9000090000",
+  "customer_id": "cust_K6fNE0WJZWGqtN",
+  "token_id": "token_KOdY$DBYQOv08n",
+  "notes": [],
+  "fee": 1,
+  "tax": 0,
+  "error_code": null,
+  "error_description": null,
+  "error_source": null,
+  "error_step": null,
+  "error_reason": null,
+  "acquirer_data": {
+    "rrn": "303107535132"
+  },
+  "created_at": 1605871409,
+  "upi": {
+    "payer_account_type": "credit_card",
+    "vpa": "gaurav.kumar@upi",
+    "flow": "in_app" // appears only for Turbo UPI Payments.
+  }
+}
+```
+
+-------------------------------------------------------------------------------------------------------
+
 **PN: * indicates mandatory fields**
 <br>
 <br>

data/documents/transfers.md

@@ -775,6 +775,46 @@ Razorpay::Transfer.fetch(transferId).edit(para_attr)
 
 -------------------------------------------------------------------------------------------------------
 
+### Fetch Reversals for a Transfer
+```rb
+transferId = "trf_JhemwjNekar9Za"
+Razorpay::Transfer.reversals(transferId)
+```
+
+**Parameters:**
+
+| Name          | Type        | Description                                 |
+|---------------|-------------|---------------------------------------------|
+| transferId*   | string      | The id of the transfer to be fetched        |
+
+**Response:**
+```json
+{
+   "entity":"collection",
+   "count":1,
+   "items":[
+      {
+         "id":"rvrsl_Lt09xvyzskI7KZ",
+         "entity":"reversal",
+         "transfer_id":"trf_Lt048W7cgLdo1u",
+         "amount":50000,
+         "fee":0,
+         "tax":0,
+         "currency":"INR",
+         "notes":[
+            
+         ],
+         "initiator_id":"Ghri4beeOuMTAb",
+         "customer_refund_id":null,
+         "utr":null,
+         "created_at":1684822489
+      }
+   ]
+}
+```
+
+-------------------------------------------------------------------------------------------------------
+
 **PN: * indicates mandatory fields**
 <br>
 <br>

data/lib/razorpay/constants.rb

@@ -2,7 +2,7 @@
 module Razorpay
   BASE_URI = 'https://api.razorpay.com'.freeze
   TEST_URL = 'https://api.razorpay.com/'.freeze
-  VERSION  = '3.2.2'.freeze
+  VERSION  = '3.2.3'.freeze
   AUTH_URL = 'https://auth.razorpay.com'.freeze
   API_HOST = 'API'.freeze
   AUTH_HOST    = 'AUTH'.freeze

data/lib/razorpay/customer.rb

@@ -38,5 +38,21 @@ module Razorpay
     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/order.rb

@@ -35,5 +35,13 @@ module Razorpay
       # 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

data/lib/razorpay/payment.rb

@@ -112,5 +112,9 @@ module Razorpay
     def self.validate_vpa(data={})
       request.post "validate/vpa" , data
     end
+
+    def self.expand_details(id, options={})
+      request.get "#{id}", options
+    end
   end
 end

data/lib/razorpay/transfer.rb

@@ -31,5 +31,9 @@ module Razorpay
     def self.fetch_settlements
       request.get "?expand[]=recipient_settlement"
     end
+
+    def self.reversals(id)
+      request.get "#{id}/reversals"
+    end  
   end
 end

data/lib/razorpay.rb

@@ -26,6 +26,8 @@ require 'razorpay/token'
 require 'razorpay/product'
 require 'razorpay/stakeholder'
 require 'razorpay/account'
+require 'razorpay/document'
+require 'razorpay/dispute'
 require 'razorpay/oauth_token'
 
 # Base Razorpay module

data/test/fixtures/dispute_collection.json

@@ -0,0 +1,67 @@
+{
+    "entity": "collection",
+    "count": 2,
+    "items": [
+      {
+        "id": "disp_Esz7KAitoYM7PJ",
+        "entity": "dispute",
+        "payment_id": "pay_EsyWjHrfzb59eR",
+        "amount": 10000,
+        "currency": "INR",
+        "amount_deducted": 0,
+        "reason_code": "pre_arbitration",
+        "respond_by": 1590604200,
+        "status": "open",
+        "phase": "pre_arbitration",
+        "created_at": 1590059211,
+        "evidence": {
+          "amount": 10000,
+          "summary": null,
+          "shipping_proof": null,
+          "billing_proof": null,
+          "cancellation_proof": null,
+          "customer_communication": null,
+          "proof_of_service": null,
+          "explanation_letter": null,
+          "refund_confirmation": null,
+          "access_activity_log": null,
+          "refund_cancellation_policy": null,
+          "term_and_conditions": null,
+          "others": null,
+          "submitted_at": null
+        }
+      },
+      {
+        "id": "disp_Esyvk3kZj0isXk",
+        "entity": "dispute",
+        "payment_id": "pay_EsyWjHrfzb59eR",
+        "amount": 5000,
+        "currency": "INR",
+        "amount_deducted": 0,
+        "reason_code": "warning_bulletin_or_exception_file",
+        "respond_by": 1590604200,
+        "status": "won",
+        "phase": "chargeback",
+        "created_at": 1590058554,
+        "evidence": {
+          "amount": 5000,
+          "summary": null,
+          "shipping_proof": [
+            "doc_EFtmUsbwpXwBH9",
+            "doc_EFtmUsbwpXwBH8"
+          ],
+          "billing_proof": null,
+          "cancellation_proof": null,
+          "customer_communication": null,
+          "proof_of_service": null,
+          "explanation_letter": null,
+          "refund_confirmation": null,
+          "access_activity_log": null,
+          "refund_cancellation_policy": null,
+          "term_and_conditions": null,
+          "others": null,
+          "submitted_at": 1590604100
+        }
+      }
+    ]
+  }

data/test/fixtures/dispute_error.json

@@ -0,0 +1,10 @@
+{
+    "error": {
+        "code": "BAD_REQUEST_ERROR",
+        "description": "The id provided does not exist",
+        "source": "business",
+        "step": "payment_initiation",
+        "reason": "input_validation_failed",
+        "metadata": {}
+    }
+}

data/test/fixtures/document_error.json

@@ -0,0 +1,10 @@
+{
+    "error": {
+        "code": "BAD_REQUEST_ERROR",
+        "description": "Invalid file id provided or merchant is unauthorized to access the fileId(s) provided",
+        "source": "NA",
+        "step": "NA",
+        "reason": "NA",
+        "metadata": {}
+    }
+}

data/test/fixtures/error_customer.json

@@ -0,0 +1,10 @@
+{
+    "error": {
+        "code": "BAD_REQUEST_ERROR",
+        "description": "The id provided does not exist",
+        "source": "business",
+        "step": "payment_initiation",
+        "reason": "input_validation_failed",
+        "metadata": {}
+    }
+}

data/test/fixtures/error_eligibility.json

@@ -0,0 +1,10 @@
+{
+    "error": {
+        "code": "BAD_REQUEST_ERROR",
+        "description": "The eligibility  id does not exist.",
+        "source": "NA",
+        "step": "NA",
+        "reason": "NA",
+        "metadata": {}
+    }
+}

data/test/fixtures/error_eligibility_check.json

@@ -0,0 +1,10 @@
+{
+    "error": {
+        "code": "BAD_REQUEST_ERROR",
+        "description": "Amount is required.",
+        "source": "NA",
+        "step": "NA",
+        "reason": "NA",
+        "metadata": {}
+    }
+}

data/test/fixtures/fake_bank_account.json

@@ -0,0 +1,9 @@
+{
+    "id": "ba_LSZht1Cm7xFTwF",
+    "entity": "bank_account",
+    "ifsc": "ICIC0001207",
+    "bank_name": "ICICI Bank",
+    "name": "Gaurav Kumar",
+    "notes": [],
+    "account_number": "XXXXXXXXXXXXXXX0434"
+}

data/test/fixtures/fake_dispute.json

@@ -0,0 +1,29 @@
+{
+    "id": "disp_XXXXXXXXXXXXX",
+    "entity": "dispute",
+    "payment_id": "pay_EsyWjHrfzb59eR",
+    "amount": 10000,
+    "currency": "INR",
+    "amount_deducted": 0,
+    "reason_code": "pre_arbitration",
+    "respond_by": 1590604200,
+    "status": "open",
+    "phase": "pre_arbitration",
+    "created_at": 1590059211,
+    "evidence": {
+      "amount": 10000,
+      "summary": "goods delivered",
+      "shipping_proof": null,
+      "billing_proof": null,
+      "cancellation_proof": null,
+      "customer_communication": null,
+      "proof_of_service": null,
+      "explanation_letter": null,
+      "refund_confirmation": null,
+      "access_activity_log": null,
+      "refund_cancellation_policy": null,
+      "term_and_conditions": null,
+      "others": null,
+      "submitted_at": null
+    }
+  }