Description: This API is used to onboard businesses for accepting UPI payments.

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	Data type	Mandatory/Optional
productType	Product Type. E.g. - "upi"	String	Mandatory
address	Address of Company It must Not be NULL. (5≤ length ≤ 200) E.g.- "KIRTI NAGAR DELHI"	String	Mandatory
area	Area of Company It must Not be NULL. (5≤ length ≤ 30) E.g.- "Delhi"	String	Mandatory
bcagentid	BC Agent ID. Must Not be NULL. (5 ≤ length ≤ 100) E.g.- "isutests"	String	Mandatory
bcagentname	BC Agent First Name, must not be NULL. (3 ≤ length ≤ 49) E.g.- "Nikhil"	String	Mandatory
companyname	Beneficiary's Name, it must not be NULL. (3 ≤ length ≤ 199) E.g.-"Iserveu"	String	Mandatory
email	Email ID. E.g. - "[email protected]"	String	Mandatory
lastname	Last Name of the BC Agent. Last Name must not be NULL. (1 ≤ length ≤ 49) E.g. "ISERVUE"	String	Mandatory
mobilenumber	Mobile Number of Company. It should be of 10 digits. It must Not be NULL. E.g.-"8538341121"	String	Mandatory
pancard	pancard number, It must Not be NULL. It’s length should be 10. E.g.- "DEDTLI2222L"	String	Mandatory
pincode	Pin Code, It should contain 6 digits. It must Not be NULL. E.g. – 110015	Integer	Mandatory
shopaddress	Shop Address. (5 ≤ length ≤ 200) E.g.- "KIRTI NAGAR DELHI"	String	Mandatory
shoparea	Area where Shop is. (5 ≤ length ≤ 30) E.g.- "KIRTI NAGAR DELHI"	String	Mandatory
shopcity	City where Shop is. (5 ≤ length ≤ 50) E.g.- "Delhi"	String	Mandatory
shopdistrict	District where Shop is. (5 ≤ length ≤ 50) E.g.- "KIRTINAGAR"	String	Mandatory
shopname	Shop Name, it must Not NULL. (3≤ length ≤ 100) E.g. - "Iserveu"	String	Mandatory
shoppincode	Pin code of shop area, It should contain 6 digits. E.g.- "110015"	String	Mandatory
shopstate	State where Shop is. (5 ≤ length ≤ 50) E.g.- "DELHI"	String	Mandatory
AADHAAR	Aadhaar Number. Must be of 12 digits. E.g. -"678965467890"	String	Mandatory
lat	Latitude of Location. E.g. - "123456"	String	Mandatory
long	Longitude of Location. E.g. - "123123123"	String	Mandatory
ifsc	IFSC E.g. - "SBIN0014471"	String	Mandatory
isApiRetailer	Is API Retailer or not "true" or "false"	Boolean	Mandatory
bankName	Bank name. E.g. - "State bank of India"	String	Mandatory
accountNumber	Account Number. E.g. - "09876546890"	String	Mandatory
vpa	VPA E.g. - "isutests@indus"	String	Mandatory
mid	Merchant ID. E.g. - "mid1119"	String	Optional
qr_string	qr string	String	Optional

Sample Request Body

---

{ "productType": "upi", "address": "KIRTI NAGAR DELHI", "area": "Delhi", "bcagentid": "isutests", "bcagentname": "Nikhil", "companyname": "Iserveu", "email": "vivekkush05@gmail.com", "lastname": "ISERVUE", "mobilenumber": "8539861121", "pancard": "DEDTLI2222L", "pincode":110015, "shopaddress": "KIRTI NAGAR DELHI", "shoparea": "KIRTI NAGAR DELHI", "shopcity": "Delhi", "shopdistrict": "KIRTI NAGAR", "shopname": "Iserveu", "shoppincode": "110015", "shopstate": "DELHI", "AADHAAR": "678965467890", "lat": "123456", "long": "123123123", "ifsc": "SBIN0014471", "isApiRetailer": "true", "bankName":"State bank ofIndia", "accountNumber": "09876546890", "vpa": "isutests@indus", "mid":"", "qr_string":"" }

Response Body Parameters

Parameters	Parameter description	Data type
status	Status of operation "Success" or "failed"	String
statusCode	Status Code 0 - Success 1 - Failed	String
statusDesc	Status Description E.g. - "UPI Onboarded successfully" (Success)	String
Data	Operation Data "status" - Operation Status - 0 or 1 "message" - E.g. - "Merchants processed successfully!"	String
results	Results of the Operation. "success" - Successful Operation "failed" - Failed Operation	String
merchant_id	Merchant ID (Only in case of Success Result) E.g. - "vpatest17@indus"	String
message	Result Message (for Success / Failed) E.g. - "Merchant onboarded successfully"	String

Sample Response Body

Success :

{ "status": "Success", "statusCode": 0, "statusDesc": "UPI Onboarded successfully", "data": { "status": 0, "message": "Merchants processed successfully!", "results": { "success": [ { "merchant_id": "vpatest17@indus", "message": "Merchant onboarded successfully" } ], "failed": [] } } }

 

Sample Response Body (FAILED)

 

Duplicate User:

{ "status": "FAILED", "statusCode": 1, "statusDesc": "ERRDU01:- Duplicate user", "Data": {} }

Duplicate Mobile Number:

{ "status": "FAILED", "statusCode": 1, "statusDesc": "ERRCPM01:- DUPLICATE MOBILE NUMBER", "Data": {} }

Duplicate PAN Card:

{ "status": "FAILED", "statusCode": 1, "statusDesc": "ERRCPM01:- DUPLICATE PANCARD", "Data": {} }

Status Codes

Status Code	Response Type	Description
0	SUCCESS	UPI Onboarded successfully
1	FAILED	ERRDU01:- Duplicate user ERRCPM01:-DUPLICATE MOBILENUMBER