razorpay 2.4.0 → 3.2.4

data/documents/items.md

@@ -0,0 +1,208 @@
+## items
+
+```rb
+require "razorpay"
+Razorpay.setup('key_id', 'key_secret')
+```
+
+### Create item
+
+```rb
+Razorpay::Item.create({
+  "name": "Book / English August",
+  "description": "An indian story, Booker prize winner.",
+  "amount": 20000,
+  "currency": "INR"
+});
+```
+
+**Parameters:**
+
+| Name            | Type    | Description                                                                  |
+|-----------------|---------|------------------------------------------------------------------------------|
+| name*          | string | Name of the item.                    |
+| description        | string  | A brief description of the item.  |
+| amount         | integer  | Amount of the order to be paid     |
+| currency*           | string  | Currency of the order. Currently only `INR` is supported.    |
+
+**Response:**
+```json
+{
+  "id": "item_Jf5MlwKlPMOKBV",
+  "active": true,
+  "name": "Book / English August",
+  "description": "An indian story, Booker prize winner.",
+  "amount": 20000,
+  "unit_amount": 20000,
+  "currency": "INR",
+  "type": "invoice",
+  "unit": null,
+  "tax_inclusive": false,
+  "hsn_code": null,
+  "sac_code": null,
+  "tax_rate": null,
+  "tax_id": null,
+  "tax_group_id": null,
+  "created_at": 1654709890
+}
+```
+
+-------------------------------------------------------------------------------------------------------
+
+### Fetch all items
+
+```rb
+options = {"count":1}
+
+Razorpay::Item.all(options)
+```
+**Parameters:**
+
+| Name  | Type      | Description                                      |
+|-------|-----------|--------------------------------------------------|
+| from  | timestamp | timestamp after which the item were created  |
+| to    | timestamp | timestamp before which the item were created |
+| count | integer   | number of item to fetch (default: 10)        |
+| skip  | integer   | number of item to be skipped (default: 0)    |
+| name        | string | Name of the item.                    |
+| description        | string  | A brief description of the item.  |
+| amount         | integer  | Amount of the order to be paid     |
+| currency           | string  | Currency of the order. Currently only `INR` is supported.    |
+| active   | boolean  | Possible values is `0` or `1` |
+
+**Response:**
+```json
+{
+    "entity": "collection",
+    "count": 1,
+    "items": [
+        {
+            "id": "item_JnjKnSWxjILdWu",
+            "active": true,
+            "name": "Book / English August",
+            "description": "An indian story, Booker prize winner.",
+            "amount": 20000,
+            "unit_amount": 20000,
+            "currency": "INR",
+            "type": "invoice",
+            "unit": null,
+            "tax_inclusive": false,
+            "hsn_code": null,
+            "sac_code": null,
+            "tax_rate": null,
+            "tax_id": null,
+            "tax_group_id": null,
+            "created_at": 1656597363
+        }
+    ]
+}
+```
+-------------------------------------------------------------------------------------------------------
+### Fetch particular item
+
+```rb
+itemId = "item_7Oxp4hmm6T4SCn"
+
+Razorpay::Item.fetch(itemId)
+```
+**Parameters**
+
+| Name     | Type   | Description                         |
+|----------|--------|-------------------------------------|
+| itemId* | string | The id of the item to be fetched |
+
+**Response:**
+```json
+{
+    "id": "item_JnjKnSWxjILdWu",
+    "active": true,
+    "name": "Book / English August",
+    "description": "An indian story, Booker prize winner.",
+    "amount": 20000,
+    "unit_amount": 20000,
+    "currency": "INR",
+    "type": "invoice",
+    "unit": null,
+    "tax_inclusive": false,
+    "hsn_code": null,
+    "sac_code": null,
+    "tax_rate": null,
+    "tax_id": null,
+    "tax_group_id": null,
+    "created_at": 1656597363
+}
+```
+
+-------------------------------------------------------------------------------------------------------
+
+### Update item
+
+```rb
+itemId = "item_JDcbIdX9xojCje"
+
+para_attr = {
+  "name": "Book / Ignited Minds - Updated name!",
+  "description": "New descirption too. :).",
+  "amount": 20000,
+  "currency": "INR",
+  "active": true
+}
+
+Razorpay::Item.edit(itemId,para_attr)
+```
+**Parameters**
+
+| Name     | Type   | Description                         |
+|----------|--------|-------------------------------------|
+| itemId* | string | The id of the item to be fetched |
+| name       | string | Name of the item.                    |
+| description  | string  | A brief description of the item.  |
+| amount         | integer  | Amount of the order to be paid     |
+| currency           | string  | Currency of the order. Currently only `INR` is supported.    |
+| active   | boolean  | Possible values is `0` or `1` |
+
+**Response:**
+```json
+{
+  "id": "item_JInaSLODeDUQiQ",
+  "active": true,
+  "name": "Book / Ignited Minds - Updated name!",
+  "description": "New descirption too.",
+  "amount": 20000,
+  "unit_amount": 20000,
+  "currency": "INR",
+  "type": "invoice",
+  "unit": null,
+  "tax_inclusive": false,
+  "hsn_code": null,
+  "sac_code": null,
+  "tax_rate": null,
+  "tax_id": null,
+  "tax_group_id": null,
+  "created_at": 1649843796
+}
+```
+-------------------------------------------------------------------------------------------------------
+### Delete item
+
+```rb
+itemId = "item_Jc7wDjjQ4x305A"
+
+Razorpay::Item.delete(itemId)
+```
+**Parameters**
+
+| Name     | Type   | Description                         |
+|----------|--------|-------------------------------------|
+| itemId* | string | The id of the item to be fetched |
+
+**Response:**
+```json
+[]
+```
+-------------------------------------------------------------------------------------------------------
+
+**PN: * indicates mandatory fields**
+<br>
+<br>
+**For reference click [here](https://razorpay.com/docs/api/items)**

data/documents/oauth_token.md

@@ -0,0 +1,142 @@
+### OAuthToken
+
+```rb
+require "razorpay"
+```
+
+### Generate Authorize Url
+```rb
+body = {
+    submerchant_id: '<SUBMERCHANT_MID>',
+    timestamp: Time.now.to_i
+}
+onboarding_signature = Razorpay::Utility.generate_onboarding_signature(body, '<YOUR_CLIENT_SECRET>')
+
+options = {
+    'client_id'            => '<YOUR_CLIENT_ID>',
+    'redirect_uri'         => 'https://example.com/razorpay_callback',
+    'scopes'               => ["read_write"],
+    'state'                => 'NOBYtv8r6c75ex6WZ',
+    'onboarding_signature' => onboarding_signature
+}
+authorize_url = Razorpay::OAuthToken.get_auth_url(options)
+```
+
+**Parameters:**
+
+| Name                 | Type   | Description                                                                                                                                             |
+|----------------------|--------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
+| client_id*           | string | Unique client identifier.                                                                                                                               |
+| redirect_uri*        | string | Callback URL used by Razorpay to redirect after the user approves or denies the authorisation request. The client should whitelist the 'redirect_uri'.  |
+| scopes*              | array  | Defines what access your application is requesting from the user. You can request one or multiple scopes by adding them to an array as indicated above. |
+| state*               | string | A random string generated by your service. This parameter helps prevent cross-site request forgery (CSRF) attacks.                                      |
+| onboarding_signature | string | A cryptographic string generated by your service using generateOnboardingSignature method in Utils class. Only applicable for accounts created with pre-fill KYC |
+
+**Response:**
+```
+"https://auth.razorpay.com/authorize?response_type=code&client_id=<YOUR_CLIENT_ID>&redirect_uri=https:%2F%2Fexample.com%2Frazorpay_callback&scope[]=read_only&scope[]=rx_read_write&state=NOBYtv8r6c75ex6WZ&onboarding_signature=<GENERATED_ONBOARDING_SIGNATURE>"
+```
+
+-------------------------------------------------------------------------------------------------------
+### Get Access token
+```rb
+options = {
+    'client_id'          => '<YOUR_CLIENT_ID>',
+    'client_secret'     => '<YOUR_CLIENT_SECRET>',
+    'redirect_uri'      => 'https://example.com/razorpay_callback',
+    'grant_type'        => 'authorization_code',
+    'code'              => '<AUTHORIZATION_CODE>',
+    'mode'              => 'test'
+}
+oauth_token = Razorpay::OAuthToken.get_access_token(options)
+```
+
+**Parameters:**
+
+| Name           | Type   | Description                                                                                                                  |
+|----------------|--------|------------------------------------------------------------------------------------------------------------------------------|
+| client_id*     | string | Unique client identifier.                                                                                                    |
+| client_secret* | string | Client secret string.                                                                                                        |
+| redirect_uri*  | string | Specifies the same redirect_uri used in the authorisation request.                                                           |
+| grant_type*    | string | Defines the grant type for the request. Possible value are:<ul><li>authorization_code</li><li>client_credentials</li></ul>   |
+| code*          | string | Decoded authorisation code received in the last step. Note: Pass this parameter only when grant_type is 'authorization_code' |
+| mode           | string | The type of mode. Possible values: <ul><li>test</li><li>live (default)</li></ul>                                             |
+
+**Response:**
+```json
+{
+  "public_token": "rzp_test_oauth_9xu1rkZqoXlClS",
+  "token_type": "Bearer",
+  "expires_in": 7862400,
+  "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IkY1Z0NQYkhhRzRjcUpnIn0.eyJhdWQiOiJGNFNNeEgxanMxbkpPZiIsImp0aSI6IkY1Z0NQYkhhRzRjcUpnIiwiaWF0IjoxNTkyODMxMDExLCJuYmYiOjE1OTI4MzEwMTEsInN1YiI6IiIsImV4cCI6MTYwMDc3OTgxMSwidXNlcl9pZCI6IkYycVBpejJEdzRPRVFwIiwibWVyY2hhbnRfaWQiOiJGMnFQaVZ3N0lNV01GSyIsInNjb3BlcyI6WyJyZWFkX29ubHkiXX0.Wwqt5czhoWpVzP5_aoiymKXoGj-ydo-4A_X2jf_7rrSvk4pXdqzbA5BMrHxPdPbeFQWV6vsnsgbf99Q3g-W4kalHyH67LfAzc3qnJ-mkYDkFY93tkeG-MCco6GJW-Jm8xhaV9EPUak7z9J9jcdluu9rNXYMtd5qxD8auyRYhEgs",
+  "refresh_token": "def50200f42e07aded65a323f6c53181d802cc797b62cc5e78dd8038d6dff253e5877da9ad32f463a4da0ad895e3de298cbce40e162202170e763754122a6cb97910a1f58e2378ee3492dc295e1525009cccc45635308cce8575bdf373606c453ebb5eb2bec062ca197ac23810cf9d6cf31fbb9fcf5b7d4de9bf524c89a4aa90599b0151c9e4e2fa08acb6d2fe17f30a6cfecdfd671f090787e821f844e5d36f5eacb7dfb33d91e83b18216ad0ebeba2bef7721e10d436c3984daafd8654ed881c581d6be0bdc9ebfaee0dc5f9374d7184d60aae5aa85385690220690e21bc93209fb8a8cc25a6abf1108d8277f7c3d38217b47744d7",
+  "razorpay_account_id": "acc_Dhk2qDbmu6FwZH"
+}
+```
+
+-------------------------------------------------------------------------------------------------------
+
+### Get Access token using refresh token
+```rb
+options = {
+    'client_id'          => '<YOUR_CLIENT_ID>',
+    'client_secret'     => '<YOUR_CLIENT_SECRET>',
+    'refresh_token'     => 'def5020096e1c470c901d34cd60fa53abdaf3662sa0'
+}
+oauth_token = Razorpay::OAuthToken.refresh_token(options)
+```
+
+**Parameters:**
+
+| Name           | Type      | Description                                |
+|----------------|-----------|--------------------------------------------|
+| client_id*     | string    | Unique client identifier.                  |
+| client_secret* | string    | Client secret string.                      |
+| refresh_token* | string    | The previously-stored refresh token value. |
+
+**Response:**
+```json
+{
+  "public_token": "rzp_test_oauth_9xu1rkZqoXlClS",
+  "token_type": "Bearer",
+  "expires_in": 7862400,
+  "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6Ijl4dTF",
+  "refresh_token": "def5020096e1c470c901d34cd60fa53abdaf36620e823ffa53"
+}
+```
+
+-------------------------------------------------------------------------------------------------------
+
+### Revoke a token
+```rb
+options = {
+    'client_id'         => '<YOUR_CLIENT_ID>',
+    'client_secret'     => '<YOUR_CLIENT_SECRET>',
+    'token'             => 'def5020096e1c470c901d34cd60fa53abdaf36620e823ffa53'
+    'token_type_hint'   => 'access_token'
+}
+response = Razorpay::OAuthToken.revoke_token(options)
+```
+
+**Parameters:**
+
+| Name             | Type     | Description                                                                                              |
+|------------------|----------|----------------------------------------------------------------------------------------------------------|
+| client_id*       | string   | Unique client identifier.                                                                                |
+| client_secret*   | string   | Client secret string.                                                                                    |
+| token_type_hint* | string   | The type of token for the request. Possible values: <ul><li>access_token</li><li>refresh_token</li></ul> |
+| token*           | string   | The token whose access should be revoked.                                                                |
+
+**Response:**
+```json
+{
+  "message": "Token Revoked"
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+**PN: * indicates mandatory fields**
+<br>
+<br>
+**For reference click [here](https://razorpay.com/docs/partners/platform/onboard-businesses/integrate-oauth/integration-steps)**
+

data/documents/order.md

@@ -0,0 +1,352 @@
+## Orders
+
+```rb
+require "razorpay"
+Razorpay.setup('key_id', 'key_secret')
+```
+
+### Create order
+
+```rb
+
+para_attr = {
+  "amount": 50000,
+  "currency": "INR",
+  "receipt": "receipt#1",
+  "notes": {
+    "key1": "value3",
+    "key2": "value2"
+  }
+}
+
+Razorpay::Order.create(para_attr)
+```
+
+**Parameters:**
+
+| Name            | Type    | Description                                                                  |
+|-----------------|---------|------------------------------------------------------------------------------|
+| amount*          | integer | Amount of the order to be paid                                               |
+| currency*        | string  | Currency of the order. Currently only `INR` is supported.                      |
+| receipt         | string  | Your system order reference id.                                              |
+| notes           | object  | A key-value pair                                                             |
+
+**Response:**
+
+```json
+{
+  "id": "order_EKwxwAgItmmXdp",
+  "entity": "order",
+  "amount": 50000,
+  "amount_paid": 0,
+  "amount_due": 50000,
+  "currency": "INR",
+  "receipt": "receipt#1",
+  "offer_id": null,
+  "status": "created",
+  "attempts": 0,
+  "notes": [],
+  "created_at": 1582628071
+}
+```
+
+-------------------------------------------------------------------------------------------------------
+
+### Create order (Third party validation)
+
+```rb
+para_attr = {
+  "amount": 500,
+  "method": "netbanking",
+  "receipt": "BILL13375649",
+  "currency": "INR",
+  "bank_account": {
+    "account_number": "765432123456789",
+    "name": "Gaurav Kumar",
+    "ifsc": "HDFC0000053"
+  }
+}  
+
+Razorpay::Order.create(para_attr)
+```
+
+**Parameters:**
+
+| Name            | Type    | Description                                                                  |
+|-----------------|---------|------------------------------------------------------------------------------|
+| amount*          | integer | Amount of the order to be paid                                               |
+| method        | string  | The payment method used to make the payment. If this parameter is not passed, customers will be able to make payments using both netbanking and UPI payment methods. Possible values is `netbanking` or `upi`|
+| currency*        | string  | Currency of the order. Currently only `INR` is supported.       |
+| receipt         | string  | Your system order reference id.                                              |
+|bank_account | array  | All keys listed [here](https://razorpay.com/docs/payments/third-party-validation/#step-2-create-an-order) are supported |
+| notes           | object  | A key-value pair    |
+
+**Response:**
+
+```json
+{
+  "id": "order_GAWN9beXgaqRyO",
+  "entity": "order",
+  "amount": 500,
+  "amount_paid": 0,
+  "amount_due": 500,
+  "currency": "INR",
+  "receipt": "BILL13375649",
+  "offer_id": null,
+  "status": "created",
+  "attempts": 0,
+  "notes": [],
+  "created_at": 1573044247
+}
+```
+
+-------------------------------------------------------------------------------------------------------
+
+### Fetch all orders
+
+```rb
+option = {"count":1}
+
+Razorpay::Order.all(option)
+```
+
+**Parameters**
+
+| Name       | Type      | Description                                                  |
+|------------|-----------|--------------------------------------------------------------|
+| from       | timestamp | timestamp after which the orders were created              |
+| to         | timestamp | timestamp before which the orders were created             |
+| count      | integer   | number of orders to fetch (default: 10)                    |
+| skip       | integer   | number of orders to be skipped (default: 0)                |
+| authorized | boolean   | Orders for which orders are currently in authorized state. |
+| receipt    | string    | Orders with the provided value for receipt.                  |
+| expand[]   | string    |  Used to retrieve additional information about the payment. Possible value is `payments`,`payments.card`,`transfers` or `virtual_account` |
+
+**Response:**
+
+```json
+{
+  "entity": "collection",
+  "count": 1,
+  "items": [
+    {
+      "id": "order_EKzX2WiEWbMxmx",
+      "entity": "order",
+      "amount": 1234,
+      "amount_paid": 0,
+      "amount_due": 1234,
+      "currency": "INR",
+      "receipt": "Receipt No. 1",
+      "offer_id": null,
+      "status": "created",
+      "attempts": 0,
+      "notes": [],
+      "created_at": 1582637108
+    }
+  ]
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+### Fetch particular order
+
+```rb
+orderId = "order_DaaS6LOUAASb7Y"
+
+Razorpay::Order.fetch(orderId)
+```
+**Parameters**
+
+| Name     | Type   | Description                         |
+|----------|--------|-------------------------------------|
+| orderId* | string | The id of the order to be fetched |
+
+**Response:**
+
+```json
+{
+  "id":"order_DaaS6LOUAASb7Y",
+  "entity":"order",
+  "amount":2200,
+  "amount_paid":0,
+  "amount_due":2200,
+  "currency":"INR",
+  "receipt":"Receipt #211",
+  "status":"attempted",
+  "attempts":1,
+  "notes":[],
+  "created_at":1572505143
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+### Fetch payments for an order
+
+```rb
+orderId = "order_DaaS6LOUAASb7Y"
+
+Razorpay::Order.fetch("order_JCRhAvzvZQPkwT").payments
+```
+**Parameters**
+
+| Name     | Type   | Description                         |
+|----------|--------|-------------------------------------|
+| orderId* | string | The id of the order to be retrieve payment info |
+
+**Response:**
+```json
+{
+  "entity":"collection",
+  "count":1,
+  "items":[
+    {
+      "id":"pay_DaaSOvhgcOfzgR",
+      "entity":"payment",
+      "amount":2200,
+      "currency":"INR",
+      "status":"captured",
+      "order_id":"order_DaaS6LOUAASb7Y",
+      "invoice_id":null,
+      "international":false,
+      "method":"card",
+      "amount_refunded":0,
+      "refund_status":null,
+      "captured":true,
+      "description":"Beans in every imaginable flavour",
+      "card_id":"card_DZon6fd8J3IcA2",
+      "bank":null,
+      "wallet":null,
+      "vpa":null,
+      "email":"gaurav.kumar@example.com",
+      "contact":"+919999999988",
+      "notes":[],
+      "fee":44,
+      "tax":0,
+      "error_code":null,
+      "error_description":null,
+      "created_at":1572505160
+    }
+  ]
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+### Update order
+
+```rb
+orderId = "order_DaaS6LOUAASb7Y"
+
+para_attr = {
+  "notes": {
+    "key1": "value3",
+    "key2": "value2"
+  }
+}
+
+Razorpay::Order.edit(orderId,para_attr)
+```
+**Parameters**
+
+| Name     | Type   | Description                         |
+|----------|--------|-------------------------------------|
+| orderId* | string | The id of the order to be retrieve payment info |
+| notes*   | object  | A key-value pair                    |
+
+**Response:**
+```json
+{
+  "id":"order_DaaS6LOUAASb7Y",
+  "entity":"order",
+  "amount":2200,
+  "amount_paid":0,
+  "amount_due":2200,
+  "currency":"INR",
+  "receipt":"Receipt #211",
+  "offer_id":null,
+  "status":"attempted",
+  "attempts":1,
+  "notes":{
+    "notes_key_1":"Tea, Earl Grey, Hot",
+    "notes_key_2":"Tea, Earl Grey… decaf."
+  },
+  "created_at":1572505143
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+
+### 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>
+**For reference click [here](https://razorpay.com/docs/api/orders/)**