razorpay 2.4.0 → 3.2.4

data/documents/customer.md

@@ -0,0 +1,405 @@
+## Customer
+
+```rb
+require "razorpay"
+
+Razorpay.setup('key_id', 'key_secret')
+```
+
+### Create customer
+```rb
+Razorpay::Customer.create({
+  "name": "Gaurav Kumar",
+  "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."
+  }
+})
+```
+
+**Parameters:**
+
+| Name          | Type        | Description                                 |
+|---------------|-------------|---------------------------------------------|
+| 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:**
+```json
+{
+  "id" : "cust_1Aa00000000004",
+  "entity": "customer",
+  "name" : "Gaurav Kumar",
+  "email" : "gaurav.kumar@example.com",
+  "contact" : "9123456780",
+  "gstin": "29XAbbA4369J1PA",
+  "notes":{
+    "notes_key_1":"Tea, Earl Grey, Hot",
+    "notes_key_2":"Tea, Earl Grey… decaf."
+  },
+  "created_at ": 1234567890
+}
+```
+
+-------------------------------------------------------------------------------------------------------
+
+### Edit customer
+```rb
+customerId = "cust_6vRXClWqnLhV14"
+
+Razorpay::Customer.edit(customerId,{
+  "name": "Gaurav Kumar",
+  "email": "Gaurav.Kumar@example.com",
+  "contact": 9000000000
+})
+```
+
+**Parameters:**
+
+| Name          | Type        | Description                                 |
+|---------------|-------------|---------------------------------------------|
+| customerId*          | string      | The id of the customer to be updated  |
+| email        | string      | Email of the customer                       |
+| name        | string      | Name of the customer                        |
+| contact      | string      | Contact number of the customer              |
+
+**Response:**
+```json
+{
+  "id": "cust_1Aa00000000003",
+  "entity": "customer",
+  "name": "Gaurav Kumar",
+  "email": "Gaurav.Kumar@example.com",
+  "contact": "9000000000",
+  "gstin": null,
+  "notes": {
+    "notes_key_1": "Tea, Earl Grey, Hot",
+    "notes_key_2": "Tea, Earl Grey… decaf."
+  },
+  "created_at": 1582033731
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+### Fetch all customer
+```rb
+options = {"count": 2}
+
+Razorpay::Customer.all(options)
+```
+
+**Parameters:**
+
+| Name          | Type        | Description                                 |
+|---------------|-------------|---------------------------------------------|
+| count | integer   | number of payments to fetch (default: 10)        |
+| skip  | integer   | number of payments to be skipped (default: 0)    |
+
+**Response:**
+```json
+{
+  "entity":"collection",
+  "count":1,
+  "items":[
+    {
+      "id":"cust_1Aa00000000001",
+      "entity":"customer",
+      "name":"Gaurav Kumar",
+      "email":"gaurav.kumar@example.com",
+      "contact":"9876543210",
+      "gstin":"29XAbbA4369J1PA",
+      "notes":{
+        "note_key_1":"September",
+        "note_key_2":"Make it so."
+      },
+      "created_at ":1234567890
+    }
+  ]
+}
+```
+
+-------------------------------------------------------------------------------------------------------
+
+### Fetch a customer
+```rb
+customerId = "cust_6vRXClWqnLhV14"
+
+Razorpay::Customer.fetch(customerId)
+```
+
+**Parameters:**
+
+| Name          | Type        | Description                                 |
+|---------------|-------------|---------------------------------------------|
+| customerId*          | string      | The id of the customer to be fetched  |
+
+**Response:**
+```json
+{
+  "id" : "cust_1Aa00000000001",
+  "entity": "customer",
+  "name" : "Saurav Kumar",
+  "email" : "Saurav.kumar@example.com",
+  "contact" : "+919000000000",
+  "gstin":"29XAbbA4369J1PA",
+  "notes" : [],
+  "created_at ": 1234567890
+}
+```
+
+-------------------------------------------------------------------------------------------------------
+
+### Add Bank Account of Customer
+
+```rb
+customerId = "cust_N5mywh91sXB69O"
+
+Razorpay::Customer.add_bank_account(customerId,{
+    "ifsc_code": "UTIB0000194",
+    "account_number": "916010082985661",
+    "beneficiary_name": "Pratheek",
+    "beneficiary_address1": "address 1",
+    "beneficiary_address2": "address 2",
+    "beneficiary_address3": "address 3",
+    "beneficiary_address4": "address 4",
+    "beneficiary_email": "random@email.com",
+    "beneficiary_mobile": "8762489310",
+    "beneficiary_city": "Bangalore",
+    "beneficiary_state": "KA",
+    "beneficiary_country": "IN"
+})
+```
+
+**Parameters:**
+
+| Name                 | Type     | Description                                                                |
+|----------------------|----------|----------------------------------------------------------------------------|
+| customerId*          | string   | Unique identifier of the customer.                                         |
+| account_number       | string   | Customer's bank account number. For example, `0002020000304030434`.        |
+| beneficiary_name     | string   | The name of the beneficiary associated with the bank account.              |
+| beneficiary_address1 | string   | The virtual payment address.                                               |
+| beneficiary_email    | string   | Email address of the beneficiary. For example, `gaurav.kumar@example.com`. |
+| beneficiary_mobile   | integer  | Mobile number of the beneficiary.                                          |
+| beneficiary_city     | string   | The name of the city of the beneficiary.                                   |
+| beneficiary_state    | string   | The state of the beneficiary.                                              |
+| beneficiary_country  | string   | The country of the beneficiary.                                            |
+| beneficiary_pin      | interger | The pin code of the beneficiary's address.                                 |
+| ifsc_code            | string   | The IFSC code of the bank branch associated with the account.              |
+
+**Response:**
+```json
+{
+    "id": "ba_LSZht1Cm7xFTwF",
+    "entity": "bank_account",
+    "ifsc": "ICIC0001207",
+    "bank_name": "ICICI Bank",
+    "name": "Gaurav Kumar",
+    "notes": [],
+    "account_number": "XXXXXXXXXXXXXXX0434"
+}
+```
+
+-------------------------------------------------------------------------------------------------------
+
+### Delete Bank Account of Customer
+
+```rb
+customerId = "cust_N5mywh91sXB69O"
+
+bankAccountId = "ba_N6aM8uo64IzxHu"
+
+Razorpay::Customer.delete_bank_account(customerId, bankAccountId)
+```
+
+**Parameters:**
+
+| Name          | Type      | Description                                                       |
+|---------------|-----------|-------------------------------------------------------------------|
+| customerId*   | string    |  Customer id of the customer whose bank account is to be deleted. |
+| bankAccountId | string    | The bank_id that needs to be deleted.                             |
+
+**Response:**
+```json
+{
+    "id": "ba_Evg09Ll05SIPSD",
+    "ifsc": "ICIC0001207",
+    "bank_name": "ICICI Bank",
+    "name": "Test R4zorpay",
+    "account_number": "XXXXXXXXXXXXXXX0434",
+    "status": "deleted"
+}
+```
+
+-------------------------------------------------------------------------------------------------------
+
+### Eligibility Check API
+
+```rb
+Razorpay::Customer.request_eligibility_check({
+    "inquiry": "affordability",
+    "amount": 500,
+    "currency": "INR",
+    "customer": {
+        "id": "elig_xxxxxxxxxxxxx",
+        "contact": "+919999999999",
+        "ip": "105.106.107.108",
+        "referrer": "https://merchansite.com/example/paybill",
+        "user_agent": "Mozilla/5.0"
+    }
+})
+```
+
+**Parameters:**
+
+| Name        | Type    | Description                                                                                                                                                                                                                    |
+|-------------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| inquiry     | string  | List of methods or instruments on which eligibility check is required. Possible value is `affordability`.                                                                                                                      |
+| amount*     | integer | The amount for which the order was created, in currency subunits. For example, for an amount of ₹295, enter `29500`. The user makes a payment for this amount against the order; hence, eligibility is checked for the amount. |
+| currency*   | string  | A three-letter ISO code for the currency in which you want to accept the payment. Possible value is `INR`.                                                                                                                     |
+| customer*   | object  | Customer details. [here](https://razorpay.com/docs/payments/payment-gateway/affordability/eligibility-check/#eligibility-check-api)                                                                                            |
+| instruments | object  | Payment instruments on which an eligibility check is required. [here](https://razorpay.com/docs/payments/payment-gateway/affordability/eligibility-check/#eligibility-check-api)                                               |
+
+
+**Response:**
+```json
+{
+  "amount": "500000",
+  "customer": {
+    "id": "KkBhM9EC1Y0HTm",
+    "contact": "+919999999999"
+  },
+  "instruments": [
+    {
+      "method": "emi",
+      "issuer": "HDFC",
+      "type": "debit",
+      "eligibility_req_id": "elig_xxxxxxxxxxxxx",
+      "eligibility": {
+        "status": "eligible"
+      }
+    },
+    {
+      "method": "paylater",
+      "provider": "getsimpl",
+      "eligibility_req_id": "elig_xxxxxxxxxxxxx",
+      "eligibility": {
+        "status": "eligible"
+      }
+    },
+    {
+      "method": "paylater",
+      "provider": "icic",
+      "eligibility_req_id": "elig_xxxxxxxxxxxxx",
+      "eligibility": {
+        "status": "eligible"
+      }
+    },
+    {
+      "method": "cardless_emi",
+      "provider": "walnut369",
+      "eligibility_req_id": "elig_xxxxxxxxxxxxx",
+      "eligibility": {
+        "status": "ineligible",
+        "error": {
+          "code": "GATEWAY_ERROR",
+          "description": "The customer has not been approved by the partner.",
+          "source": "business",
+          "step": "inquiry",
+          "reason": "user_not_approved"
+        }
+      }
+    },
+    {
+      "method": "cardless_emi",
+      "provider": "zestmoney",
+      "eligibility_req_id": "elig_xxxxxxxxxxxxx",
+      "eligibility": {
+        "status": "ineligible",
+        "error": {
+          "code": "GATEWAY_ERROR",
+          "description": "The customer has exhausted their credit limit.",
+          "source": "business",
+          "step": "inquiry",
+          "reason": "credit_limit_exhausted"
+        }
+      }
+    },
+    {
+      "method": "paylater",
+      "provider": "lazypay",
+      "eligibility_req_id": "elig_xxxxxxxxxxxxx",
+      "eligibility": {
+        "status": "ineligible",
+        "error": {
+          "code": "GATEWAY_ERROR",
+          "description": "The order amount is less than the minimum transaction amount.",
+          "source": "business",
+          "step": "inquiry",
+          "reason": "min_amt_required"
+        }
+      }
+    }
+  ]
+}
+```
+
+-------------------------------------------------------------------------------------------------------
+
+### Fetch Eligibility by id
+
+```rb
+eligibilityId = "elig_F1cxDoHWD4fkQt"
+Razorpay::Customer.fetch_eligibility(eligibilityId)
+```
+
+**Parameters:**
+
+| Name          | Type        | Description                                                        |
+|---------------|-------------|--------------------------------------------------------------------|
+| eligibilityId | string      | The unique identifier of the eligibility request to be retrieved.  |
+
+**Response:**
+```json
+{
+  "instruments": [
+    {
+      "method": "paylater",
+      "provider": "lazypay",
+      "eligibility_req_id": "elig_xxxxxxxxxxxxx",
+      "eligibility": {
+        "status": "eligible"
+      }
+    },
+    {
+      "method": "paylater",
+      "provider": "getsimpl",
+      "eligibility_req_id": "elig_xxxxxxxxxxxxx",
+      "eligibility": {
+        "status": "ineligible",
+        "error": {
+          "code": "GATEWAY_ERROR",
+          "description": "The customer has exhausted their credit limit",
+          "source": "gateway",
+          "step": "inquiry",
+          "reason": "credit_limit_exhausted"
+        }
+      }
+    }
+  ]
+}
+```
+
+-------------------------------------------------------------------------------------------------------
+
+**PN: * indicates mandatory fields**
+<br>
+<br>
+**For reference click [here](https://razorpay.com/docs/api/customers/)**

data/documents/dispute.md

@@ -0,0 +1,301 @@
+## Document
+
+### Fetch All Disputes
+
+```rb
+Razorpay::Dispute.all()
+```
+
+**Response:**
+```json
+{
+  "entity": "collection",
+  "count": 1,
+  "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
+      }
+    }
+  ]
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+### Fetch a Dispute
+
+```rb
+disputeId = "disp_0000000000000"
+
+Razorpay::Dispute.fetch(disputeId)
+```
+
+**Parameters:**
+
+| Name        | Type   | Description                                      |
+|-------------|--------|--------------------------------------------------|
+| disputeId*  | string | The unique identifier of the dispute.            |
+
+**Response:**
+```json
+{
+  "id": "disp_AHfqOvkldwsbqt",
+  "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
+  }
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+### Accept a Dispute
+
+```rb
+disputeId = "disp_0000000000000"
+
+Razorpay::Dispute.accept(disputeId)
+```
+
+**Parameters:**
+
+| Name        | Type   | Description                                      |
+|-------------|--------|--------------------------------------------------|
+| disputeId*  | string | The unique identifier of the dispute.            |
+
+**Response:**
+```json
+{
+  "id": "disp_AHfqOvkldwsbqt",
+  "entity": "dispute",
+  "payment_id": "pay_EsyWjHrfzb59eR",
+  "amount": 10000,
+  "currency": "INR",
+  "amount_deducted": 10000,
+  "reason_code": "pre_arbitration",
+  "respond_by": 1590604200,
+  "status": "lost",
+  "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
+  }
+}
+```
+-------------------------------------------------------------------------------------------------------
+### Contest a Dispute (Draft)
+
+```rb
+# Use this API sample code for draft
+
+disputeId = "disp_0000000000000"
+
+Razorpay::Dispute.contest(disputeId,{
+  "amount": 5000,
+  "summary": "goods delivered",
+  "shipping_proof": [
+    "doc_EFtmUsbwpXwBH9",
+    "doc_EFtmUsbwpXwBH8"
+  ],
+  "others": [
+    {
+      "type": "receipt_signed_by_customer",
+      "document_ids": [
+        "doc_EFtmUsbwpXwBH1",
+        "doc_EFtmUsbwpXwBH7"
+      ]
+    }
+  ],
+  "action": "draft"
+})
+```
+
+**Parameters:**
+
+| Name            | Type    | Description                                                                                                                                                                     |
+|-----------------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| disputeId*      | string  | The unique identifier of the dispute.                                                                                                                                           |
+| amount          | integer | The amount being contested. If the contest amount is not mentioned, we will assume it to be a full dispute contest.                                                             |
+| summary         | string  | The explanation provided by you for contesting the dispute. It can have a maximum length of 1000 characters.                                                                    |
+| shipping_proof  | array   | List of document ids which serves as proof that the product was shipped to the customer at their provided address. It should show their complete shipping address, if possible. |
+| others          | array   | All keys listed [here](https://razorpay.com/docs/api/disputes/contest) are supported                                                                                            |
+| action          | string  | Possible value is `draft` or `submit`                                                                                                                                           |
+
+**Response:**
+```json
+{
+  "id": "disp_AHfqOvkldwsbqt",
+  "entity": "dispute",
+  "payment_id": "pay_EsyWjHrfzb59eR",
+  "amount": 10000,
+  "currency": "INR",
+  "amount_deducted": 0,
+  "reason_code": "chargeback",
+  "respond_by": 1590604200,
+  "status": "open",
+  "phase": "chargeback",
+  "created_at": 1590059211,
+  "evidence": {
+    "amount": 5000,
+    "summary": "goods delivered",
+    "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": [
+      {
+        "type": "receipt_signed_by_customer",
+        "document_ids": [
+          "doc_EFtmUsbwpXwBH1",
+          "doc_EFtmUsbwpXwBH7"
+        ]
+      }
+    ],
+    "submitted_at": null
+  }
+}
+```
+
+-------------------------------------------------------------------------------------------------------
+### Contest a Dispute (Submit)
+
+```rb
+# Use this API sample code for submit
+
+disputeId = "disp_0000000000000"
+
+Razorpay::Dispute.contest(disputeId, {
+  "billing_proof": [
+    "doc_EFtmUsbwpXwBG9",
+    "doc_EFtmUsbwpXwBG8"
+  ],
+  "action": "submit"
+})
+```
+
+**Parameters:**
+
+| Name            | Type    | Description                                                                          |
+|-----------------|---------|--------------------------------------------------------------------------------------|
+| disputeId*      | string  | The unique identifier of the dispute.                                                |
+| billing_proof   | integer | List of document ids which serves as proof of order confirmation, such as a receipt. |
+| action          | string  | Possible value is `draft` or `submit`                                                |
+
+**Response:**
+```json 
+{
+  "id": "disp_AHfqOvkldwsbqt",
+  "entity": "dispute",
+  "payment_id": "pay_EsyWjHrfzb59eR",
+  "amount": 10000,
+  "currency": "INR",
+  "amount_deducted": 0,
+  "reason_code": "chargeback",
+  "respond_by": 1590604200,
+  "status": "under_review",
+  "phase": "chargeback",
+  "created_at": 1590059211,
+  "evidence": {
+    "amount": 5000,
+    "summary": "goods delivered",
+    "shipping_proof": [
+      "doc_EFtmUsbwpXwBH9",
+      "doc_EFtmUsbwpXwBH8"
+    ],
+    "billing_proof": [
+      "doc_EFtmUsbwpXwBG9",
+      "doc_EFtmUsbwpXwBG8"
+    ],
+    "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": [
+      {
+        "type": "receipt_signed_by_customer",
+        "document_ids": [
+          "doc_EFtmUsbwpXwBH1",
+          "doc_EFtmUsbwpXwBH7"
+        ]
+      }
+    ],
+    "submitted_at": 1590603200
+  }
+}
+```
+-------------------------------------------------------------------------------------------------------
+**PN: * indicates mandatory fields**
+<br>
+<br>
+**For reference click [here](https://razorpay.com/docs/api/documents)**