razorruby 3.0.1

data/documents/paymentVerification.md

@@ -0,0 +1,79 @@
+## payment verification
+
+```rb
+require "razorpay"
+Razorpay.setup('key_id', 'key_secret')
+```
+
+### Verify payment verification
+
+```rb
+payment_response = {
+        razorpay_order_id: 'order_IEIaMR65cu6nz3',
+        razorpay_payment_id: 'pay_IH4NVgf4Dreq1l',
+        razorpay_signature: '0d4e745a1838664ad6c9c9902212a32d627d68e917290b0ad5f08ff4561bc50f'
+      }
+Razorpay::Utility.verify_payment_signature(payment_response)
+```
+
+**Parameters:**
+
+
+| Name  | Type      | Description                                      |
+|-------|-----------|--------------------------------------------------|
+| razorpay_order_id*  | string | The id of the order to be fetched  |
+| razorpay_payment_id*    | string | The id of the payment to be fetched |
+| razorpay_signature* | string   | Signature returned by the Checkout. This is used to verify the payment. |
+
+-------------------------------------------------------------------------------------------------------
+### Verify subscription verification
+
+```rb
+payment_response = {
+        razorpay_order_id: 'pay_IDZNwZZFtnjyym',
+        razorpay_payment_id: 'sub_ID6MOhgkcoHj9I',
+        razorpay_signature: '601f383334975c714c91a7d97dd723eb56520318355863dcf3821c0d07a17693'
+      }
+Razorpay::Utility.verify_payment_signature(payment_response)
+```
+
+**Parameters:**
+
+
+| Name  | Type      | Description                                      |
+|-------|-----------|--------------------------------------------------|
+| razorpay_order_id*  | string | The id of the subscription to be fetched  |
+| razorpay_payment_id*    | string | The id of the payment to be fetched |
+| razorpay_signature* | string   | Signature returned by the Checkout. This is used to verify the payment. |
+
+-------------------------------------------------------------------------------------------------------
+### Verify paymentlink verification
+
+```rb
+payment_response = {
+  payment_link_id: 'plink_IH3cNucfVEgV68',
+  payment_link_reference_id: 'TSsd1989',
+  payment_link_status: 'paid',
+  razorpay_payment_id: 'pay_IH3d0ara9bSsjQ',
+  razorpay_signature: 'b8a6acda585c9b74e9da393c7354c7e685e37e69d30ae654730f042e674e0283'
+}
+Razorpay::Utility.verify_payment_link_signature(payment_response)
+```
+
+**Parameters:**
+
+
+| Name  | Type      | Description                                      |
+|-------|-----------|--------------------------------------------------|
+| razorpayPaymentlinkId*  | string | The id of the paymentlink to be fetched  |
+| razorpayPaymentId*  | string | The id of the payment to be fetched  |
+| razorpayPaymentLinkReferenceId*  | string |  A reference number tagged to a Payment Link |
+| razorpayPaymentLinkStatus*  | string | Current status of the link  |
+| signature* | string   | Signature returned by the Checkout. This is used to verify the payment. |
+| secret* | string   | your api secret as secret |
+
+-------------------------------------------------------------------------------------------------------
+
+**PN: * indicates mandatory fields**
+<br>
+<br>

data/documents/plan.md

