razorpay 2.4.0 → 3.2.4

data/documents/account.md

@@ -0,0 +1,449 @@
+## Account
+
+```rb
+require "razorpay"
+
+Razorpay.setup('key_id', 'key_secret')
+```
+
+### Create an Account
+```rb
+Razorpay::Account.create({
+  "email": "gauriagain.kumar@example.org",
+  "phone": "9000090000",
+  "legal_business_name": "Acme Corp",
+  "business_type": "partnership",
+  "customer_facing_business_name": "Example",
+  "profile": {
+    "category": "healthcare",
+    "subcategory": "clinic",
+    "description": "Healthcare E-commerce platform",
+    "addresses": {
+      "operation": {
+        "street1": "507, Koramangala 6th block",
+        "street2": "Kormanagala",
+        "city": "Bengaluru",
+        "state": "Karnataka",
+        "postal_code": 560047,
+        "country": "IN"
+      },
+      "registered": {
+        "street1": "507, Koramangala 1st block",
+        "street2": "MG Road",
+        "city": "Bengaluru",
+        "state": "Karnataka",
+        "postal_code": 560034,
+        "country": "IN"
+      }
+    },
+    "business_model": "Online Clothing ( men, women, ethnic, modern ) fashion and lifestyle, accessories, t-shirt, shirt, track pant, shoes."
+  },
+  "legal_info": {
+    "pan": "AAACL1234C",
+    "gst": "18AABCU9603R1ZM"
+  },
+  "brand": {
+    "color": "FFFFFF"
+  },
+  "notes": {
+    "internal_ref_id": "123123"
+  },
+  "contact_name": "Gaurav Kumar",
+  "contact_info": {
+    "chargeback": {
+      "email": "cb@example.org"
+    },
+    "refund": {
+      "email": "cb@example.org"
+    },
+    "support": {
+      "email": "support@example.org",
+      "phone": "9999999998",
+      "policy_url": "https://www.google.com"
+    }
+  },
+  "apps": {
+    "websites": [
+      "https://www.example.org"
+    ],
+    "android": [
+      {
+        "url": "playstore.example.org",
+        "name": "Example"
+      }
+    ],
+    "ios": [
+      {
+        "url": "appstore.example.org",
+        "name": "Example"
+      }
+    ]
+  }
+})
+```
+
+**Parameters:**
+
+| Name          | Type        | Description                                 |
+|---------------|-------------|---------------------------------------------|
+| email*        | string      | The sub-merchant's business email address.  |
+| phone*          | integer      | The sub-merchant's business phone number. The minimum length is 8 characters and the maximum length is 15.                       |
+| legal_business_name*      | string | The name of the sub-merchant's business. For example, Acme Corp. The minimum length is 4 characters and the maximum length is 200.          |
+| customer_facing_business_name | string | The sub-merchant billing label as it appears on the Razorpay Dashboard. The minimum length is 1 character and the maximum length is 255. |
+| business_type         | string      | The type of business operated by the sub-merchant.Possible value is `proprietorship`, `partnership`, `private_limited`, `public_limited`, `llp`, `ngo`, `trust`, `society`, `not_yet_registered`, `huf` |
+| reference_id         | string      |  Partner's external account reference id. The minimum length is 1 character and the maximum length is 512. |
+| profile         | object      | All keys listed [here](https://razorpay.com/docs/api/partners/account-onboarding/#create-an-account) are supported |         
+| legal_info         | object      | All keys listed [here](hhttps://razorpay.com/docs/api/partners/account-onboarding/#create-an-account) are supported |
+| brand         | object      | All keys listed [here](https://razorpay.com/docs/api/partners/account-onboarding/#create-an-account) are supported |
+| notes | object  | A key-value pair  |
+| contact_name* | string  | The name of the contact. The minimum length is 4 and the maximum length is 255 characters. |
+| contact_info | object  | All keys listed [here](https://razorpay.com/docs/api/partners/account-onboarding/#create-an-account) are supported |     
+| apps | object  | All keys listed [here](https://razorpay.com/docs/api/partners/account-onboarding/#create-an-account) are supported |     
+
+
+**Response:**
+```json
+{
+  "id": "acc_GRWKk7qQsLnDjX",
+  "type": "standard",
+  "status": "created",
+  "email": "gauriagain.kumar@example.org",
+  "profile": {
+    "category": "healthcare",
+    "subcategory": "clinic",
+    "addresses": {
+      "registered": {
+        "street1": "507, Koramangala 1st block",
+        "street2": "MG Road",
+        "city": "Bengaluru",
+        "state": "KARNATAKA",
+        "postal_code": 560034,
+        "country": "IN"
+      },
+      "operation": {
+        "street1": "507, Koramangala 6th block",
+        "street2": "Kormanagalo",
+        "city": "Bengaluru",
+        "state": "KARNATAKA",
+        "country": "IN",
+        "postal_code": 560047
+      }
+    },
+    "business_model": "Online Clothing ( men, women, ethnic, modern ) fashion and lifestyle, accessories, t-shirt, shirt, track pant, shoes."
+  },
+  "notes": {
+    "internal_ref_id": "123123"
+  },
+  "created_at": 1611136837,
+  "phone": "9000090000",
+  "business_type": "partnership",
+  "legal_business_name": "Acme Corp",
+  "customer_facing_business_name": "Example",
+  "legal_info": {
+    "pan": "AAACL1234C",
+    "gst": "18AABCU9603R1ZM"
+  },
+  "apps": {
+    "websites": [
+      "https://www.example.org"
+    ],
+    "android": [
+      {
+        "url": "playstore.example.org",
+        "name": "Example"
+      }
+    ],
+    "ios": [
+      {
+        "url": "appstore.example.org",
+        "name": "Example"
+      }
+    ]
+  },
+  "brand": {
+    "color": "#FFFFFF"
+  },
+  "contact_info": {
+    "chargeback": {
+      "email": "cb@example.org",
+      "phone": null,
+      "policy_url": null
+    },
+    "refund": {
+      "email": "cb@example.org",
+      "phone": null,
+      "policy_url": null
+    },
+    "support": {
+      "email": "support@example.org",
+      "phone": "9999999998",
+      "policy_url": "https://www.google.com"
+    }
+  }
+}
+```
+
+-------------------------------------------------------------------------------------------------------
+
+### Edit Account
+
+```rb
+accountId = "acc_GP4lfNA0iIMn5B";
+
+Razorpay::Account.edit(accountId,{
+	"customer_facing_business_name": "ABCD Ltd"
+})
+```
+
+**Parameters:**
+
+| Name          | Type        | Description                                 |
+|---------------|-------------|---------------------------------------------|
+| phone          | integer      | The sub-merchant's business phone number. The minimum length is 8 characters and the maximum length is 15.                       |
+| legal_business_name      | string | The name of the sub-merchant's business. For example, Acme Corp. The minimum length is 4 characters and the maximum length is 200.          |
+| customer_facing_business_name | string | The sub-merchant billing label as it appears on the Razorpay Dashboard. The minimum length is 1 character and the maximum length is 255. |
+| profile         | object      | All keys listed [here](https://razorpay.com/docs/api/partners/account-onboarding/#update-an-account) are supported |         
+| legal_info         | object      | All keys listed [here](hhttps://razorpay.com/docs/api/partners/account-onboarding/#update-an-account) are supported |
+| brand         | object      | All keys listed [here](https://razorpay.com/docs/api/partners/account-onboarding/#update-an-account) are supported |
+| notes | object  | A key-value pair  |
+| contact_name* | string  | The name of the contact. The minimum length is 4 and the maximum length is 255 characters. |
+| contact_info | object  | All keys listed [here](https://razorpay.com/docs/api/partners/account-onboarding/#update-an-account) are supported |     
+| apps | object  | All keys listed [here](https://razorpay.com/docs/api/partners/account-onboarding/#update-an-account) are supported |     
+
+**Response:**
+```json
+{
+  "id": "acc_GP4lfNA0iIMn5B",
+  "type": "standard",
+  "status": "created",
+  "email": "gauri@example.org",
+  "profile": {
+    "category": "healthcare",
+    "subcategory": "clinic",
+    "addresses": {
+      "registered": {
+        "street1": "507, Koramangala 1st block",
+        "street2": "MG Road-1",
+        "city": "Bengalore",
+        "state": "KARNATAKA",
+        "postal_code": "560034",
+        "country": "IN"
+      }
+    }
+  },
+  "notes": [],
+  "created_at": 1610603081,
+  "phone": "9000090000",
+  "reference_id": "randomId",
+  "business_type": "partnership",
+  "legal_business_name": "Acme Corp",
+  "customer_facing_business_name": "ABCD Ltd"
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+### Delete an account
+```rb
+accountId = "acc_GP4lfNA0iIMn5B";
+
+Razorpay::Account.delete(accountId)
+```
+
+**Parameters:**
+
+| Name          | Type        | Description                                 |
+|---------------|-------------|---------------------------------------------|
+| accountId* | string   | The unique identifier of a sub-merchant account that must be deleted.  |
+
+**Response:**
+```json
+{
+  "id": "acc_GXQAkO2MrvBYg4",
+  "type": "standard",
+  "status": "suspended",
+  "email": "gaurav.kumar@acme.org",
+  "profile": {
+    "category": "healthcare",
+    "subcategory": "clinic",
+    "addresses": {
+      "registered": {
+        "street1": "507, Koramangala 1st block",
+        "street2": "MG Road",
+        "city": "Bengaluru",
+        "state": "KARNATAKA",
+        "postal_code": "560034",
+        "country": "IN"
+      },
+      "operation": {
+        "street1": "507, Koramangala 1st block",
+        "street2": "MG Road",
+        "city": "Bengaluru",
+        "state": "KARNATAKA",
+        "country": "IN",
+        "postal_code": "560034"
+      }
+    },
+    "business_model": "Online Clothing ( men, women, ethnic, modern ) fashion and lifestyle, accessories, t-shirt, shirt, track pant, shoes."
+  },
+  "notes": {
+    "internal_ref_id": "123123"
+  },
+  "created_at": 1612425180,
+  "suspended_at": 1612425235,
+  "phone": "9000090000",
+  "reference_id": "account_COdeRandom",
+  "business_type": "partnership",
+  "legal_business_name": "Acme Corp Pvt Ltd",
+  "customer_facing_business_name": "Acme",
+  "legal_info": {
+    "pan": "AAACL1234C",
+    "gst": "18AABCU9603R1ZM"
+  },
+  "apps": {
+    "websites": [
+      "https://www.acme.org"
+    ],
+    "android": [
+      {
+        "url": "playstore.acme.org",
+        "name": "Acme"
+      }
+    ],
+    "ios": [
+      {
+        "url": "appstore.acme.org",
+        "name": "Acme"
+      }
+    ]
+  },
+  "brand": {
+    "color": "#FFFFFF"
+  },
+  "contact_name": "Gaurav Kumar",
+  "contact_info": {
+    "chargeback": {
+      "email": "cb@acme.org",
+      "phone": "9000090000",
+      "policy_url": "https://www.google.com"
+    },
+    "refund": {
+      "email": "cb@acme.org",
+      "phone": "9898989898",
+      "policy_url": "https://www.google.com"
+    },
+    "support": {
+      "email": "support@acme.org",
+      "phone": "9898989898",
+      "policy_url": "https://www.google.com"
+    }
+  }
+}
+```
+
+-------------------------------------------------------------------------------------------------------
+
+### Fetch an account
+```rb
+accountId = "acc_GP4lfNA0iIMn5B";
+
+Razorpay::Account.fetch(accountId)
+```
+
+**Parameters:**
+
+| Name        | Type        | Description                                 |
+|-------------|-------------|---------------------------------------------|
+| accountId* | string      | The unique identifier of a sub-merchant account generated by Razorpay.  |
+
+**Response:**
+```json
+{
+  "id": "acc_GP4lfNA0iIMn5B",
+  "type": "standard",
+  "status": "created",
+  "email": "gauri@example.org",
+  "profile": {
+    "category": "healthcare",
+    "subcategory": "clinic",
+    "addresses": {
+      "registered": {
+        "street1": "507, Koramangala 1st block",
+        "street2": "MG Road-1",
+        "city": "Bengalore",
+        "state": "KARNATAKA",
+        "postal_code": "560034",
+        "country": "IN"
+      }
+    }
+  },
+  "notes": [],
+  "created_at": 1610603081,
+  "phone": "9000090000",
+  "reference_id": "randomId",
+  "business_type": "partnership",
+  "legal_business_name": "Acme Corp",
+  "customer_facing_business_name": "Example Pvt. Ltd."
+}
+```
+-------------------------------------------------------------------------------------------------------
+### Upload account documents
+```rb
+account_id = "acc_0000000000001"
+
+Razorpay::Account.upload_account_doc(account_id,{
+  "file": File.new("/Users/your_name/Downloads/sample_uploaded.jpeg"),
+  "document_type": "business_proof_url"
+})
+
+```
+
+**Parameters:**
+
+| Name        | Type        | Description                                 |
+|-------------|-------------|---------------------------------------------|
+| accountId* | string      | The unique identifier of a sub-merchant account generated by Razorpay.  |
+| file* | string      | The URL generated once the business proof document is uploaded.  |
+| document_type* | string      | The documents valid for the proof type to be shared. Possible values : <br> business_proof_of_identification: `shop_establishment_certificate`, `gst_certificate`, `msme_certificate`, `business_proof_url`, `business_pan_url`, <br><br> additional_documents : `form_12_a_url`, `form_80g_url`, `cancelled_cheque`  |
+
+**Response:**
+```json
+{
+  "business_proof_of_identification": [
+    {
+      "type": "business_proof_url",
+      "url": "<https://rzp.io/i/bzDKbNg>"
+    }
+  ]
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+### Fetch account documents
+```rb
+account_id = "acc_0000000000001"
+
+Razorpay::Account.fetch_account_doc(account_id)
+```
+
+**Parameters:**
+
+| Name        | Type        | Description                                 |
+|-------------|-------------|---------------------------------------------|
+| accountId* | string      | The unique identifier of a sub-merchant account generated by Razorpay.  |
+
+**Response:**
+```json
+{
+  "business_proof_of_identification": [
+    {
+      "type": "business_proof_url",
+      "url": "<https://rzp.io/i/bzDKbNg>"
+    }
+  ]
+}
+```
+-------------------------------------------------------------------------------------------------------
+**PN: * indicates mandatory fields**
+<br>
+<br>
+**For reference click [here](https://razorpay.com/docs/api/partners/account-onboarding/)**

data/documents/addon.md

@@ -0,0 +1,191 @@
+## Addons
+
+```rb
+require "razorpay"
+
+Razorpay.setup('key_id', 'key_secret')
+```
+
+### Create an addon
+
+```rb
+subscriptionId = "sub_JBELhNBHtTCyhh"
+
+Razorpay::Addon.create(subscriptionId,{
+  "item":{
+    "name":"Extra appala (papadum)",
+    "amount":30000,
+    "currency":"INR",
+    "description":"1 extra oil fried appala with meals"
+  },
+  "quantity":2
+})
+```
+
+**Parameters:**
+
+| Name  | Type      | Description                                      |
+|-------|-----------|--------------------------------------------------|
+| subscriptionId*  | boolean | The subscription ID to which the add-on is being added. |
+| items*  | object | Details of the add-on you want to create. |
+| quantity  | integer | This specifies the number of units of the add-on to be charged to the customer. |
+
+**Response:**
+```json
+{
+  "id":"ao_00000000000001",
+  "entity":"addon",
+  "item":{
+    "id":"item_00000000000001",
+    "active":true,
+    "name":"Extra appala (papadum)",
+    "description":"1 extra oil fried appala with meals",
+    "amount":30000,
+    "unit_amount":30000,
+    "currency":"INR",
+    "type":"addon",
+    "unit":null,
+    "tax_inclusive":false,
+    "hsn_code":null,
+    "sac_code":null,
+    "tax_rate":null,
+    "tax_id":null,
+    "tax_group_id":null,
+    "created_at":1581597318,
+    "updated_at":1581597318
+  },
+  "quantity":2,
+  "created_at":1581597318,
+  "subscription_id":"sub_00000000000001",
+  "invoice_id":null
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+### Fetch all addons
+
+```rb
+options = {"count": 2}
+
+Razorpay::Addon.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": "ao_00000000000002",
+      "entity": "addon",
+      "item": {
+        "id": "item_00000000000002",
+        "active": true,
+        "name": "Extra sweet",
+        "description": "1 extra sweet of the day with meals",
+        "amount": 90000,
+        "unit_amount": 90000,
+        "currency": "INR",
+        "type": "addon",
+        "unit": null,
+        "tax_inclusive": false,
+        "hsn_code": null,
+        "sac_code": null,
+        "tax_rate": null,
+        "tax_id": null,
+        "tax_group_id": null,
+        "created_at": 1581597318,
+        "updated_at": 1581597318
+      },
+      "quantity": 1,
+      "created_at": 1581597318,
+      "subscription_id": "sub_00000000000001",
+      "invoice_id": "inv_00000000000001"
+    }
+  ]
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+### Fetch an addon
+
+```rb
+addonId  = "ao_IrSY3UIqDRx7df"
+
+Razorpay::Addon.fetch(addonId)
+```
+
+**Parameters:**
+
+| Name            | Type    | Description     |
+|-----------------|---------|------------------------------------|
+| addonId*          | string | addon id to be fetched            |
+
+**Response:**
+```json
+{
+  "id":"ao_IrSY3UIqDRx7df",
+  "entity":"addon",
+  "item":{
+    "id":"item_00000000000001",
+    "active":true,
+    "name":"Extra appala (papadum)",
+    "description":"1 extra oil fried appala with meals",
+    "amount":30000,
+    "unit_amount":30000,
+    "currency":"INR",
+    "type":"addon",
+    "unit":null,
+    "tax_inclusive":false,
+    "hsn_code":null,
+    "sac_code":null,
+    "tax_rate":null,
+    "tax_id":null,
+    "tax_group_id":null,
+    "created_at":1581597318,
+    "updated_at":1581597318
+  },
+  "quantity":2,
+  "created_at":1581597318,
+  "subscription_id":"sub_00000000000001",
+  "invoice_id":null
+}
+```
+----------------------------------------------------------------------------------------------------
+
+### Delete an addon
+
+```rb
+addonId  = "ao_IrSY3UIqDRx7df"
+
+Razorpay::Addon.delete(addonId)
+```
+
+
+**Parameters:**
+
+| Name            | Type    | Description                                                                  |
+|-----------------|---------|------------------------------------------------------------------------------|
+| addonId*          | string | addon id to be deleted |
+
+**Response:**
+
+```json
+[]
+```
+-------------------------------------------------------------------------------------------------------
+
+**PN: * indicates mandatory fields**
+<br>
+<br>
+**For reference click [here](https://razorpay.com/docs/api/subscriptions/#add-ons)**