razorpay 3.0.0 → 3.1.0

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": {
@@ -184,7 +184,7 @@ customerId = "cust_1Aa00000000004"
 
 tokenId = "token_Hxe0skTXLeg9pF"
 
-Razorpay::fetch(customerId).deleteToken(tokenId)
+Razorpay::Customer.fetch(customerId).deleteToken(tokenId)
 ```
 
 **Parameters:**
@@ -201,7 +201,206 @@ Razorpay::fetch(customerId).deleteToken(tokenId)
 }
 ```
 -------------------------------------------------------------------------------------------------------
+### Fetch VPA tokens of a customer id
 
+```rb
+Razorpay::Customer.fetch(customerId).fetchTokens
+```
+
+**Parameters:**
+
+| Name          | Type        | Description                                 |
+|---------------|-------------|---------------------------------------------|
+| customerId*          | string      | The id of the customer to be fetched |
+
+**Response:**
+```json
+{
+  "entity": "collection",
+  "count": 1,
+  "items": [
+    {
+      "id": "token_EeroOjvOvorT5L",
+      "entity": "token",
+      "token": "4ydxm47GQjrIEx",
+      "bank": null,
+      "wallet": null,
+      "method": "card",
+      "card": {
+        "entity": "card",
+        "name": "Gaurav Kumar",
+        "last4": "8430",
+        "network": "Visa",
+        "type": "credit",
+        "issuer": "HDFC",
+        "international": false,
+        "emi": true,
+        "expiry_month": 12,
+        "expiry_year": 2022,
+        "flows": {
+          "otp": true,
+          "recurring": true
+        }
+      },
+      "vpa": null,
+      "recurring": false,
+      "auth_type": null,
+      "mrn": null,
+      "used_at": 1586976724,
+      "created_at": 1586976724,
+      "expired_at": 1672511399,
+      "dcc_enabled": false
+    }
+  ]
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+### 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>