From d56d97327a9789dbfc2c7afa67edee08d1c05e30 Mon Sep 17 00:00:00 2001 From: ankitdas13 Date: Thu, 30 Jun 2022 01:49:31 +0530 Subject: [PATCH] smartcollect doc correction --- documents/virtualAccount.md | 60 ++++++++++++++++++++----------------- 1 file changed, 32 insertions(+), 28 deletions(-) diff --git a/documents/virtualAccount.md b/documents/virtualAccount.md index 7cf2457e..b12f0796 100644 --- a/documents/virtualAccount.md +++ b/documents/virtualAccount.md @@ -21,7 +21,7 @@ client.virtual_account.create({ | Name | Type | Description | |---------------|-------------|---------------------------------------------| -| receivers* | object | Array that defines what receivers are available for this Virtual Account | +| receivers* | object | All parameters listed [here](https://razorpay.com/docs/api/payments/smart-collect/#create-virtual-account) are supported | | description | string | A brief description of the virtual account. | | customer_id | string | Unique identifier of the customer to whom the virtual account must be tagged. | | close_by | integer | UNIX timestamp at which the virtual account is scheduled to be automatically closed. | @@ -225,10 +225,10 @@ client.virtual_account.all(options) | 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) | +| from | timestamp | Timestamp, in seconds, from when virtual accounts are to be fetched. | +| to | timestamp | Timestamp, in seconds, till when virtual accounts are to be fetched. | +| count | integer | Number of virtual accounts to be fetched. The default value is 10 and the maximum value is 100. | +| skip | integer | Number of records to be skipped while fetching the virtual accounts. This can be used for pagination, in combination with `count`. | **Response:** ```json @@ -287,35 +287,38 @@ client.virtual_account.payments(virtualId,options) ```json { "entity": "collection", - "count": 1, + "count": 3, "items": [ { - "id": "pay_Di5iqCqA1WEHq6", + "id": "pay_JccakgG2EZbHZO", "entity": "payment", - "amount": 239000, + "amount": 10000, "currency": "INR", "status": "captured", "order_id": null, "invoice_id": null, "international": false, "method": "bank_transfer", - "amount_refunded": 0, - "refund_status": null, + "amount_refunded": 500, + "refund_status": "partial", "captured": true, "description": "", "card_id": null, "bank": null, "wallet": null, "vpa": null, - "email": "saurav.kumar@example.com", - "contact": "+919972139994", - "customer_id": "cust_DOMUFFiGdCaCUJ", + "email": null, + "contact": null, "notes": [], - "fee": 2820, - "tax": 430, + "fee": 118, + "tax": 18, "error_code": null, "error_description": null, - "created_at": 1574143644 + "error_source": null, + "error_step": null, + "error_reason": null, + "acquirer_data": {}, + "created_at": 1654171877 } ] } @@ -388,7 +391,6 @@ client.payment.bank_transfer(paymentId) ```py client.payment.refund(paymentId,{ "amount": "100", - "speed": "normal", "notes": { "notes_key_1": "Beam me up Scotty.", "notes_key_2": "Engage" @@ -410,20 +412,22 @@ client.payment.refund(paymentId,{ **Response:** ```json { - "id": "rfnd_E6j36ZEKvsWsEn", + "id": "rfnd_FP8QHiV938haTz", "entity": "refund", - "amount": 100, + "amount": 500100, + "receipt": "Receipt No. 31", "currency": "INR", - "payment_id": "pay_E54n391WnEAV9H", - "notes": { - "key_1": "value1", - "key_2": "value2" - }, + "payment_id": "pay_FCXKPFtYfPXJPy", + "notes": [] "receipt": null, "acquirer_data": { - "rrn": null + "arn": null }, - "created_at": 1579522301 + "created_at": 1597078866, + "batch_id": null, + "status": "processed", + "speed_processed": "normal", + "speed_requested": "normal" } ``` ------------------------------------------------------------------------------------------------------- @@ -431,7 +435,7 @@ client.payment.refund(paymentId,{ ### Add receiver to an existing virtual account ```py client.virtual_account.add_receiver(virtualId,{ - "type": [ + "types": [ "vpa" ], "vpa": { @@ -444,7 +448,7 @@ client.virtual_account.add_receiver(virtualId,{ | Name | Type | Description | |-------|-----------|--------------------------------------------------| -| virtualId* | string | The id of the virtual to be updated | +| virtualId* | string | All parameters listed [here](https://razorpay.com/docs/api/payments/smart-collect-tpv#add-receiver-to-an-existing-virtual-account) are supported | | types* | object | The receiver type to be added to the virtual account. Possible values are `vpa` or `bank_account` | | vpa | object | This is to be passed only when `vpa` is passed as the receiver types. |