Skip to content

Qr doc correction #208

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 1 commit into from
Jul 1, 2022
Merged

Qr doc correction #208

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
66 changes: 56 additions & 10 deletions documents/qrcode.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ client.qrcode.create({
"type": "upi_qr",
"name": "Store_1",
"usage": "single_use",
"fixed_amount": true,
"fixed_amount": True,
"payment_amount": 300,
"description": "For Store 1",
"customer_id": "cust_HKsR5se84c5LTO",
Expand Down Expand Up @@ -240,24 +240,27 @@ client.qrcode.fetch(qrCodeId)
"count": 1,
"items": [
{
"id": "qr_HMsgvioW64f0vh",
"id": "qr_HO2r1MDprYtWRT",
"entity": "qr_code",
"created_at": 1623660959,
"created_at": 1623915088,
"name": "Store_1",
"usage": "single_use",
"type": "upi_qr",
"image_url": "https://rzp.io/i/DTa2eQR",
"image_url": "https://rzp.io/i/oCswTOcCo",
"payment_amount": 300,
"status": "active",
"status": "closed",
"description": "For Store 1",
"fixed_amount": true,
"payments_amount_received": 0,
"payments_count_received": 0,
"payments_amount_received": 300,
"payments_count_received": 1,
"notes": {
"purpose": "Test UPI QR code notes"
},
"customer_id": "cust_HKsR5se84c5LTO",
"close_by": 1681615838
"close_by": 1681615838,
"closed_at": 1625558914,
"close_reason": "paid",
"tax_invoice": null
}
]
}
Expand Down Expand Up @@ -299,7 +302,8 @@ client.qrcode.fetch(qrCodeId)
"notes": [],
"customer_id": "cust_HKsR5se84c5LTO",
"close_by": 1624472999,
"close_reason": null
"close_reason": "paid",
"tax_invoice": null
}
]
}
Expand Down Expand Up @@ -370,7 +374,7 @@ client.qrcode.fetch_all_payments(qrCodeId, options)
### Close a QR Code

```py
client.qrcode.close(qrCodeId);
client.qrcode.close(qrCodeId)
```

**Parameters:**
Expand Down Expand Up @@ -406,6 +410,48 @@ client.qrcode.close(qrCodeId);
```
-------------------------------------------------------------------------------------------------------

### Refund a Payment

```py
client.payment.refund("pay_JRP3Y66cNcf2qF",{
"amount": "100",
"notes": {
"notes_key_1": "Beam me up Scotty.",
"notes_key_2": "Engage"
}
})
```

**Parameters:**

| Name | Type | Description |
|-----------------|---------|------------------------------------------------------------------------------|
| paymentId* | string | The id of the payment to be refunded |
| amount | string | Amount to be refunded |
| notes | array | Key-value pair that can be used to store additional information about the QR code. Maximum 15 key-value pairs, 256 characters (maximum) each. |

**Response:**
```json
{
"id": "rfnd_FP8QHiV938haTz",
"entity": "refund",
"amount": 500100,
"receipt": "Receipt No. 31",
"currency": "INR",
"payment_id": "pay_29QQoUBi66xm2f",
"notes": [],
"receipt": null,
"acquirer_data": {
"arn": null
},
"created_at": 1597078866,
"batch_id": null,
"status": "processed",
"speed_processed": "normal",
"speed_requested": "normal"
}
```
-------------------------------------------------------------------------------------------------------

**PN: * indicates mandatory fields**
<br>
Expand Down