@@ -0,0 +1,184 @@
+## Plans
+
+```rb
+require "razorpay"
+Razorpay.setup('key_id', 'key_secret')
+```
+
+### Create plan
+
+```rb
+para_attr = {
+  "period": "weekly",
+  "interval": 1,
+  "item": {
+    "name": "Test plan - Weekly",
+    "amount": 69900,
+    "currency": "INR",
+    "description": "Description for the test plan"
+  },
+  "notes": {
+    "notes_key_1": "Tea, Earl Grey, Hot",
+    "notes_key_2": "Tea, Earl Grey… decaf."
+  }
+}
+
+Razorpay::Plan.create(para_attr)
+```
+
+**Parameters:**
+
+| Name            | Type    | Description                                                                  |
+|-----------------|---------|------------------------------------------------------------------------------|
+| period*          | string | Used together with `interval` to define how often the customer should be charged.Possible values:<br>1.`daily` <br>2.`weekly`<br>3.`monthly` <br>4.`yearly`  |
+| interval*          | string | Used together with `period` to define how often the customer should be charged  |
+| items*          | object | Details of the plan. For more details please refer [here](https://razorpay.com/docs/api/subscriptions/#create-a-plan) |
+| notes          | object | Notes you can enter for the contact for future reference.   |
+
+**Response:**
+```json
+{
+  "id":"plan_00000000000001",
+  "entity":"plan",
+  "interval":1,
+  "period":"weekly",
+  "item":{
+    "id":"item_00000000000001",
+    "active":true,
+    "name":"Test plan - Weekly",
+    "description":"Description for the test plan - Weekly",
+    "amount":69900,
+    "unit_amount":69900,
+    "currency":"INR",
+    "type":"plan",
+    "unit":null,
+    "tax_inclusive":false,
+    "hsn_code":null,
+    "sac_code":null,
+    "tax_rate":null,
+    "tax_id":null,
+    "tax_group_id":null,
+    "created_at":1580219935,
+    "updated_at":1580219935
+  },
+  "notes":{
+    "notes_key_1":"Tea, Earl Grey, Hot",
+    "notes_key_2":"Tea, Earl Grey… decaf."
+  },
+  "created_at":1580219935
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+### Fetch all plans
+
+```rb
+options = {"count": 2}
+
+Razorpay::Plan.all(options)
+```
+
+**Parameters:**
+
+| Name  | Type      | Description                                      |
+|-------|-----------|--------------------------------------------------|
+| from  | timestamp | timestamp after which the payments were created  |
+| to    | timestamp | timestamp before which the payments were created |
+| 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": "plan_00000000000001",
+      "entity": "plan",
+      "interval": 1,
+      "period": "weekly",
+      "item": {
+        "id": "item_00000000000001",
+        "active": true,
+        "name": "Test plan - Weekly",
+        "description": "Description for the test plan - Weekly",
+        "amount": 69900,
+        "unit_amount": 69900,
+        "currency": "INR",
+        "type": "plan",
+        "unit": null,
+        "tax_inclusive": false,
+        "hsn_code": null,
+        "sac_code": null,
+        "tax_rate": null,
+        "tax_id": null,
+        "tax_group_id": null,
+        "created_at": 1580220492,
+        "updated_at": 1580220492
+      },
+      "notes": {
+        "notes_key_1": "Tea, Earl Grey, Hot",
+        "notes_key_2": "Tea, Earl Grey… decaf."
+      },
+      "created_at": 1580220492
+    }
+  ]
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+### Fetch particular plan
+
+```rb
+
+planId = "plan_00000000000001"
+
+Razorpay::Plan.fetch(planId)
+```
+
+**Parameters:**
+
+| Name  | Type      | Description                                      |
+|-------|-----------|--------------------------------------------------|
+| planId*  | string | The id of the plan to be fetched  |
+
+**Response:**
+```json
+{
+  "id":"plan_00000000000001",
+  "entity":"plan",
+  "interval":1,
+  "period":"weekly",
+  "item":{
+    "id":"item_00000000000001",
+    "active":true,
+    "name":"Test plan - Weekly",
+    "description":"Description for the test plan - Weekly",
+    "amount":69900,
+    "unit_amount":69900,
+    "currency":"INR",
+    "type":"plan",
+    "unit":null,
+    "tax_inclusive":false,
+    "hsn_code":null,
+    "sac_code":null,
+    "tax_rate":null,
+    "tax_id":null,
+    "tax_group_id":null,
+    "created_at":1580220492,
+    "updated_at":1580220492
+  },
+  "notes":{
+    "notes_key_1":"Tea, Earl Grey, Hot",
+    "notes_key_2":"Tea, Earl Grey… decaf."
+  },
+  "created_at":1580220492
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+**PN: * indicates mandatory fields**
+<br>
+<br>
+**For reference click [here](https://razorpay.com/docs/api/subscriptions/#plans)**

data/documents/qrcode.md

@@ -0,0 +1,439 @@
+## Qr Codes
+
+```rb
+require "razorpay"
+
+Razorpay.setup('key_id', 'key_secret')
+```
+
+### Create Qr code
+
+```rb
+para_attr = {
+  "type": "upi_qr",
+  "name": "Store_1",
+  "usage": "single_use",
+  "fixed_amount": true,
+  "payment_amount": 300,
+  "description": "For Store 1",
+  "customer_id": "cust_HKsR5se84c5LTO",
+  "close_by": 1681615838,
+  "notes": {
+    "purpose": "Test UPI QR code notes"
+  }
+}
+Razorpay::QrCode.create(para_attr)
+```
+
+**Parameters:**
+
+| Name            | Type    | Description                                                                  |
+|-----------------|---------|------------------------------------------------------------------------------|
+| type*          | string | The type of QR code i.e, `upi_qr`/`bharat_qr`                                  |
+| name          | string | Label entered to identify the QR code.                              |
+| usage*          | string | Indicates if the QR code should be allowed to accept single payment or multiple payments i.e, `single_use`/`multiple_use`     |
+| fixed_amount          | boolean | Indicates if the QR should accept payments of specific amounts or any amount. |
+| payment_amount(* mandatory if fixed_amount is true)          | integer | Indicates if the QR should accept payments of specific amounts or any amount. |
+| customer_id          | string | Unique identifier of the customer the QR code is linked with |
+| description          | string | A brief description about the QR code. |
+| close_by          | integer | UNIX timestamp at which the QR code is scheduled to be automatically closed. The time must be at least 15 minutes after the current time.  |
+| notes          | object | Key-value pair that can be used to store additional information about the QR code. Maximum 15 key-value pairs, 256 characters (maximum) each. |
+
+**Response:**
+```json
+{
+  "id": "qr_HMsVL8HOpbMcjU",
+  "entity": "qr_code",
+  "created_at": 1623660301,
+  "name": "Store_1",
+  "usage": "single_use",
+  "type": "upi_qr",
+  "image_url": "https://rzp.io/i/BWcUVrLp",
+  "payment_amount": 300,
+  "status": "active",
+  "description": "For Store 1",
+  "fixed_amount": true,
+  "payments_amount_received": 0,
+  "payments_count_received": 0,
+  "notes": {
+    "purpose": "Test UPI QR code notes"
+  },
+  "customer_id": "cust_HKsR5se84c5LTO",
+  "close_by": 1681615838
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+### Create Qr code with GST
+
+```rb
+para_attr = {
+  "type": "upi_qr",
+  "name": "Store_1",
+  "usage": "single_use",
+  "fixed_amount": true,
+  "payment_amount": 300,
+  "description": "For Store 1",
+  "customer_id": "cust_HKsR5se84c5LTO",
+  "close_by": 1681615838,
+  "notes": {
+    "purpose": "Test UPI QR code notes"
+  },
+  "tax_invoice": {
+    "number": "INV001",
+    "date": 1589994898,
+    "customer_name": "Gaurav Kumar",
+    "business_gstin": "06AABCU9605R1ZR",
+    "gst_amount": 4000,
+    "cess_amount": 0,
+    "supply_type": "interstate"
+  }
+}
+
+Razorpay::QrCode.create(para_attr)
+```
+
+**Parameters:**
+
+| Name            | Type    | Description                                                                  |
+|-----------------|---------|------------------------------------------------------------------------------|
+| type*          | string | The type of QR code i.e, `upi_qr`/`bharat_qr`                                  |
+| name          | string | Label entered to identify the QR code.                              |
+| usage*          | string | Indicates if the QR code should be allowed to accept single payment or multiple payments i.e, `single_use`/`multiple_use`     |
+| fixed_amount          | boolean | Indicates if the QR should accept payments of specific amounts or any amount. |
+| payment_amount(* mandatory if fixed_amount is true)          | integer | Indicates if the QR should accept payments of specific amounts or any amount. |
+| customer_id          | string | Unique identifier of the customer the QR code is linked with |
+| description          | string | A brief description about the QR code. |
+| close_by          | integer | UNIX timestamp at which the QR code is scheduled to be automatically closed. The time must be at least 15 minutes after the current time.  |
+| notes          | object  | Key-value pair that can be used to store additional information about the QR code. Maximum 15 key-value pairs, 256 characters (maximum) each. |
+| tax_invoice          | object  | This block contains information about the invoices. If not provided, the transaction will default to non-GST compliant UPI flow. |
+
+**Response:**
+```json
+{
+  "id": "qr_HMsVL8HOpbMcjU",
+  "entity": "qr_code",
+  "created_at": 1623660301,
+  "name": "Store_1",
+  "usage": "single_use",
+  "type": "upi_qr",
+  "image_url": "https://rzp.io/i/BWcUVrLp",
+  "payment_amount": 300,
+  "status": "active",
+  "description": "For Store 1",
+  "fixed_amount": true,
+  "payments_amount_received": 0,
+  "payments_count_received": 0,
+  "notes": {
+    "purpose": "Test UPI QR code notes"
+  },
+  "customer_id": "cust_HKsR5se84c5LTO",
+  "close_by": 1681615838,
+  "tax_invoice": {
+    "number": "INV001",
+    "date": 1589994898,
+    "customer_name": "Gaurav Kumar",
+    "business_gstin": "06AABCU9605R1ZR",
+    "gst_amount": 4000,
+    "cess_amount": 0,
+    "supply_type": "interstate"
+  }
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+### Fetch all Qr code
+
+```rb
+para_attr = {
+  "count": 1  
+}
+
+Razorpay::QrCode.all(para_attr)
+```
+
+**Parameters:**
+
+| Name            | Type    | Description                                                                  |
+|-----------------|---------|------------------------------------------------------------------------------|
+| from  | timestamp | timestamp after which the payments were created  |
+| to    | timestamp | timestamp before which the payments were created |
+| 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": "qr_HO2jGkWReVBMNu",
+      "entity": "qr_code",
+      "created_at": 1623914648,
+      "name": "Store_1",
+      "usage": "single_use",
+      "type": "upi_qr",
+      "image_url": "https://rzp.io/i/w2CEwYmkAu",
+      "payment_amount": 300,
+      "status": "active",
+      "description": "For Store 1",
+      "fixed_amount": true,
+      "payments_amount_received": 0,
+      "payments_count_received": 0,
+      "notes": {
+        "purpose": "Test UPI QR code notes"
+      },
+      "customer_id": "cust_HKsR5se84c5LTO",
+      "close_by": 1681615838,
+      "closed_at": null,
+      "close_reason": null
+    }
+  ]
+}
+```
+
+-------------------------------------------------------------------------------------------------------
+
+### Fetch a Qr code
+
+```rb
+
+qrCodeId = "qr_HO2r1MDprYtWRT"
+
+Razorpay::QrCode.fetch(qrCodeId)
+```
+
+**Parameters:**
+
+| Name            | Type    | Description                                                                  |
+|-----------------|---------|------------------------------------------------------------------------------|
+| qrCodeId*  | string | The id of the qr code to be fetched  |
+
+**Response:**
+```json
+{
+  "id": "qr_HO2r1MDprYtWRT",
+  "entity": "qr_code",
+  "created_at": 1623915088,
+  "name": "Store_1",
+  "usage": "single_use",
+  "type": "upi_qr",
+  "image_url": "https://rzp.io/i/oCswTOcCo",
+  "payment_amount": 300,
+  "status": "active",
+  "description": "For Store 1",
+  "fixed_amount": true,
+  "payments_amount_received": 0,
+  "payments_count_received": 0,
+  "notes": {
+    "purpose": "Test UPI QR code notes"
+  },
+  "customer_id": "cust_HKsR5se84c5LTO",
+  "close_by": 1681615838,
+  "closed_at": null,
+  "close_reason": null
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+### Fetch a Qr code for customer id
+
+```rb
+para_attr = {"customer_id":customerId}
+
+Razorpay::QrCode.all(para_attr)
+```
+
+**Parameters:**
+
+| Name            | Type    | Description                                                                  |
+|-----------------|---------|------------------------------------------------------------------------------|
+| customerId*  | string | The id of the customer to which qr code need to be fetched  |
+
+**Response:**
+```json
+{
+  "entity": "collection",
+  "count": 1,
+  "items": [
+    {
+      "id": "qr_HMsqRoeVwKbwAF",
+      "entity": "qr_code",
+      "created_at": 1623661499,
+      "name": "Fresh Groceries",
+      "usage": "multiple_use",
+      "type": "upi_qr",
+      "image_url": "https://rzp.io/i/eI9XD54Q",
+      "payment_amount": null,
+      "status": "active",
+      "description": "Buy fresh groceries",
+      "fixed_amount": false,
+      "payments_amount_received": 1000,
+      "payments_count_received": 1,
+      "notes": [],
+      "customer_id": "cust_HKsR5se84c5LTO",
+      "close_by": 1624472999,
+      "close_reason": "paid",
+      "tax_invoice": null
+    }
+  ]
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+### Fetch a Qr code for payment id
+
+```rb
+
+para_attr = {"payment_id":paymentId}
+
+Razorpay::QrCode.all(para_attr)
+```
+
+**Parameters:**
+
+| Name            | Type    | Description                                                                  |
+|-----------------|---------|------------------------------------------------------------------------------|
+| paymentId*  | string | The id of the payment to which qr code need to be fetched  |
+
+**Response:**
+```json
+{
+  "entity": "collection",
+  "count": 1,
+  "items": [
+    {
+      "id": "qr_HMsqRoeVwKbwAF",
+      "entity": "qr_code",
+      "created_at": 1623661499,
+      "name": "Fresh Groceries",
+      "usage": "multiple_use",
+      "type": "upi_qr",
+      "image_url": "https://rzp.io/i/eI9XD54Q",
+      "payment_amount": null,
+      "status": "active",
+      "description": "Buy fresh groceries",
+      "fixed_amount": false,
+      "payments_amount_received": 1000,
+      "payments_count_received": 1,
+      "notes": [],
+      "customer_id": "cust_HKsR5se84c5LTO",
+      "close_by": 1624472999,
+      "close_reason": null
+    }
+  ]
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+### Fetch Payments for a QR Code
+
+```rb
+para_attr = {
+  "count" : 1  
+}
+Razorpay::QrCode.fetch(qrCodeId).fetch_payments(para_attr)
+```
+
+**Parameters:**
+
+| Name            | Type    | Description                                                                  |
+|-----------------|---------|------------------------------------------------------------------------------|
+| qrCodeID*  | string | The id of the qr code to which payment where made |
+| from  | timestamp | timestamp after which the payments were created  |
+| to    | timestamp | timestamp before which the payments were created |
+| 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": "pay_HMtDKn3TnF4D8x",
+      "entity": "payment",
+      "amount": 500,
+      "currency": "INR",
+      "status": "captured",
+      "order_id": null,
+      "invoice_id": null,
+      "international": false,
+      "method": "upi",
+      "amount_refunded": 0,
+      "refund_status": null,
+      "captured": true,
+      "description": "QRv2 Payment",
+      "card_id": null,
+      "bank": null,
+      "wallet": null,
+      "vpa": "gauri.kumari@okhdfcbank",
+      "email": "gauri.kumari@example.com",
+      "contact": "+919999999999",
+      "customer_id": "cust_HKsR5se84c5LTO",
+      "notes": [],
+      "fee": 0,
+      "tax": 0,
+      "error_code": null,
+      "error_description": null,
+      "error_source": null,
+      "error_step": null,
+      "error_reason": null,
+      "acquirer_data": {
+        "rrn": "116514257019"
+      },
+      "created_at": 1623662800
+    }
+  ]
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+### Close a QR Code
+
+```rb
+qrCodeId = "qr_HMsVL8HOpbMcjU"
+
+Razorpay::QrCode.fetch(qrCodeId).close
+```
+
+**Parameters:**
+
+| Name            | Type    | Description                                                                  |
+|-----------------|---------|------------------------------------------------------------------------------|
+| qrCodeID*  | string | The id of the qr code to be closed |
+
+**Response:**
+```json
+{
+  "id": "qr_HMsVL8HOpbMcjU",
+  "entity": "qr_code",
+  "created_at": 1623660301,
+  "name": "Store_1",
+  "usage": "single_use",
+  "type": "upi_qr",
+  "image_url": "https://rzp.io/i/BWcUVrLp",
+  "payment_amount": 300,
+  "status": "closed",
+  "description": "For Store 1",
+  "fixed_amount": true,
+  "payments_amount_received": 0,
+  "payments_count_received": 0,
+  "notes": {
+    "purpose": "Test UPI QR code notes"
+  },
+  "customer_id": "cust_HKsR5se84c5LTO",
+  "close_by": 1681615838,
+  "closed_at": 1623660445,
+  "close_reason": "on_demand"
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+
+**PN: * indicates mandatory fields**
+<br>
+<br>
+**For reference click [here](https://razorpay.com/docs/qr-codes/)**