INTENT Request:

Request Method :: POST
Description: The Intent API provides an intent link that can be integrated within any merchant application to initiate a payment. When a customer chooses to pay using this method, they are redirected via the intent link to a supported payment app, where they can complete the transaction through a seamless and secure flow. The intent link is generated for a specific amount mentioned in the request and is also time-bound. After the defined duration, the link will expire and cannot be used to complete the payment.

Headers

Content-Type: application/JSON
header_secrets:  To be shared during integration by ISU Team
pass_key:  To be shared during integration by ISU Team

Request Body Parameters

Parameters Description Min Length Max Length Data type Mandatory/Optional
payeeVPA Payee's VPA of Merchant for Payment Collection (e.g- 63705423781902@nsdl ) 1 100 String Mandatory
paymentMode Payment Mode (INTENT) 1 10 String Mandatory
txnAmount Transaction amount for which transaction is initiated Min: 1 Max: 100000.00 1 10 String Mandatory
channelId Channel Identifier Web: “WEBUSER” Android: “Android” 1 10 String Mandatory
txnNote Transaction Note 1 50 String Mandatory
clientRefId Unique client reference needs to be generated by partner/Merchant for each transaction 10 19 String Mandatory
merchantType Type of Merchant Default Value: AGGREGATE 1 10 String Mandatory
expiryTime Time in Minutes Min Time: 1 Max Time: 30 1 2 String Mandatory
mobilenumber Mobile Number of Customer 10 10 String Mandatory

Sample Request Body

Encrypted Sample Request Body

Response Body Parameters

Parameters Description Min Length Max Length Data type
amount Transaction amount for which the transaction is initiated 1 10 Integer
clientRefId Unique client reference ID needs to be generated by partner/Merchant for each new transaction 10 19 String
intentData UPI Intent URL (null for QR) NA Na string
payeeVPA Payee's VPA of Merchant for Payment Collection 1 100 String
payerVPA Payer’s UPI ID 1 100 String
paymentState State of the Payment 1 10 String
qrData Base64 Encoded QR Data, which needs to be converted into a QR to collect payment NA Na String
status Status of Transaction Initiation 1 10 String
statusCode Status Code 1 3 String
statusDesc Status Description 1 50 String
txnId Generated Transaction ID 18 58 string

Sample Response Body

SUCCESS:

 

SUCCESS(Encrypted):

FAILED:

Amount is blank:

Client Reference ID is blank:

Note:

Any missing or invalid mandatory field will generate a Failed response.

Status Codes

Status Status Code Description
INITIATED 0 Qr generated successfully
FAILED -1 QR generation failed due to invalid request

 

QR Request:

Request Method :: POST
Description: The Dynamic QR API is used to initiate a dynamic QR-based transaction. Upon initiation, the response will include a QR string in Base64 format. This string should be converted into a QR code image, which can then be presented to the customer for completing the payment. The QR is generated for a defined amount provided in the request and will remain valid only for a limited time. Once this time window expires, the QR becomes inactive and cannot be used for payment.

Headers

Content-Type: application/JSON
header_secrets:  To be shared during integration by ISU Team
pass_key:  To be shared during integration by ISU Team

Request Body Parameters

Parameters Description Min Length Max Length Data type Mandatory/Optional
payeeVPA Payee's VPA of Merchant for Payment Collection (e.g- 63705423781902@nsdl ) 1 100 String Mandatory
paymentMode Payment Mode (e.g., QR) 1 10 String Mandatory
txnAmount Transaction amount for which transaction is initiated Min: 1 Max: 100000.00 1 10 String Mandatory
channelId Channel Identifier Web: “WEBUSER” Android: “Android” 1 10 String Mandatory
txnNote Transaction Note 1 50 String Mandatory
clientRefId Unique client reference needs to be generated by partner/Merchant for each transaction 10 19 String Mandatory
merchantType Type of Merchant Default Value: AGGREGATE 1 10 String Mandatory
expiryTime Time in Minutes Min Time: 1 Max Time: 30 1 2 String Mandatory
mobilenumber Mobile Number of Customer 10 10 String Mandatory

Sample Request Body

Encrypted Sample Request Body

Response Body Parameters

Parameters Description Min Length Max Length Data type
amount Transaction amount for which the transaction is initiated 1 10 Integer
clientRefId Unique client reference ID needs to be generated by partner/Merchant for each new transaction 10 19 String
intentData UPI Intent URL (null for QR) NA Na string
payeeVPA Payee's VPA of Merchant for Payment Collection 1 100 String
payerVPA Payer’s UPI ID 1 100 String
paymentState State of the Payment 1 10 String
qrData Base64 Encoded QR Data, which needs to be converted into a QR to collect payment NA Na String
status Status of Transaction Initiation 1 10 String
statusCode Status Code 1 3 String
statusDesc Status Description 1 50 String
txnId Generated Transaction ID 18 58 string

Sample Response Body

SUCCESS:

 

SUCCESS(Encrypted):

FAILED:

Amount is missing:

Client Reference ID is missing:

Note:

Any missing or invalid mandatory field will generate a Failed response.

Status Codes

Status Status Code Description
INITIATED 0 Qr generated successfully
FAILED -1 QR generation failed due to invalid request