Skip to content

refund doc correction #197

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ankitdas13 merged 4 commits into from
Jul 1, 2022
Merged

refund doc correction #197

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a4b3cb8
refund doc correction
ankitdas13 Jun 15, 2022
b6f225a
update response parameter
ankitdas13 Jul 1, 2022
e6fa144
response param change
ankitdas13 Jul 1, 2022
45aac00
response param update
ankitdas13 Jul 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 30 additions & 28 deletions documents/refund.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ client.payment.refund(paymentId,{
"notes_key_1": "Beam me up Scotty.",
"notes_key_2": "Engage"
},
"receipt": "Receipt No. 31"
"receipt": "#Receipt No. 131"
})
```

Expand All @@ -27,20 +27,24 @@ client.payment.refund(paymentId,{
**Response:**
```json
{
"id": "rfnd_FP8QHiV938haTz",
"id": "rfnd_JnzyQwYOOBNJJu",
"entity": "refund",
"amount": 500100,
"receipt": "Receipt No. 31",
"amount": 100,
"currency": "INR",
"payment_id": "pay_FCXKPFtYfPXJPy",
"notes": [],
"payment_id": "pay_JRSS9bMrRMds3w",
"notes": {
"notes_key_1": "Beam me up Scotty.",
"notes_key_2": "Engage"
},
"receipt": "#Receipt No. 131",
"acquirer_data": {
"arn": null
},
"created_at": 1597078866,
"created_at": 1656655960,
"batch_id": null,
"status": "processed",
"speed_processed": "normal"
"speed_processed": "normal",
"speed_requested": "normal"
}
```
-------------------------------------------------------------------------------------------------------
Expand All @@ -51,7 +55,7 @@ client.payment.refund(paymentId,{
client.payment.refund(paymentId,{
"amount": "100",
"speed": "optimum",
"receipt": "Receipt No. 31"
"receipt": "#Receipt No. 132"
})
```

Expand All @@ -67,22 +71,20 @@ client.payment.refund(paymentId,{
**Response:**
```json
{
"id": "rfnd_FP8R8EGjGbPkVb",
"id": "rfnd_Jo00DtIBzADMi6",
"entity": "refund",
"amount": 500100,
"amount": 100,
"currency": "INR",
"payment_id": "pay_FC8MmhMBZPKDHF",
"notes": {
"notes_key_1": "Tea, Earl Grey, Hot",
"notes_key_2": "Tea, Earl Grey… decaf."
},
"receipt": "Receipt No. 31",
"payment_id": "pay_JRP3Y66cNcf2qF",
"notes": [],
"receipt": "#Receipt No. 132",
"acquirer_data": {
"arn": null
},
"created_at": 1597078914,
"created_at": 1656656062,
"batch_id": null,
"status": "processed",
"status": "pending",
"speed_processed": "instant",
"speed_requested": "optimum"
}
```
Expand All @@ -99,10 +101,10 @@ client.payment.fetch_multiple_refund(paymentId,option)
| Name | Type | Description |
|-------|-----------|--------------------------------------------------|
| paymentId* | string | The id of the payment |
| 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 after which the refunds were created |
| to | timestamp | timestamp before which the refunds were created |
| count | integer | number of refunds to fetch (default: 10) |
| skip | integer | number of refunds to be skipped (default: 0) |

**Refund:**
```json
Expand Down Expand Up @@ -179,10 +181,10 @@ client.refund.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 after which the refunds were created |
| to | timestamp | timestamp before which the refunds were created |
| count | integer | number of refunds to fetch (default: 10) |
| skip | integer | number of refunds to be skipped (default: 0) |

**Response:**
```json
Expand Down Expand Up @@ -249,7 +251,7 @@ client.refund.fetch(refundId)

### Update the refund
```py
client.refund.edit({
client.refund.edit(refundId,{
"notes": {
"notes_key_1": "Beam me up Scotty.",
"notes_key_2": "Engage"
Expand Down