QR Request
Description - This API enables crediting of the wallet using Dynamic QR (respective QR is generated for a certain amount).
Headers
Content-Type: application/JSON |
client_id: To be shared during integration |
client_secret: To be shared during integration |
Request Body Parameters
Parameters | Parameter description with validations and examples | Attribute type | Mandatory/ Not Mandatory |
virtualAddress | Payer Virtual Address. E.g. -"8018094801@ybl" | String | Mandatory |
amount | Amount. Minimum amount is ₹1 | String | Mandatory |
merchantType | Merchant Type. E.g. - "AGGREGATE" Merchant must be on-boarded onto our portal. | String | Mandatory |
paymentMode | Payment Mode. "QR" | String | Mandatory |
channelId |
Channel ID.
|
String | Mandatory |
clientRefId | Client reference number. length=19. Format to be followed - (^[A-Z]{3}[0-9] {16}$). It must Not be NULL E.g. - "FIA3967275128763421" | String | Mandatory |
isWalletTopUp | Will top up be done or not. E.g. - false | Boolean | Mandatory |
Remarks | Remarks of the Transaction done | String | Mandatory |
requestingUserName | Requesting User Name. E.g. - “upitestret” | String | Mandatory |
Sample Request Body
Response Body Parameters
Parameters | Parameter description with examples | Data type |
txnId | Transaction id, Unique Id for each transaction. E.g. - "1121387239847231488" | String |
merchantId | Merchant ID. E.g. - "INDB000000349936" | String |
amount | Amount. E.g. - "1.0" | String |
Status | Status of the operation. | String |
statusDesc | Status Description. E.g - "Qr code generation done " | String |
paymentState | Payment State. E.g. - "INITIATED" | String |
payerVPA | VPA of Payer. | String |
payeeVPA | VPA of Payee. E.g. - "iserveubiz@indus" | String |
qrData | QR Data. E.g. - "iVBORw0KGgoAAAANSUhEUgAAAV4AAAFeAQAAAADlUEq3AAA DuklEQVR4Xu2XwW7kIBBEufHL3ODGL3OIxNZrbAe/z5KaXIRziMruC4oylcw89V6CodHcwxifRvMktNYRqWZOjex9C/ lFJN0RCO8G/ iwHsceI8D73HgPQ68x4H3OPAeB97jwHsceI+vf9ggb0QTTrFOAA AAAElFTkSuQmCC" | String |
intentData | Intent Data. Here it is NULL as the payment mode is QR | |
clientRefId | Client Reference ID. length=19. Format to be followed - (^[A-Z]{3}[0-9]{16}$). E.g. - DFG5788335940581000 | Alphanumeric String |
statuscode | Status of the transaction. E.g. - "0" | String |
Sample Response Body
Success :
FAILED (amount is missing):
FAILED (Client Reference ID is missing):
Detailed Status Codes
Status | Status Code | Description |
SUCCESS | 0 | Transaction Success |
FAILED | -1 | Transaction Failure |