update payment types

razorpay · Dec 29, 2023 · ddb7a03 · ddb7a03
1 parent dc9f386
commit ddb7a03
Show file tree

Hide file tree

Showing 2 changed files with 196 additions and 2 deletions.
diff --git a/documents/payment.md b/documents/payment.md
@@ -877,6 +877,196 @@ instance.iins.fetch(tokenIin);
 }
 ```
 -------------------------------------------------------------------------------------------------------
+
+### Fetch a Payment (With Expanded Card Details)
+
+```js
+var paymentId = "pay_MLzFlOC98cJmHQ";
+
+instance.payments.fetch(paymentId, {"expand[]": "card"});
+```
+
+| Name        | Type    | Description                          |
+|-------------|---------|--------------------------------------|
+| paymentId*    | integer | Unique identifier of the payment                                               |
+| expand[]    | string | Use to expand the card details when the payment method is `card`.   |
+
+**Response:**
+```json
+{
+  "id": "pay_H9oR0gLCaVlV6m",
+  "entity": "payment",
+  "amount": 100,
+  "currency": "INR",
+  "status": "failed",
+  "order_id": "order_H9o58N6qmLYQKC",
+  "invoice_id": null,
+  "terminal_id": "term_G5kJnYM9GhhLYT",
+  "method": "card",
+  "amount_refunded": 0,
+  "refund_status": null,
+  "captured": false,
+  "description": null,
+  "card_id": "card_H9oR0ocen1cmZq",
+  "card": {
+    "id": "card_H9oR0ocen1cmZq",
+    "entity": "card",
+    "name": "Gaurav",
+    "last4": "1213",
+    "network": "RuPay",
+    "type": "credit",
+    "issuer": "UTIB",
+    "international": false,
+    "emi": false,
+    "sub_type": "business"
+  },
+  "bank": null,
+  "wallet": null,
+  "vpa": null,
+  "email": "[email protected]",
+  "contact": "+919000090000",
+  "notes": {
+    "email": "[email protected]",
+    "phone": "09000090000"
+  },
+  "fee": null,
+  "tax": null,
+  "error_code": "BAD_REQUEST_ERROR",
+  "error_description": "Card issuer is invalid",
+  "error_source": "customer",
+  "error_step": "payment_authentication",
+  "error_reason": "incorrect_card_details",
+  "acquirer_data": {
+    "auth_code": null,
+    "authentication_reference_number": "100222021120200000000742753928"
+  },
+  "created_at": 1620807547
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+### Fetch a Payment (With Expanded Offers Details)
+
+```js
+var paymentId = "pay_MLzFlOC98cJmHQ";
+
+instance.payments.fetch(paymentId, {"expand[]": "emi"});
+```
+
+**Parameters:**
+
+| Name        | Type    | Description                          |
+|-------------|---------|--------------------------------------|
+| paymentId*    | integer | Unique identifier of the payment                                               |
+| expand[]    | string | Use to expand the emi details when the payment method is emi.   |
+
+**Response:** <br>
+
+```json
+{
+  "id": "pay_DG4ZdRK8ZnXC3k",
+  "entity": "payment",
+  "amount": 200000,
+  "currency": "INR",
+  "status": "authorized",
+  "order_id": null,
+  "invoice_id": null,
+  "international": false,
+  "method": "emi",
+  "amount_refunded": 0,
+  "refund_status": null,
+  "captured": false,
+  "description": null,
+  "card_id": "card_DG4ZdUO3xABb20",
+  "bank": "ICIC",
+  "wallet": null,
+  "vpa": null,
+  "email": "[email protected]",
+  "contact": "+919972000005",
+  "notes": [],
+  "fee": null,
+  "tax": null,
+  "error_code": null,
+  "error_description": null,
+  "error_source": null,
+  "error_step": null,
+  "error_reason": null,
+  "emi": {
+    "issuer": "ICIC",
+    "rate": 1300,
+    "duration": 6
+  },
+  "acquirer_data": {
+    "auth_code": "828553"
+  },
+  "created_at": 1568026077
+}
+```
+
+-------------------------------------------------------------------------------------------------------
+###
+
+```js
+var paymentId = "pay_MLzFlOC98cJmHQ";
+
+instance.payments.fetch(paymentId, {"expand[]": "upi"});
+```
+
+**Parameters:**
+
+| Name        | Type    | Description                          |
+|-------------|---------|--------------------------------------|
+| paymentId*    | integer | Unique identifier of the payment                                               |
+| expand[]    | string | Use to expand the UPI details when the payment method is upi. |
+
+**Response:** <br>
+
+```json
+
+{
+  "id": "pay_DG4ZdRK8ZnXC3k",
+  "entity": "payment",
+  "amount": 100,
+  "currency": "INR",
+  "status": "captured",
+  "order_id": "order_GjCr5oKh4AVC51",
+  "invoice_id": null,
+  "international": false,
+  "method": "upi",
+  "amount_refunded": 0,
+  "refund_status": null,
+  "captured": true,
+  "description": "Payment for Adidas shoes",
+  "card_id": null,
+  "bank": null,
+  "wallet": null,
+  "vpa": "gaurav.kumar@upi",
+  "email": "[email protected]",
+  "contact": "9000090000",
+  "customer_id": "cust_K6fNE0WJZWGqtN",
+  "token_id": "token_KOdY$DBYQOv08n",
+  "notes": [],
+  "fee": 1,
+  "tax": 0,
+  "error_code": null,
+  "error_description": null,
+  "error_source": null,
+  "error_step": null,
+  "error_reason": null,
+  "acquirer_data": {
+    "rrn": "303107535132"
+  },
+  "created_at": 1605871409,
+  "upi": {
+    "payer_account_type": "credit_card",
+    "vpa": "gaurav.kumar@upi",
+    "flow": "in_app"
+  }
+}
+```
+
+-------------------------------------------------------------------------------------------------------
+
 **PN: * indicates mandatory fields**
 <br>
 <br>

diff --git a/lib/types/payments.d.ts b/lib/types/payments.d.ts
@@ -555,6 +555,10 @@ export declare namespace Payments {
         entity: string;
     }
 
+    interface ExpandDetails {
+       'expand[]': 'card' | 'emi' | 'offers' | 'upi'  
+    }
+
 }
 
 declare function payments(api: any): {
@@ -581,8 +585,8 @@ declare function payments(api: any): {
     * @param params - Check [doc](https://razorpay.com/docs/api/payments/#fetch-a-payment) for required params
     *
     */
-    fetch(paymentId: string, params?: { 'expand[]': 'card' | 'emi' | 'offers' }): Promise<Payments.RazorpayPayment>
-    fetch(paymentId: string, params: { 'expand[]': 'card' | 'emi' | 'offers' }, callback: (err: INormalizeError | null, data: Payments.RazorpayPayment) => void): void
+    fetch(paymentId: string, params?: Payments.ExpandDetails): Promise<Payments.RazorpayPayment>
+    fetch(paymentId: string, params: Payments.ExpandDetails, callback: (err: INormalizeError | null, data: Payments.RazorpayPayment) => void): void
     /**
     * Capture payment
     *