razorpay 3.0.1 → 3.1.0

data/documents/stakeholder.md

@@ -0,0 +1,334 @@
+## Stakeholders
+
+### Create an Stakeholder
+```rb
+
+accountId = "acc_GP4lfNA0iIMn5B"
+
+Razorpay::Stakeholder.create(accountId, {
+  "percentage_ownership": 10,
+  "name": "Gaurav Kumar",
+  "email": "gaurav.kumar@example.com",
+  "relationship": {
+    "director": 1,
+    "executive": 0
+  },
+  "phone": {
+    "primary": "7474747474",
+    "secondary": "7474747474"
+  },
+  "addresses": {
+    "residential": {
+      "street": "506, Koramangala 1st block",
+      "city": "Bengaluru",
+      "state": "Karnataka",
+      "postal_code": "560034",
+      "country": "IN"
+    }
+  },
+  "kyc": {
+    "pan": "AVOPB1111K"
+  },
+  "notes": {
+    "random_key_by_partner": "random_value"
+  }
+})
+```
+
+**Parameters:**
+
+| Name          | Type        | Description                                 |
+|---------------|-------------|---------------------------------------------|
+| email        | string      | The sub-merchant's business email address.  |
+| name*          | string      |  The stakeholder's name as per the PAN card. The maximum length is 255 characters.   |
+| percentage_ownership | float | The stakeholder's ownership of the business in percentage. Only two decimal places are allowed. For example, `87.55`. The maximum length is 100 characters. |
+| relationship         | boolean      | The stakeholder's relationship with the account’s business. |
+| phone         | object      | All keys listed [here](https://razorpay.com/docs/api/partners/stakeholder/#create-a-stakeholder) are supported |         
+| addresses         | object      | All keys listed [here](https://razorpay.com/docs/api/partners/stakeholder/#create-a-stakeholder) are supported |    
+| kyc         | object      | All keys listed [here](https://razorpay.com/docs/api/partners/stakeholder/#create-a-stakeholder) are supported |      
+| notes | object  | A key-value pair  |   
+
+**Response:**
+```json
+{
+  "entity": "stakeholder",
+  "relationship": {
+    "director": true
+  },
+  "phone": {
+    "primary": "7474747474",
+    "secondary": "7474747474"
+  },
+  "notes": {
+    "random_key_by_partner": "random_value"
+  },
+  "kyc": {
+    "pan": "AVOPB1111K"
+  },
+  "id": "sth_GLGgm8fFCKc92m",
+  "name": "Gaurav Kumar",
+  "email": "gaurav.kumar@example.com",
+  "percentage_ownership": 10,
+  "addresses": {
+    "residential": {
+      "street": "506, Koramangala 1st block",
+      "city": "Bengaluru",
+      "state": "Karnataka",
+      "postal_code": "560034",
+      "country": "IN"
+    }
+  }
+}
+```
+
+-------------------------------------------------------------------------------------------------------
+
+### Edit Stakeholder
+
+```rb
+accountId = "acc_GP4lfNA0iIMn5B";
+stakeholderId = "sth_GOQ4Eftlz62TSL";
+
+Razorpay::Stakeholder.edit(accountId, stakeholderId, {
+  "percentage_ownership": 20,
+  "name": "Gauri Kumar",
+  "relationship": {
+    "director": 0,
+    "executive": 1
+  },
+  "phone": {
+    "primary": "9898989898",
+    "secondary": "9898989898"
+  },
+  "addresses": {
+    "residential": {
+      "street": "507, Koramangala 1st block",
+      "city": "Bangalore",
+      "state": "Karnataka",
+      "postal_code": "560035",
+      "country": "IN"
+    }
+  },
+  "kyc": {
+    "pan": "AVOPB1111J"
+  },
+  "notes": {
+    "random_key_by_partner": "random_value2"
+  }
+})
+```
+
+**Parameters:**
+
+| Name          | Type        | Description                                 |
+|---------------|-------------|---------------------------------------------|
+| accountId* | string   | The unique identifier of a sub-merchant account generated by Razorpay.  |
+| stakeholderId* | string      | The unique identifier of the stakeholder whose details are to be fetched. |
+| name          | string      |  The stakeholder's name as per the PAN card. The maximum length is 255 characters.   |
+| percentage_ownership | float | The stakeholder's ownership of the business in percentage. Only two decimal places are allowed. For example, `87.55`. The maximum length is 100 characters. |
+| relationship         | boolean      | The stakeholder's relationship with the account’s business. |
+| phone         | object      | All keys listed [here](https://razorpay.com/docs/api/partners/stakeholder/#update-a-stakeholder) are supported |         
+| addresses         | object      | All keys listed [here](https://razorpay.com/docs/api/partners/stakeholder/#update-a-stakeholder) are supported |    
+| kyc         | object      | All keys listed [here](https://razorpay.com/docs/api/partners/stakeholder/#update-a-stakeholder) are supported |      
+| notes | object  | A key-value pair  |   
+
+**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"
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+### Fetch all accounts
+```rb
+accountId = "acc_GP4lfNA0iIMn5B";
+
+Razorpay::Stakeholder.all(accountId);
+```
+
+**Parameters:**
+
+| Name          | Type        | Description                                 |
+|---------------|-------------|---------------------------------------------|
+| accountId* | string   | The unique identifier of a sub-merchant account generated by Razorpay.  |
+
+**Response:**
+```json
+{
+  "entity": "collection",
+  "items": [
+    {
+      "id": "GZ13yPHLJof9IE",
+      "entity": "stakeholder",
+      "relationship": {
+        "director": true
+      },
+      "phone": {
+        "primary": "9000090000",
+        "secondary": "9000090000"
+      },
+      "notes": {
+        "random_key_by_partner": "random_value"
+      },
+      "kyc": {
+        "pan": "AVOPB1111K"
+      },
+      "name": "Gaurav Kumar",
+      "email": "gaurav.kumar@acme.org",
+      "percentage_ownership": 10,
+      "addresses": {
+        "residential": {
+          "street": "506, Koramangala 1st block",
+          "city": "Bengaluru",
+          "state": "Karnataka",
+          "postal_code": "560034",
+          "country": "in"
+        }
+      }
+    }
+  ],
+  "count": 1
+}
+```
+
+-------------------------------------------------------------------------------------------------------
+
+### Fetch an stakeholder
+```rb
+accountId = "acc_GP4lfNA0iIMn5B";
+
+stakeholderId = "sth_GOQ4Eftlz62TSL";
+
+Razorpay::Stakeholder.fetch(accountId, stakeholderId);
+```
+
+**Parameters:**
+
+| Name        | Type        | Description                                 |
+|-------------|-------------|---------------------------------------------|
+| accountId* | string      | The unique identifier of a sub-merchant account generated by Razorpay.  |
+| stakeholderId* | string      | The unique identifier of the stakeholder whose details are to be fetched. |
+
+**Response:**
+```json
+{
+  "entity": "stakeholder",
+  "relationship": {
+    "director": true
+  },
+  "phone": {
+    "primary": "9000090000",
+    "secondary": "9000090000"
+  },
+  "notes": {
+    "random_key_by_partner": "random_value2"
+  },
+  "kyc": {
+    "pan": "AVOPB1111J"
+  },
+  "id": "sth_GOQ4Eftlz62TSL",
+  "name": "Gauri Kumar",
+  "email": "gauri@example.com",
+  "percentage_ownership": 20,
+  "addresses": {
+    "residential": {
+      "street": "507, Koramangala 1st block",
+      "city": "Bangalore",
+      "state": "Karnataka",
+      "postal_code": "560035",
+      "country": "in"
+    }
+  }
+}
+```
+-------------------------------------------------------------------------------------------------------
+### Upload account documents
+```rb
+account_id = "acc_0000000000001"
+stakeholder_id = "sth_00000000000001"
+
+Razorpay::Stakeholder.upload_stakeholder_doc(account_id, stakeholder_id, {
+  "file": File.new("/Users/your_name/Downloads/sample_uploaded.jpeg"),
+  "document_type": "aadhar_front"
+});
+
+```
+
+**Parameters:**
+
+| Name        | Type        | Description                                 |
+|-------------|-------------|---------------------------------------------|
+| accountId* | string      | The unique identifier of a sub-merchant account generated by Razorpay.  |
+| stakeholderId* | string      | The unique identifier of the stakeholder whose details are to be fetched. |
+| 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. In case of individual_proof_of_address, both the front and back of a document proof must be uploaded. Possible values : <br> individual_proof_of_identification: `personal_pan` <br><br> individual_proof_of_address : `voter_id_back`, `voter_id_front`, `aadhar_front`, `aadhar_back`, `passport_front`, `passport_back` |
+
+**Response:**
+```json
+{
+  "individual_proof_of_address": [
+    {
+      "type": "aadhar_front",
+      "url": "https://rzp.io/i/bzDAbNg"
+    }
+  ]
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+### Fetch stakeholder documents
+```rb
+account_id = "acc_0000000000001"
+stakeholder_id = "sth_00000000000001"
+
+Razorpay::Stakeholder.fetch_stakeholder_doc(account_id, stakeholder_id)
+```
+
+**Parameters:**
+
+| Name        | Type        | Description                                 |
+|-------------|-------------|---------------------------------------------|
+| accountId* | string      | The unique identifier of a sub-merchant account generated by Razorpay.  |
+| stakeholderId* | string      | The unique identifier of the stakeholder whose details are to be fetched. |
+
+**Response:**
+```json
+{
+  "individual_proof_of_address": [
+    {
+      "type": "aadhar_front",
+      "document_id": "doc_GOgDZbg848e6bI"
+    }
+  ]
+}
+```
+-------------------------------------------------------------------------------------------------------
+**PN: * indicates mandatory fields**
+<br>
+<br>
+**For reference click [here](https://razorpay.com/docs/api/partners/stakeholder)**

data/documents/tokens.md

@@ -40,7 +40,7 @@ Razorpay::Payment.fetch(paymentId)
   "wallet": null,
   "vpa": null,
   "email": "gaurav.kumar@example.com",
-  "contact": "+919876543210",
+  "contact": "9999999999",
   "customer_id": "cust_DtHaBuooGHTuyZ",
   "token_id": "token_FHfn3rIiM1Z8nr",
   "notes": {
@@ -256,6 +256,151 @@ Razorpay::Customer.fetch(customerId).fetchTokens
 ```
 -------------------------------------------------------------------------------------------------------
 
+### Create a token
+
+```rb
+
+Razorpay::Token.create({
+  "customer_id": "cust_1Aa00000000001",
+  "method": "card",
+  "card": {
+    "number": "4111111111111111",
+    "cvv": "123",
+    "expiry_month": "12",
+    "expiry_year": "21",
+    "name": "Gaurav Kumar"
+  },
+  "authentication": {
+    "provider": "razorpay",
+    "provider_reference_id": "pay_123wkejnsakd",
+    "authentication_reference_number": "100222021120200000000742753928"  
+  },
+  "notes": []
+})
+```
+
+**Parameters:**
+
+| Name          | Type        | Description                                 |
+|---------------|-------------|---------------------------------------------|
+| customerId*          | string      | The id of the customer to be fetched |
+| method*          | string      |  The type of object that needs to be tokenised. Currently, `card` is the only supported value. |
+| card*         | object      | All keys listed [here](https://razorpay.com/docs/partners/aggregators/partner-auth/token-sharing/#create-token-on-behalf-of-a-sub-merchant) are supported
+|
+| authentication         | object      | All keys listed [here](https://razorpay.com/docs/partners/aggregators/partner-auth/token-sharing/#create-token-on-behalf-of-a-sub-merchant) are supported |     
+
+**Response:**
+```json
+{
+  "id": "token_IJmat4GwYATMtx",
+  "entity": "token",
+  "method": "card",
+  "card": {
+    "last4": "1111",
+    "network": "Visa",
+    "type": "credit",
+    "issuer": "IDFB",
+    "international": false,
+    "emi": false,
+    "sub_type": "consumer"
+  },
+  "customer": {
+    "id": "cust_1Aa00000000001",
+    "entity": "customer",
+    "name": "Bob",
+    "email": "bob@gmail.com",
+    "contact": "9000090000",
+    "gstin": null,
+    "notes": {
+      "notes_key_1": "Tea, Earl Grey, Hot",
+      "notes_key_2": "Tea, Earl Grey… decaf."
+    },
+    "created_at": 1658390470
+  },
+  "expired_at": 1701368999,
+  "customer_id": "cust_1Aa00000000001",
+  "compliant_with_tokenisation_guidelines": true,
+  "status": "active",
+  "notes": []
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+### Fetch token
+```rb
+Razorpay::Token.fetch({"id": "token_4lsdksD31GaZ09"});
+```
+
+**Parameters:**
+
+| Name        | Type        | Description                                 |
+|-------------|-------------|---------------------------------------------|
+| id* | string      | The unique identifier of a sub-merchant account generated by Razorpay.  |
+
+**Response:**
+```json
+{
+  "id": "token_4lsdksD31GaZ09",
+  "entity": "token",
+  "customer_id": "cust_1Aa00000000001",
+  "method": "card",
+  "card": {
+    "last4": "3335",
+    "network": "Visa",
+    "type": "debit",
+    "issuer": "HDFC",
+    "international": false,
+    "emi": true,
+    "sub_type": "consumer",
+    "token_iin": "453335"
+  },
+  "compliant_with_tokenisation_guidelines": true,
+  "expired_at": 1748716199,
+  "status": "active",
+  "status_reason": null,
+  "notes": []
+}
+```
+-------------------------------------------------------------------------------------------------------
+### Delete a token
+```rb
+Razorpay::Token.delete({"id": "token_4lsdksD31GaZ09"});
+```
+
+**Parameters:**
+
+| Name        | Type        | Description                                 |
+|-------------|-------------|---------------------------------------------|
+| id* | string      | The unique identifier of a sub-merchant account generated by Razorpay.  |
+
+**Response:**
+```json
+[]
+```
+-------------------------------------------------------------------------------------------------------
+
+### Process a Payment on another PA/PG with Token
+```rb
+Razorpay::Token.process_payment_on_alternate_pa_or_pg({"id":"spt_4lsdksD31GaZ09"});
+```
+
+**Parameters:**
+
+| Name        | Type        | Description                                 |
+|-------------|-------------|---------------------------------------------|
+| id* | string      | The unique identifier of the token whose details are to be fetched.  |
+
+**Response:**
+```json
+{ 
+  "card": {
+      "number": "4016981500100002",
+      "expiry_month" : "12",
+      "expiry_year" : 2021
+  }
+}
+```
+-------------------------------------------------------------------------------------------------------
 **PN: * indicates mandatory fields**
 <br>
 <br>