Skip to content

Commit de91e57

Browse files
committed
Minor, README.md updated for better understanding.
1 parent a9f38f1 commit de91e57

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -35,18 +35,18 @@ This package will work on client and server.
3535

3636
### Fields detail:
3737

38-
| Fields | Description | Required |
39-
|-------------------|---------------------------------------------------|-----------|
40-
| payeeVPA | VPA address from UPI payment account | Mandatory |
41-
| payeeName | Merchant Name registered in UPI payment account | Mandatory |
42-
| payeeMerchantCode | Merchant Code from UPI payment account | Optional |
43-
| transactionId | Unique transaction id for merchant's reference | Optional |
44-
| transactionRef | Unique transaction id for merchant's reference | Optional |
45-
| transactionNote | Note will appear in payment app while transaction | Optional |
46-
| amount | Amount | Optional |
47-
| minimumAmount | Minimum amount that has to be transferred | Optional |
48-
| currency | Currency of amount (default: INR) | Optional |
49-
| transactionRefUrl | URL for the order | Optional |
38+
| Fields | Description | Required |
39+
|--------------------|---------------------------------------------------|-----------|
40+
| `payeeVPA` | UPI ID of the payee (e.g., `example@upi`). | Yes |
41+
| `payeeName` | Registered name of the payee (e.g., `John Doe`). | Yes |
42+
| `payeeMerchantCode`| Merchant Code from UPI payment account | No |
43+
| `transactionId` | Unique transaction id for merchant's reference | No |
44+
| `transactionRef` | Unique transaction id for merchant's reference | No |
45+
| `transactionNote` | Note for the payment (e.g., `Electricity Bill`). | No |
46+
| `amount` | Amount | No |
47+
| `minimumAmount` | Amount to be paid (e.g., `100.00` or `499`). | No |
48+
| `currency` | Currency of amount (default: `INR`) | No |
49+
| `transactionRefUrl`| URL for the order | No |
5050

5151

5252
In table, fields requirement column is based on static QR, For dynamic QR you need to change more fields along with `payeeVPA` and `payeeName`.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "upiqr",
3-
"version": "1.3.17",
3+
"version": "1.3.18",
44
"description": "Generate NPCI's UPI QR code along with UPI intent link, By using it any payment is possible from UPI enabled apps.",
55
"main": "dist/index.js",
66
"types": "dist/index.d.ts",

0 commit comments

Comments
 (0)