VPA Collect

Description - This API enables crediting of the wallet through VPA Collect.

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	Virtual Address. E.g. -"8018094801@ybl"	String	Mandatory
amount	Amount. Minimum amount is ₹1.	String	Mandatory
merchantType	Merchant Type. "AGGREGATE" Merchant must be on-boarded onto our portal.	String	Mandatory
paymentMode	Payment Mode. "VPA"	String	Mandatory
channelId	Channel ID. "WEBUSER" "ANDROID" "iOS"	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. - "DFG5788335940581098"	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

---

{ "virtualAddress": "8018094801@ybl", "paymentMode": "VPA", "isWalletTopUp": false, "amount": "1", "channelId": "WEBUSER", "remarks": "test", "clientRefId": "DFG5788335940581098", "merchantType": "AGGREGATE", "requestingUserName": "upitestret" }

Response Body Parameters

Parameters	Parameter description with examples	Data type
txnId	Transaction id, Unique Id for each transaction. E.g. - "1121357419423727616"	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 - "Collect request initiated successfully."	String
paymentState	Payment State. E.g. - "INITIATED"	String
payerVPA	VPA of Payer. E.g. - “8018094801@ybl”	String
payeeVPA	VPA of Payee. E.g. - "iserveubiz@indus"	String
qrData	QR Code.	String
intentData	INTENT Data	String
clientRefId	Client Reference ID. E.g. - “DFG5788335940581098”	String
statuscode	Status of the transaction. E.g. - "0"	String

Sample Response Body

Success :

{ "txnId": "1121357419423727616", "merchantId": "INDB000000349936", "amount": "1.0", "status": "1", "statusDesc": "Collect request initiated successfully.", "paymentState": "INITIATED", "payerVPA": "8018094801@ybl", "payeeVPA": "iserveubiz@indus", "qrData": null, "intentData": null, "statusCode": 0, "clientRefId": "DFG5788335940581098" }

FAILED (amount is blank):

{ "statusCode": -1, "status": "FAILED", "txnId": null, "statusDesc": "invalid input amount." }

FAILED (Client Reference id is blank):

{ "statusCode": -1, "status": "FAILED", "txnId": null, "statusDesc": "Please provide valid Alphanumeric Client Reference id" }

Detailed Status Codes

Code	Significance	Description
0	SUCCESS	Transaction Success
-1	FAILED	Transaction Failure