UPI | API Developer Portal

UPI 37 APIs

UPI- "Unified Payment Interface" has taken up by NPCI as a new initiative to simplify and provide a single interface across all systems. Unlike typical payment systems, UPI is innovative and unique in a way that one can identify a beneficiary customer by Virtual Payment Address (VPA) in addition to regular bank account number and bank IFSC code.

UPI Balance Inquiry

Transaction APIs are a set of operations that allow you to check account balance.
UPI Beneficiary Block

This is a set of generic APIs which can be used for Block a Beneficiary or listing them.
UPI Change MPIN

This operation is used to change the account MPIN. Basis the X-AXIS-TEST-ID parameter, the API will respond for different conditions. For eg: 1=Success, 3 = Customer Id Invalid, 90 Invalid Test id
UPI Collect Approve

Transaction APIs are a set of operations that allow you to approve a collect request.
UPI Collect Decline

Transaction APIs are a set of operations that allow you to decline a collect request.
UPI Collect

Transaction APIs are a set of operations that allow you to send a collect Request
UPI Customer Registration

This operation is used to register customer into UPI Payment Service Provider Switch. Basis the X-AXIS-TEST-ID parameter, the API will respond for different conditions. For eg: 1=Success, 2= No records found, 90=Invalid Input, 91=Backend Failure
UPI Fetch Accounts

This operation is used to fetch customer accounts. Basis the X-AXIS-TEST-ID parameter, the API will respond for different conditions. For eg: 1=Success, 3 = Customer Id Invalid, 90 Invalid Test id
UPI Fetch Token

This operation is used to fetch token into UPI Payment Service Provider Switch. Basis the X-AXIS-TEST-ID parameter, the API will respond for different conditions. For eg: 1=Success, 2= No records found, 90=Invalid Input, 91=Backend Failure
UPI Get All Accounts
UPI De-Register Customer

This operation is used to deregister customer into UPI Payment Service Provider Switch. Basis the X-AXIS-TEST-ID parameter, the API will respond for different conditions. For eg: 1=Success, 3 = Customer Id Invalid, 90 Invalid Test id
Execute mandate Transaction

This API is for requesting money corresponding to a mandate by Payee PSP. Like mandate execution
Check Transactions Mandate

API to get status of the all type of transaction.
Get Transactions for a Mandate

API to fetch all types of mandates .
Get Mandate

This API is used for pending Mandate.
Approve or Decline Authorize Mandate

Approve or Decline Mandate Payee can initiate a mandate creation request, which needs to be approved or declined by the payer. This API allows Payer user to approve or decline the mandate created by payee.
Suspend/Activate/Revoke Mandate

This API is used to Revoke/Cancel Existing Mandate by payer/payee.
Modify Mandate

This API is used to Modify Mandate request by Payer/Payee.
Request Payer/Payee Create Mandate

Payer/Payee can initiate mandate creation request.
UPI Verify VPA

This operation is used to verify Virtual Primary Address Switch. Basis the X-AXIS-TEST-ID parameter, the API will respond for different conditions. For eg: 1=Success, 2= No records found, 90=Invalid Input, 91=Backend Failure
UPI Update VPA

This operation is used to update Virtual Primary Address Switch. Basis the X-AXIS-TEST-ID parameter, the API will respond for different conditions. For eg: 1=Success, 2= No records found, 90=Invalid Input, 91=Backend Failure
UPI Set VPA

This operation is used to set Virtual Primary Address Switch. Basis the X-AXIS-TEST-ID parameter, the API will respond for different conditions. For eg: 1=Success, 2= No records found, 90=Invalid Input, 91=Backend Failure
UPI Remove VPA

This operation is used to remove Virtual Primary Address Switch. Basis the X-AXIS-TEST-ID parameter, the API will respond for different conditions. For eg: 1=Success, 2= No records found, 90=Invalid Input, 91=Backend Failure
UPI VPA List

This operation is used to list Virtual Primary Address Switch. Basis the X-AXIS-TEST-ID parameter, the API will respond for different conditions. For eg: 1=Success, 2= No records found, 90=Invalid Input, 91=Backend Failure
UPI VPA Availibility

This operation is used to check availibility of into Virtual Primary Address Switch. Basis the X-AXIS-TEST-ID parameter, the API will respond for different conditions. For eg: 1=Success, 2= No records found, 90=Invalid Input, 91=Backend Failure
UPI Transaction Status

Transaction APIs are a set of operations that fetches transaction status.
UPI Transaction History

This API is used to get the list of transactions between two dates. Fromdate, todate format is dd/MM/yyyy Response is basis X-AXIS-TEST-ID field where 1 = success response, 3 = Unable to fetch Transaction History, other = Invalid test ID error
UPI Set Reset MPIN

This API is used to set/Re-set MPIN of selected bank account. MPIN is Used for transaction authorization. The API response is based on X-AXIS-TEST-ID X-AXIS-TEST-ID field where 1 = success response, 3 = Customer Accounts not found, other = Invalid test ID error
UPI Self Pay

Transaction APIs are a set of operations that allow you to create a payment between own accounts.
UPI Request OTP

This API is used to request OTP. Response is basis X-AXIS-TEST-ID . When id 1= Success, 3 = OTP failed, others = Invalid Test Id
UPI Remove Accounts

This operation is used to remove the account. Basis the X-AXIS-TEST-ID parameter, the API will respond for different conditions. For eg: 1=Success, 3 = Customer Id Invalid, 90 Invalid Test id
UPI Raise Query

This is a set of generic APIs which can be used for Raising a Query or listing them.
UPI Pending Transaction List

Transaction APIs are a set of operations that allow you to get list of pending payment notifications.
UPI Pay Request

Transaction APIs are a set of operations that allow you to make a pay request.
UPI Pre Pay

Transaction APIs are a set of operations that allow you to create a mandate for pre-approved debit mandate.
UPI List Query

This is a set of generic APIs which can be used for List all Queries or listing them.
UPI List Keys

This operation is used to list keys into UPI Payment Service Provider Switch. Basis the X-AXIS-TEST-ID parameter, the API will respond for different conditions. For eg: 1=Success, 2= No records found, 90=Invalid Input, 91=Backend Failure