razorpay 3.0.0 → 3.0.1

data/documents/transfers.md

@@ -43,31 +43,37 @@ Razorpay::Payment.fetch(paymentId).transfer(para_attr)
 **Response:**
 ```json
 {
-  "entity": "collection",
-  "count": 1,
-  "items": [
-    {
-      "id": "trf_E9uhYLFLLZ2pks",
-      "entity": "transfer",
-      "source": "pay_E8JR8E0XyjUSZd",
-      "recipient": "acc_CPRsN1LkFccllA",
-      "amount": 100,
-      "currency": "INR",
-      "amount_reversed": 0,
-      "notes": {
-        "name": "Gaurav Kumar",
-        "roll_no": "IEC2011025"
-      },
-      "on_hold": true,
-      "on_hold_until": 1671222870,
-      "recipient_settlement_id": null,
-      "created_at": 1580218356,
-      "linked_account_notes": [
-        "roll_no"
-      ],
-      "processed_at": 1580218357
-    }
-  ]
+  "id": "pay_DJiaO3iqUZaZrO",
+  "entity": "payment",
+  "amount": 5000,
+  "currency": "INR",
+  "status": "captured",
+  "order_id": null,
+  "invoice_id": null,
+  "international": false,
+  "method": "netbanking",
+  "amount_refunded": 0,
+  "refund_status": null,
+  "captured": true,
+  "description": "Credits towards consultation",
+  "card_id": null,
+  "bank": "UTIB",
+  "wallet": null,
+  "vpa": null,
+  "email": "void@razorpay.com",
+  "contact": "+919191919191",
+  "notes": [],
+  "fee": 171,
+  "tax": 26,
+  "error_code": null,
+  "error_description": null,
+  "error_source": null,
+  "error_step": null,
+  "error_reason": null,
+  "acquirer_data": {
+    "bank_transaction_id": "7909502"
+  },
+  "created_at": 1568822005
 }
 ```
 -------------------------------------------------------------------------------------------------------
@@ -119,59 +125,60 @@ Razorpay::Order.create(para_attr)
 | amount*   | integer      | The transaction amount, in paise |
 | currency*   | string  | The currency of the payment (defaults to INR)  |
 |  receipt      | string      | A unique identifier provided by you for your internal reference. |
