Introduction

Welcome to the UPI PSP Backend API Reference Document. This doc consists of the comprehensive information about our Server-to-Server APIs. We use application/json content type for our request and response.

This documentation is designed to guide you through each API in detail. From API descriptions to the step-by-step flow, everything you need is outlined in the sections below. Each section includes crucial information about the API's structure, including the Request and Response body specifications.

Before you dive into the APIs, we recommend familiarizing yourself with the Request and Response structure. This will provide you with essential insights into prerequisites and overall formatting, ensuring a smooth integration process.

Customer Onboarding

The UPI Registration Flow is the process of linking a bank account to a UPI-enabled mobile app by selecting the bank, creating a unique Virtual Payment Address (VPA), and setting up a secure PIN to facilitate instant money transfers and transactions via smartphones.

Account management in UPI involves overseeing linked bank accounts within the UPI-enabled app, allowing users to handle multiple accounts, change or reset their UPI PIN, view transaction histories, and maintain security measures to ensure safe and convenient money transfers.

Customer Transactions

There are two primary methods for UPI transactions: Intent-based payments and Collect Requests.

1. Intent Payments refer to initiating transactions where the user directly authorises and initiates a payment from their UPI app to another party by entering the recipient's Virtual Payment Address (VPA) or scanning a QR code. This method allows users to send money by actively initiating the transaction through their UPI app.

2. Collect Requests involve requesting funds from another UPI user. The recipient generates a collect request by entering the payer's VPA or scanning their QR code. The payer then receives a notification to approve or decline the request, giving them control over the payment.

Mandates

A mandate in UPI is an authorization given by a user to enable recurring payments or debits from their bank account, facilitating automated and scheduled transactions for specific purposes such as subscriptions or bills.

Mandate Creation:

1. Intent-based Mandate Creation:
   This involves initiating a mandate where the user actively sets up recurring payments or authorization for debits from their bank account using their UPI app. Users can create mandates for regular payments like subscriptions, bills, or installments by providing necessary details and authorizing the recurring transactions.

2. Collect-based Mandate Creation:
   Collect-based mandate creation allows the recipient to request authorization for recurring payments or debits from the payer's bank account. The recipient generates a mandate request, and the payer approves it, enabling the recipient to initiate periodic deductions or transactions from the payer's account.

Mandate Transaction/Execution:

Mandate transactions or executions refer to the actual processing of authorized recurring payments or debits as per the set mandate. Once the mandate is created and authorized, the UPI system automatically processes the transactions at predefined intervals or schedules, executing the agreed-upon payments or debits.

Mandate Update and Revoke:

1. Mandate Update:
   Users can modify or update existing mandates by altering transaction amounts, intervals, or other details through their UPI app. This allows for changes in recurring payment schedules or modifications to the mandate terms as required.

2. Mandate Revoke:
   Mandate revocation involves cancelling or discontinuing the previously authorized recurring payments or debits. Users have the option to revoke mandates through their UPI app, thereby stopping further transactions under that mandate. This could be due to various reasons like the completion of payments, changing agreements, or no longer requiring the recurring service.

UDIR

The objective of Unified Dispute & Issue Resolution (UDIR) is to facilitate the ecosystem participants to handle complaints expeditiously  and in fair manner thereby enhancing the end user (consumer) experience. The approach of UDIR is to instantly enabling ecosystem participant to obtain/update the status of a pending  transaction through APIs

1. Auto Triggering Deemed/DRC transactions from NPCI’s Back Office System (URCS) to  UPI and UPI communicates to respective Bank through API then, update the status to  all participant 

2. Raising Complaint/Dispute in NPCI’s Back office system (URCS) through UPI by  Bank/PSP.

New Features

1. UPI Lite:
   UPI Lite is a simplified version of the Unified Payments Interface (UPI) designed for basic feature phones or devices with limited functionalities. It offers a pared-down interface of UPI services, enabling users without smartphones or advanced capabilities to perform basic UPI transactions such as fund transfers and bill payments through USSD (Unstructured Supplementary Service Data) or other simple interfaces.

2. UPI on Credit Card:
   UPI on Credit Card refers to the ability to link a credit card as a funding source to make UPI transactions. It allows users to use their credit card account as the source of funds for making payments or transfers via UPI, providing an additional payment option for users who prefer using their credit card for transactions.

3. UPI on Aadhaar OTP:
   UPI on Aadhaar OTP involves utilizing the Aadhaar-based OTP (One-Time Password) authentication for UPI transactions. This method employs the Aadhaar infrastructure to verify transactions by sending a one-time password to the registered mobile number linked with the Aadhaar card, ensuring secure authorization of UPI transactions.

4. UPI International:
   UPI International refers to the potential expansion or extension of the Unified Payments Interface beyond national borders. This expansion aims to allow international users or entities to utilize UPI for cross-border transactions, enabling seamless and efficient fund transfers or payments globally.

5. UPI Mapper:
   UPI Mapper is a component or system within the UPI infrastructure responsible for mapping and associating various identifiers (such as mobile numbers, bank account numbers, virtual payment addresses, etc.) with UPI handles or unique identifiers. It helps route transactions accurately to the intended recipient by resolving different identifiers to their corresponding UPI addresses or accounts.