upi-link v1.0.1
upi-link
Simple npm module to generate UPI deep-links, based on UPI Linking Specifications Version 1.5.1 :money_mouth_face:
installation
$ npm i upi-linkAPI
Factory methods
| Function Name | Input params | Returns |
|---|---|---|
| Satic | VPA ID(M), Payee Name(M), Amount(O) | Builder object |
| Dynamic | VPA ID(M), Payee Name(M), Amount(M) | Builder object |
| SaticP | VPA ID(M), Payee Name(M), Amount(O) | Promise |
| DynamicP | VPA ID(M), Payee Name(M), Amount(M) | Promise |
Setter methods
setMerchant( mc, ti) : Set merchant takes tow parameter Merchant ID (mandatory) and Transaction ID (optional). Both the ID should be generated by the PSP, and should be passed as it is.
setTxRef( refid, note) : Set merchant takes tow parameter Transaction Reference ID (mandatory) and Transaction Note (optional). Transaction Reference ID should generated by you. It could be order number, subscription number, Bill ID, booking ID, insurance renewal reference, etc.
- Note : Setting up TxRef is mandatory, when either Merchant is set or the URL type is Dynamic
- setMinAmount(amount) : Minimum Amount will only be set when Transaction Amount is already set and the Minimum Amount is different from the Transaction Amount.
- setCallback(url) : This should be a URL when clicked provides customer with further transaction details like complete bill details, bill copy, order copy, ticket details, etc. This can also be used to deliver digital goods.
- Note : Setting up Callback URL doesn't guarantee the it will be called by the PSPs post transaction. Call to this URL is subjected white listing by the PSPs.
Build Method
- getLink() : This will return a QR code friendly formated UPI URI string is all conditions are met.
Chaining
Build object chaining
const upi = require('upi-link')
let uri = upi.Static("xxxxx@ybl", "Xyz Abc")
.setMerchant("ALPHABET")
.setTxRef('INV001')
.getLink()
console.log('URI: ',uri);Promise chaining ( * )
const upi = require('upi-link')
upi.DynamicP("xxxxx@ybl", "Xyz Abc", 100000)
.setMinAmount(1000)
.setTxRef('INV001')
.getLink()
.then( uri => console.log('URI: ',uri))
.catch( err => console.error('Error: ',err.message))* Promise chaining is the recomended method. If you are using plain build object you should handled errors asseted by each metods.