-| transfers["account"]*   | string     | The id of the account to be fetched   |
-| transfers["amount"]*   | integer     | The transaction amount, in paise |
-| transfers["currency"]*   | string     | The currency of the payment (defaults to INR)  |
-| transfers["notes"]   | object     | Key-value pair that can be used to store additional  |
-| transfers["linked_account_notes"]   | array     | A key-value pair  |
-| transfers["on_hold"]*   | boolean     | Possible values is `0` or `1`  |
-| transfers["on_hold_until"]   | integer     | Timestamp, in Unix, that indicates until when the settlement of the transfer must be put on hold |
+| transfers   | array     | All parameters listed [here](https://razorpay.com/docs/api/route/#create-transfers-from-orders) are supported |
 
 **Response:**
 ```json
 {
-  "id": "order_E9uTczH8uWPCyQ",
-  "entity": "order",
-  "amount": 2000,
-  "amount_paid": 0,
-  "amount_due": 2000,
-  "currency": "INR",
-  "receipt": null,
-  "offer_id": null,
-  "status": "created",
-  "attempts": 0,
-  "notes": [],
-  "created_at": 1580217565,
-  "transfers": [
-    {
-      "recipient": "acc_CPRsN1LkFccllA",
-      "amount": 1000,
-      "currency": "INR",
-      "notes": {
-        "branch": "Acme Corp Bangalore North",
-        "name": "Gaurav Kumar"
-      },
-      "linked_account_notes": [
-        "branch"
-      ],
-      "on_hold": true,
-      "on_hold_until": 1671222870
-    },
-    {
-      "recipient": "acc_CNo3jSI8OkFJJJ",
-      "amount": 1000,
-      "currency": "INR",
-      "notes": {
-        "branch": "Acme Corp Bangalore South",
-        "name": "Saurav Kumar"
-      },
-      "linked_account_notes": [
-        "branch"
-      ],
-      "on_hold": false,
-      "on_hold_until": null
-    }
-  ]
+    "id": "order_Jhf1Sn06my7AUb",
+    "entity": "order",
+    "amount": 2000,
+    "amount_paid": 0,
+    "amount_due": 2000,
+    "currency": "INR",
+    "receipt": null,
+    "offer_id": "offer_JGQvQtvJmVDRIA",
+    "offers": [
+        "offer_JGQvQtvJmVDRIA"
+    ],
+    "status": "created",
+    "attempts": 0,
+    "notes": [],
+    "created_at": 1655272138,
+    "transfers": [
+        {
+            "id": "trf_Jhf1SpAYVIeRoP",
+            "entity": "transfer",
+            "status": "created",
+            "source": "order_Jhf1Sn06my7AUb",
+            "recipient": "acc_HjVXbtpSCIxENR",
+            "amount": 1000,
+            "currency": "INR",
+            "amount_reversed": 0,
+            "notes": {
+                "branch": "Acme Corp Bangalore North",
+                "name": "Gaurav Kumar"
+            },
+            "linked_account_notes": [
+                "branch"
+            ],
+            "on_hold": true,
+            "on_hold_until": 1671222870,
+            "recipient_settlement_id": null,
+            "created_at": 1655272138,
+            "processed_at": null,
+            "error": {
+                "code": null,
+                "description": null,
+                "reason": null,
+                "field": null,
+                "step": null,
+                "id": "trf_Jhf1SpAYVIeRoP",
+                "source": null,
+                "metadata": null
+            }
+        }
+    ]
 }
 ```
 -------------------------------------------------------------------------------------------------------
@@ -195,26 +202,41 @@ Razorpay::Transfer.create(para_attr)
 | accountId*   | string      | The id of the account to be fetched  |
 | amount*   | integer      | The amount to be captured (should be equal to the authorized amount, in paise) |
 | currency*   | string  | The currency of the payment (defaults to INR)  |
+| notes | object | | A key-value pair   |
 
 **Response:**
 ```json
 {
-  "id": "trf_E9utgtfGTcpcmm",
-  "entity": "transfer",
-  "source": "acc_CJoeHMNpi0nC7k",
-  "recipient": "acc_CPRsN1LkFccllA",
-  "amount": 100,
-  "currency": "INR",
-  "amount_reversed": 0,
-  "notes": [],
-  "fees": 1,
-  "tax": 0,
-  "on_hold": false,
-  "on_hold_until": null,
-  "recipient_settlement_id": null,
-  "created_at": 1580219046,
-  "linked_account_notes": [],
-  "processed_at": 1580219046
+   "id":"trf_E9utgtfGTcpcmm",
+   "entity":"transfer",
+   "transfer_status":"pending",
+   "settlement_status":null,
+   "source":"acc_CJoeHMNpi0nC7k",
+   "recipient":"acc_CPRsN1LkFccllA",
+   "amount":100,
+   "currency":"INR",
+   "amount_reversed":0,
+   "notes":[
+      
+   ],
+   "fees":1,
+   "tax":0,
+   "on_hold":false,
+   "on_hold_until":null,
+   "recipient_settlement_id":null,
+   "created_at":1580219046,
+   "linked_account_notes":[
+      
+   ],
+   "processed_at":null,
+   "error":{
+      "code":null,
+      "description":null,
+      "field":null,
+      "source":null,
+      "step":null,
+      "reason":null
+   }
 }
 ```
 -------------------------------------------------------------------------------------------------------
@@ -224,7 +246,7 @@ Razorpay::Transfer.create(para_attr)
 ```rb
 paymentId = "pay_E8JR8E0XyjUSZd"
 
-Razorpay::Payment.fetch_transfer(paymentId)
+Razorpay::Payment.fetch(paymentId).fetch_transfer
 ```
 
 **Parameters:**
@@ -279,44 +301,53 @@ Razorpay::Order.fetch_transfer_order(orderId)
 **Response:**
 ```json
 {
-  "id": "order_DSkl2lBNvueOly",
+  "id": "order_I7waiV9PUGADuv",
   "entity": "order",
-  "amount": 1000,
-  "amount_paid": 1000,
+  "amount": 50000,
+  "amount_paid": 50000,
   "amount_due": 0,
   "currency": "INR",
-  "receipt": null,
+  "receipt": "55",
   "offer_id": null,
   "status": "paid",
   "attempts": 1,
-  "notes": [],
-  "created_at": 1570794714,
+  "notes": {
+    "woocommerce_order_number": "55"
+  },
+  "created_at": 1633936677,
   "transfers": {
     "entity": "collection",
     "count": 1,
     "items": [
       {
-        "id": "trf_DSkl2lXWbiADZG",
+        "id": "trf_I7waiajxgS5jWL",
         "entity": "transfer",
-        "source": "order_DSkl2lBNvueOly",
-        "recipient": "acc_CNo3jSI8OkFJJJ",
-        "amount": 500,
+        "status": "processed",
+        "source": "order_I7waiV9PUGADuv",
+        "recipient": "acc_HalyQGZh9ZyiGg",
+        "amount": 10000,
         "currency": "INR",
         "amount_reversed": 0,
-        "notes": {
-          "branch": "Acme Corp Bangalore North",
-          "name": "Gaurav Kumar"
-        },
-        "fees": 2,
-        "tax": 0,
-        "on_hold": true,
-        "on_hold_until": 1670776632,
+        "fees": 12,
+        "tax": 2,
+        "notes": [],
+        "linked_account_notes": [],
+        "on_hold": false,
+        "on_hold_until": null,
+        "settlement_status": "pending",
         "recipient_settlement_id": null,
-        "created_at": 1570794714,
-        "linked_account_notes": [
-          "Acme Corp Bangalore North"
-        ],
-        "processed_at": 1570794772
+        "created_at": 1633936677,
+        "processed_at": 1633936700,
+        "error": {
+          "code": null,
+          "description": null,
+          "reason": null,
+          "field": null,
+          "step": null,
+          "id": "trf_I7waiajxgS5jWL",
+          "source": null,
+          "metadata": null
+        }
       }
     ]
   }
@@ -342,22 +373,39 @@ Razorpay::Transfer.fetch(transferId)
 **Response:**
 ```json
 {
-  "id": "trf_E7V62rAxJ3zYMo",
+  "id": "trf_JJD536GI6wuz3m",
   "entity": "transfer",
-  "source": "pay_E6j30Iu1R7XbIG",
-  "recipient": "acc_CMaomTz4o0FOFz",
-  "amount": 100,
+  "status": "processed",
+  "source": "pay_JGmCgTEa9OTQcX",
+  "recipient": "acc_IRQWUleX4BqvYn",
+  "amount": 300,
   "currency": "INR",
   "amount_reversed": 0,
-  "notes": [],
   "fees": 1,
   "tax": 0,
+  "notes": {
+    "name": "Saurav Kumar",
+    "roll_no": "IEC2011026"
+  },
+  "linked_account_notes": [
+    "roll_no"
+  ],
   "on_hold": false,
   "on_hold_until": null,
+  "settlement_status": "pending",
   "recipient_settlement_id": null,
-  "created_at": 1579691505,
-  "linked_account_notes": [],
-  "processed_at": 1579691505
+  "created_at": 1649933574,
+  "processed_at": 1649933579,
+  "error": {
+    "code": null,
+    "description": null,
+    "reason": null,
+    "field": null,
+    "step": null,
+    "id": "trf_JJD536GI6wuz3m",
+    "source": null,
+    "metadata": null
+  }
 }
 ```
 -------------------------------------------------------------------------------------------------------
@@ -385,22 +433,34 @@ Razorpay::Transfer.all({
   "count": 1,
   "items": [
     {
-      "id": "trf_DGSTeXzBkEVh48",
+      "id": "trf_HWjmkReRGPhguR",
       "entity": "transfer",
-      "source": "pay_DGSRhvMbOqeCe7",
-      "recipient": "acc_CMaomTz4o0FOFz",
-      "amount": 500,
+      "status": "processed",
+      "source": "pay_HWjY9DZSMsbm5E",
+      "recipient": "acc_HWjl1kqobJzf4i",
+      "amount": 1000,
       "currency": "INR",
       "amount_reversed": 0,
-      "notes": [],
-      "fees": 2,
+      "fees": 3,
       "tax": 0,
+      "notes": [],
+      "linked_account_notes": [],
       "on_hold": false,
       "on_hold_until": null,
-      "recipient_settlement_id": "setl_DHYJ3dRPqQkAgV",
-      "created_at": 1568110256,
-      "linked_account_notes": [],
-      "processed_at": null
+      "settlement_status": "settled",
+      "recipient_settlement_id": "setl_HYIIk3H0J4PYdX",
+      "created_at": 1625812996,
+      "processed_at": 1625812996,
+      "error": {
+        "code": null,
+        "description": null,
+        "reason": null,
+        "field": null,
+        "step": null,
+        "id": "trf_HWjmkReRGPhguR",
+        "source": null,
+        "metadata": null
+      }
     }
   ]
 }
@@ -420,32 +480,35 @@ Razorpay::Transfer.fetch_settlements
   "count": 1,
   "items": [
     {
-      "id": "trf_DGSTeXzBkEVh48",
+      "id": "trf_JnRRvcSbZb1VHN",
       "entity": "transfer",
-      "source": "pay_DGSRhvMbOqeCe7",
-      "recipient": "acc_CMaomTz4o0FOFz",
+      "status": "processed",
+      "source": "acc_HZbJUcl6DBDLIN",
+      "recipient": "acc_HjVXbtpSCIxENR",
       "amount": 500,
       "currency": "INR",
       "amount_reversed": 0,
-      "notes": [],
-      "fees": 2,
+      "fees": 1,
       "tax": 0,
+      "notes": [],
+      "linked_account_notes": [],
       "on_hold": false,
       "on_hold_until": null,
-      "recipient_settlement_id": "setl_DHYJ3dRPqQkAgV",
-      "recipient_settlement": {
-        "id": "setl_DHYJ3dRPqQkAgV",
-        "entity": "settlement",
-        "amount": 500,
-        "status": "failed",
-        "fees": 0,
-        "tax": 0,
-        "utr": "CN0038699836",
-        "created_at": 1568349124
-      },
-      "created_at": 1568110256,
-      "linked_account_notes": [],
-      "processed_at": null
+      "settlement_status": null,
+      "recipient_settlement_id": null,
+      "recipient_settlement": null,
+      "created_at": 1656534379,
+      "processed_at": 1656534379,
+      "error": {
+        "code": null,
+        "description": null,
+        "reason": null,
+        "field": null,
+        "step": null,
+        "id": "trf_JnRRvcSbZb1VHN",
+        "source": null,
+        "metadata": null
+      }
     }
   ]
 }
@@ -458,8 +521,8 @@ Razorpay::Transfer.fetch_settlements
 paymentId = "pay_EAdwQDe4JrhOFX"
 
 para_attr = {
-    "amount" : 100,
-    "reverse_all" : 1
+    "amount": 100,
+    "reverse_all": 1
 }
 
 Razorpay::Payment.fetch(paymentId).refund(para_attr)
@@ -476,17 +539,21 @@ Razorpay::Payment.fetch(paymentId).refund(para_attr)
 **Response:**
 ```json
 {
-  "id": "rfnd_EAzovSwG8jBnGf",
+  "id": "rfnd_JJFNlNXPHY640A",
   "entity": "refund",
   "amount": 100,
   "currency": "INR",
-  "payment_id": "pay_EAdwQDe4JrhOFX",
+  "payment_id": "pay_JJCqynf4fQS0N1",
   "notes": [],
   "receipt": null,
   "acquirer_data": {
-    "rrn": null
+    "arn": null
   },
-  "created_at": 1580454723
+  "created_at": 1649941680,
+  "batch_id": null,
+  "status": "processed",
+  "speed_processed": "normal",
+  "speed_requested": "normal"
 }
 ```
 -------------------------------------------------------------------------------------------------------
@@ -509,34 +576,40 @@ Razorpay::Payment.all
 ```json
 {
   "entity": "collection",
-  "count": 2,
+  "count": 1,
   "items": [
     {
-      "id": "pay_E9uth3WhYbh9QV",
+      "id": "pay_JJCqynf4fQS0N1",
       "entity": "payment",
-      "amount": 100,
+      "amount": 10000,
       "currency": "INR",
       "status": "captured",
-      "order_id": null,
+      "order_id": "order_JJCqnZG8f3754z",
       "invoice_id": null,
-      "international": null,
-      "method": "transfer",
+      "international": false,
+      "method": "netbanking",
       "amount_refunded": 0,
       "refund_status": null,
       "captured": true,
-      "description": null,
+      "description": "#JJCqaOhFihfkVE",
       "card_id": null,
-      "bank": null,
+      "bank": "YESB",
       "wallet": null,
       "vpa": null,
-      "email": "",
-      "contact": null,
+      "email": "john.example@example.com",
+      "contact": "+919820958250",
       "notes": [],
-      "fee": 0,
-      "tax": 0,
+      "fee": 236,
+      "tax": 36,
       "error_code": null,
       "error_description": null,
-      "created_at": 1580219046
+      "error_source": null,
+      "error_step": null,
+      "error_reason": null,
+      "acquirer_data": {
+        "bank_transaction_id": "2118867"
+      },
+      "created_at": 1649932775
     }
   ]
 }
@@ -613,22 +686,31 @@ Razorpay::Payment.fetch(paymentId).transfer(para_attr)
   "count": 1,
   "items": [
     {
-      "id": "trf_EB1VJ4Ux4GMmxQ",
+      "id": "trf_Jfm1KCF6w1oWgy",
       "entity": "transfer",
-      "source": "pay_EB1R2s8D4vOAKG",
-      "recipient": "acc_CMaomTz4o0FOFz",
+      "status": "pending",
+      "source": "pay_JXPULbHbkkkS8D",
+      "recipient": "acc_I0QRP7PpvaHhpB",
       "amount": 100,
       "currency": "INR",
       "amount_reversed": 0,
       "notes": [],
-      "fees": 1,
-      "tax": 0,
+      "linked_account_notes": [],
       "on_hold": true,
       "on_hold_until": null,
       "recipient_settlement_id": null,
-      "created_at": 1580460652,
-      "linked_account_notes": [],
-      "processed_at": 1580460652
+      "created_at": 1654860101,
+      "processed_at": null,
+      "error": {
+        "code": null,
+        "description": null,
+        "reason": null,
+        "field": null,
+        "step": null,
+        "id": "trf_Jfm1KCF6w1oWgy",
+        "source": null,
+        "metadata": null
+      }
     }
   ]
 }
