Dynamic QR Generation API:

Request Method :: POST
Description: This API is used to generate a real-time, transaction-specific QR code for accepting payments from customers.

Headers

Content-Type: application/JSON
header_secrets:  To be generated by following the above logic
pass_key:  To be shared during integration by ISU Team

Request Body Parameters

Parameters Description Min Length Max Length Data type Default Value Mandatory/Optional
payeeVPA Payee's VPA of Merchant for Payment Collection (e.g- upicashpoint.uat@nsdl ) 1 100 String   Mandatory
paymentMode Payment Mode for the Transaction 1 10 String UPI_CASHPOINT Mandatory
txnAmount Transaction amount for which transaction is initiated Min: ₹100 Max: ₹5000 and must be in multiple of ₹100. 1 10 String   Mandatory
channelId Channel Identifier Web: “WEBUSER” Android: “Android” 1 10 String   Mandatory
txnNote Transaction Note(No Special Character Allowed, Space in Start and end also not allowed) 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: BC 1 10 String BC Mandatory
expiryTime Time in Minutes Min Time: 1 Max Time: 30 1 2 String   Mandatory
mobilenumber Mobile Number of Customer 10 10 String   Mandatory
tid Terminal Id of Device (Only Alphanumric allowed no special character, i.e Device Serial No) 1 20 String   Mandatory
paramA Additional Parameter 0 255 String   Optional
paramB Additional Parameter 0 255 String   Optional
paramC Additional Parameter 0 255 String   Optional
deviceType Device model name 1 100 String   Mandatory
androidOsVersion Android OS version installed on the device 1 20 String   Mandatory
deviceVersion Device build/version number 1 50 String   Mandatory
androidAgent Operating system agent (e.g., Android) 1 20 String   Mandatory
platformType Platform type (e.g., MOB for Mobile) 1 10 String   Mandatory
deviceSerialNo Unique device serial number 1 50 String   Mandatory
mobileNo Registered mobile number 10 10 String   Mandatory
ip Device IP address 7 45 String   Mandatory
packageName Application package name 1 255 String   Mandatory
version Application version 1 20 String   Mandatory
lat_long Latitude and Longitude coordinates in latitude,longitude format 3 50 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 (NA for Cashpoint)) 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 or Invalid Amount, entered :

Client Reference id must not be blank :

Merchant not onboarded with MCC 6013:

Status Codes

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