UPI+Soundbox Onboarding API

---

Request Method :: POST

Description:This API facilitate a smooth and successful onboarding process for a single agent.

URL:/apiAgentOnboarding/externalonboard

Headers

---

Content-Type: application/JSON

client_id:  Will be provided at the time of Integration

client_secret:  Will be provided at the time of Integration

Request Body Parameters

Parameters	Parameter description	Data type	Mandatory/Optional
address	Address of Agent. It must Not be NULL. (5≤length ≤ 200) E.g.- "KIRTI NAGAR DELHI"	String	Mandatory
area	Agent’s area of location.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.- "biswajit"	string	Mandatory
bcagentname	BC Agent First Name, must not be NULL. (3 ≤length ≤ 49) E.g.- "Nikhil"	string	Mandatory
companyname	Company Name, it must not be NULL. (3 ≤length ≤ 199) E.g.-"RNFI relipay"	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 Agent. It should be of 10 digits. It must Not be NULL. E.g.-"8527365894"	string	Mandatory
pancard	Pancard number, It must Not be NULL. It’s length should be 10. E.g.- "BETPK0677Z"	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.- "KIRTI NAGAR"	string	Mandatory
shopname	Shop Name, it must Not NULL. (3≤ length ≤ 100) E.g. - "RNFI relipay"	string	Mandatory
shoppincode	Pin code of shop area, It should contain 6 digits. E.g.- "110015"	Integer	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	Optional
lat	Latitude of Location. E.g. - "123456"	string	Optional
long	Longitude of Location. E.g. - "123123123"	string	Optional
productType	Product Type. E.g. “upi”	string	Mandatory
ifsc	IFSC Code	string	Mandatory
isApiRetailer	Is API Retailer or not.	Boolean	Mandatory
bankName	Name of the bank	string	Mandatory
accountNumber	Account Number	string	Mandatory
vpa	VPA	string	Mandatory
panNo	PAN	string	Mandatory

Sample Request Body

---

{ "address": "KIRTI NAGAR DELHI", "area": "Delhi", "bcagentid": "biswajit", "bcagentname": "Nikhil", "companyname": "RNFI relipay", "email": "vivekkush05@gmail.com", "lastname": "ISERVUE", "mobilenumber": "8527365894", "pancard": "BETPK0677Z", "pincode": 110015, "shopaddress": "KIRTI NAGAR DELHI", "shoparea": "KIRTI NAGAR DELHI", "shopcity": "Delhi", "shopdistrict": "KIRTI NAGAR ", "shopname": "RNFI relipay", "shoppincode": "110015", "shopstate": "DELHI", "AADHAAR": "678965467890", "lat": "123456", "long": "123123123", "productType": "upi", "ifsc": "SBIN0014471", "isApiRetailer": "true", "bankName": "State bank of India", "accountNumber": "09876546890", "vpa": "test1@vpa", "panNo": "ADHPI5728H" }

Response Body Parameters

Parameters	Parameter description	Data type
status	Status of the operation (SUCCESS/FAILED)	string
statusCode	Status Code	Integer
statusDesc	Status Description. E.g - "User created successfully."	string
Data	Fetched Data of the Operation	string

Sample Response Body

---

SUCCESS:

{ "status": "SUCCESS", "statusCode": 0, "statusDesc": "User created successfully", "Data": { "errorres": { "status": "0", "description": "1005398" } }

FAILED:

If merchant_vpa is missing:

{ "status": "FAILED", "statusCode": 1, "statusDesc": "db insertion failed, please try again" }

Status Codes

Status	Status Code	Description
SUCCESS	0	User created successfully
FAILED	1	db insertion failed, please try again

Error Codes

Error Codes	Error Description
ERRBLK001	failed in check blocklist onboarding
ERRBLK002	failed to get status from check blocklist
ERRBLK003	failed to get details from check blocklist
ERRBLK01	can not Onboarded
ERRFAD01	something went to wrong from db
ERRPIN01	failed to get status from check blocklist
ERRPIN02	Failed to get pinDetails
ERRCPM01	Something went wrong , please try again (duplicate pan or mobile number)
ERRGUI001	Something went wrong ,please try again after sometimes(generate userid error)
ERRIDN01	db insertion failed, please try again
ERRIDN02	db insertion failed2, please try again
ERRPO01	Failed in Onboarding Process
ERRGUI02	User Onboarded failed
ERRDU01	DUPLICATE user
ERRPIN01	Failed to get pinDetails
ERRFAD01	Admin not available
UCWS001	whitespace validation error
UCNV001	null value validation

Bank Error

Error Codes	Error Description
ERRBAS11	Something went wrong
ERRBAS02	Something went wrong
ERRBAS10	Invalid Status
ERRBAS09	AMLFailure
ERRBAS08	Reupload
ERRBAS07	Blocked
ERRBAS06	Rejected
ERRBAS05	Hold
ERRBAS04	Details Requird