The seamless UPI API flow allows merchants to collect UPI payments. The primary API is used to
create a collect request to customer’s phone. Once the payment is confirmed a callback will be
sent to the notifyUrl.
As an alternate Order Status API also can be used to poll the status of the order.
As well as to improve success rates, Validate VPA API can also be used(Refer Rest API docs)
Available UPI Modes
Collect: Send a collect request to a particular user vpa.(DEFAULT)
Google Pay: Send direct notification to google pay for the customer to pay.
QR Code: Customer can scan and pay the qr code using any UPI app.
Link: Pay using an UPI scheme link using any UPI app.
Currency for the order. INR if left empty. See the Currency Codes below for a list of available currencies. Please contact firstname.lastname@example.org to enable new currencies
A help text to make customers know more about the order
Name of the customer
Phone number of customer
Email id of the customer
Return URL to which user will be redirected after the payment (max-len 500)
Notification URL for server-server communication. Useful when user’s connection drops while re-directing (max-len 500) notifyUrl should be an https URL
Value should be "upi"
Value should be "json"
The mode of UPI request that is being used. By default a collect request is raised. Optional Values are as follows - 1.‘gpay’(Google Pay) which will use customerPhone instead of upi_vpa parameter to send notification directly to Google Pay app 2.’qrcode’ this will provide with qrCode in response 3.’link’ this will provide the upi pay scheme link as response
User vpa for the transaction. Not required for upiMode = ‘gpay’,’qrcode’,’link’. Mandatory for other collect request
Status of API call “OK”, “ERROR”
ReferenceId of the UPI transaction
Message if any
Base64 png image. This is returned when upiMode ‘qrcode’ is used
UPI scheme link that can used to pay using an UPI app returned when upiMode ‘link’is used