2.1.3 PSP UPI Switch Financial APIs
Following are all supported APIs:
API | Description |
---|---|
ReqPay | This API is used to initiate a Pay/Collect transaction from the PSP UPI switch to the NPCI UPI switch. If the Payer PSP and Remitter Bank are the same entity, the request from the Payer PSP UPI switch to the NPCI UPI switch will be pre-approved, meaning the customer's account is debited before the request is sent to the NPCI UPI switch. |
ReqBalEnq | PSP UPI switch sends this request to NPCI for enquiring the account balance. |
ReqHbt | This API is a mechanism for monitoring the UPI system, including tracking connections with PSPs and sending End-of-Day (EOD) reports to PSPs). |
ReqChkTxn | PSP UPI switch sends this API to NPCI for enquiring the transaction status |
ReqTxnConfirmation | NPCI sends this API to the Payee PSP for Pay transaction / Payer PSP for collect transaction to update the transaction status. |
ReqAuthDetails | The API is used to authorize a payment and convert PSP-specific payment addresses into common global addresses (such as Aadhaar number, mobile number, or account and provider ID) that NPCI can recognize. This API is called to translate the PSP address and obtain the necessary authorization details. |
ReqComplaint | PSP UPI switch sends this API to NPCI for raising a complaint against a financial transaction. |
Parent topic: Overview of UPI