@@ -637,7 +719,7 @@ Razorpay::Payment.fetch(paymentId).transfer(para_attr)
 
 ### Modify settlement hold for transfers
 ```rb
-paymentId = "pay_EAeSM2Xul8xYRo"
+transferId = "trf_JhemwjNekar9Za"
 
 para_attr = {
   "on_hold": "1",
@@ -657,22 +739,37 @@ Razorpay::Transfer.fetch(transferId).edit(para_attr)
 **Response:**
 ```json
 {
-  "id": "trf_EB17rqOUbzSCEE",
-  "entity": "transfer",
-  "source": "pay_EAeSM2Xul8xYRo",
-  "recipient": "acc_CMaomTz4o0FOFz",
-  "amount": 100,
-  "currency": "INR",
-  "amount_reversed": 0,
-  "notes": [],
-  "fees": 1,
-  "tax": 0,
-  "on_hold": true,
-  "on_hold_until": 1679691505,
-  "recipient_settlement_id": null,
-  "created_at": 1580459321,
-  "linked_account_notes": [],
-  "processed_at": 1580459321
+    "entity": "collection",
+    "count": 1,
+    "items": [
+        {
+            "id": "trf_JhemwjNekar9Za",
+            "entity": "transfer",
+            "status": "pending",
+            "source": "pay_I7watngocuEY4P",
+            "recipient": "acc_HjVXbtpSCIxENR",
+            "amount": 100,
+            "currency": "INR",
+            "amount_reversed": 0,
+            "notes": [],
+            "linked_account_notes": [],
+            "on_hold": true,
+            "on_hold_until": null,
+            "recipient_settlement_id": null,
+            "created_at": 1655271313,
+            "processed_at": null,
+            "error": {
+                "code": null,
+                "description": null,
+                "reason": null,
+                "field": null,
+                "step": null,
+                "id": "trf_JhemwjNekar9Za",
+                "source": null,
+                "metadata": null
+            }
+        }
+    ]
 }
 ```