UPI
The Unified Payments Interface (UPI) is an instant, real-time payment system developed by National Payments Corporation of India (NPCI) facilitating inter-bank transactions. It is a unique solution that can be used to transfer money and make payments using the Immediate Payments Service (IMPS). UPI is an initiative by NPCI, regulated by RBI. UPI works 24/7. Federal Bank offers the UPI API stack for fintech and startup partners to readily integrate UPI services in their products .
APIs
-
Using this API, merchants can initiate refund against a UPI payment. This API follows an asynchronous processing model. On receiving a PAY request from the Merchant, Federal Bank will validate the request and will send an Acknowledgement to the Merchant. If the request is valid, Federal Bank will then send a transaction response message (RespPay) to the Merchant with details of the payment, transaction status, etc. The RespPay response message will have the same TransactionId as the original PAY request message, and the TransactionType will have a value of PAY. Merchant must acknowledge
-
Merchants will initiate UPI Transaction Reference Enquiry API to UPI switch for knowing the status of the original UPI payment with Transaction Reference ID or Transaction ID. Merchants can initiate Transaction Reference Enquiry API with valid original Transaction ID or original Transaction Reference ID. Merchants will be able to enquire the original payment status within 48 hours of the original transaction using this API.
-
This API lets the merchants confirm the response of any UPI transaction. At first, the federal bank will send the “ReqTransactionConfirm” API to Merchant. For which the merchants should respond with “ACK” immediately. Post that Merchant Application should call this "RespTransactionConfirm" API to the Federal bank, the bank will send “ACK” to Merchant.
-
Using this API, Merchant can initiate a payment from his / her account to a Customer. The request message has details of the Payee VPA in the MerchantBody section. It has other details like Amount, Payer VPA, etc. This API follows an asynchronous processing model. On receiving a PAY request from the Merchant, Federal Bank will validate the request and will send an Acknowledgement to the Merchant. If the request is valid, Federal Bank will then send a transaction response message (RespPay) to the Merchant with details of the payment, transaction status, etc. The RespPay response message will
-
This API is to validate the Virtual ID of a Customer before initiating PAY / COLLECT requests, to make sure the transaction gets initiated against the correct party. Details of the Merchant and Customer Virtual ID are to be specified as part of the MerchantBody section of the request message. The response will contain the name of the Account holder if the Virtual ID specified by PayeeAddress is valid. This API follows an asynchronous processing model. On receiving address validation request (ReqValAdd) from the Merchant, Federal Bank will validate the request and send an Acknowledgement to the
-
This API is to get the outbound response of the PAY and COLLECT transactions initiated by the user. API will give the response of the PAY or COLLECT transactions, represented by the “id” attribute in the request message.
-
This API lets customers disable/delete the Virtual ID of a User. Once the Virtual ID gets disabled/deleted, no more UPI transactions are allowed further using that particular Virtual ID.
-
Using this API, you can delete account.
-
This API lets you create a new Virtual ID or add a new Bank Account to the given Virtual ID. Virtual ID (also called Virtual Payment Address or VPA) is a unique ID that has to be created for each user to send and accept money via UPI. Once a Virtual ID is created and mapped against the user’s existing Bank Account, the user can share his / her Virtual ID (ex. name@fede), instead of the actual Bank Account, in all transactions using UPI. Details of the Bank Account such as Account Number, IFSC, and the Virtual ID should pass as part of the MerchantBody section of the input message.
-
To know the status of a transaction initiated by you, please invoke this API.
-
This API lets the customer change his/her default account linked to a user’s Virtual ID with a new Bank Account of that user. The details such as the new Account Number, the Virtual ID, the DefaultAcctFlag, etc. are specified as part of the MerchantBody section of the request message.
-
This API is to initiate a transaction where the merchant is requesting funds from the remitter using the remitter’s virtual ID. The merchant is a pre-configured and registered entity with the Bank. For this process, the merchant sends a COLLECT request with the specific UPI address of the Customer. When the Customer accepts the COLLECT request and pays the amount, the amount gets credited to the beneficiary account. The request has MerchantHeader and MerchantBody sections with details of the payment, including amount, payee address, etc. This API follows an asynchronous processing model. On
Plans
In order to subscribe, you must create an account or sign in.
Basic Plan
75 calls per 52 weeks
Basic Plan
12 APIs including
-
UPI_Response_Txn_Confirmation_API 1.0.0
-
UPI_Collect_Req_API 1.0.0
-
UPI_Delink_Account_API 1.0.0
-
UPI_Disable_Virtual_ID_API 1.0.0
-
UPI_Modify_Account_API 1.0.0