Dynamic UPI API | API Developer Portal

Introduction

The purpose of this document is to outline the Staging Integration phase, which focuses on validating APIs related to transaction processing and transaction enquiry. This phase is intended to ensure that the complete transaction flow functions correctly, outcomes are accurately verified, and Webhook are properly handled before proceeding to production.

The following APIs are covered under this integration:

Dynamic QR
Intent
Transaction Status Enquiry
Webhook

These APIs enable the creation of payment requests, allow status checks on those transactions, and provide updates via Webhook.

Integration and Testing

A single round of integration testing will be conducted in the Staging environment. This testing is meant to validate the end-to-end transaction flow using the APIs mentioned above. The testing should cover the following:

Generation of Dynamic QR
Initiation of transactions through the Intent API
Checking the transaction status using the Status Enquiry API
Receiving updates through the Webhook

Once this testing round is completed successfully and the APIs perform as expected, the system will be considered ready for production deployment.

API Listing for Integration

API Name	Request Parameter	Response Parameter	Description
QR Request	payeeVPA paymentMode txnAmount channelId txnNote clientRefId merchantType ExpiryTime Mobilenumber	amount clientRefId intentData payeeVPA payerVPA paymentState qrData status StatusCode statusDesc txnId	This API will be used to generate a Dynamic QR
INTENT Request	payeeVPA paymentMode txnAmount txnNote channelId clientRefId merchantType ExpiryTime Mobilenumber	amount clientRefId intentData payeeVPA payerVPA paymentState qrData Status StatusCode statusDesc txnId	This API will be used to initiate INTENT request

API Name	Request Parameter	Response Parameter	Description
Transaction Status Enquiry	Query Operation Start Date End Date ClientRefId Transaction ID	status message length statusDesc createdDate updatedDate productCode txnType txnAmount txnDateTime payerVPA status rrn txnId retailerUserName username clientreferenceid param_b param_c	This API will fetch the transaction id details according to the provided request mentioned below.

API Name	Request Parameter	Response Parameter	Description
Webhook API	txnAmt transaction_note txnId paymentMode status statusCode statusDesc transaction_date payer_vpa payee_vpa platform customerName rrn clientRefId parama paramb paramc wallet_id	status statusDesc	Your organization will provide us a Call-back URL with the following configurations: The Call-back URL should be of Method Type POST. Content-type should be of Type application/JSON. The Call-back URL should have the following request format. The Response has also been provided for your reference.