Unified Payments Interface
Unified Payments Interface
On this page
API Information
Unified Payments Interface (UPI)
Unified Payments Interface (UPI) is a next-generation payments platform that facilitates the instant transfer of funds from person to merchant.
On this page
- Version: v1
- Protocol: HTTPS
- URL Production: **Live - please speak to your Client Integration contact**
Description
The following APIs are detailed in the attached specification:
| # | API Name | Description |
|---|---|---|
| 1 | Pre-Credit / Dynamic VPA Validation API | API to validate the dynamic part of the Merchant VPA with the merchant system Format: JSON |
| 2 | Post Credit / Final Response-Notification API | FINAL Response API helps merchant to receive the transaction status from the bank UPI server. In response, the merchant system provides a confirmation id which is linked to the transaction within the bank system Format: JSON |
| 3 | Collect Transaction Request | Merchant can collect payment from its customers via merchant website. Format: JSON |
| 4 | VPA Status Validation API | Validates the Status of the VPA and provides the name of the default account linked to the VPA if the VPA exists Format: JSON |
| 5 | Transaction Status Enquiry | Customers can check their transactions status for the transactions. Format: JSON |
| 6 | Refund API | This API supports refund payments. Format: JSON |
Specification
Please download the following specification whilst we load the digital documentation to the Developer Portal:
UPI Merchant API Specification
The specification contains the technical integration approach, process flows, client API functionalities and a toolkit to assist merchant integration with the UPI platform.