Agent Registration (Single)

Description - - This API enables the registration of a Single Agent at a time.

Request headers

---

Content-Type: application/JSON

client_id: To be shared during integration

client_secret: To be shared during integration

Request Body Parameters

---

Field	Parameter description with validation and examples	Attribute type	Mandatory/ Not Mandatory
productType	Product Type. E.g. - "POS". Must mention POS here for specific POS onboarding.	String	Mandatory
deviceSerialNo	Serial Number of the Device. E.g. - "5J769500". Last 8 digits of device serial number. Only mandatory for POS.	String	Mandatory
account_number	Account Number. E.g. - "571070507511"	String	Mandatory
bank_name	Bank Name. Only alphabet ,dot(.), hyphen(-), space, comma(,) allowed. E.g. - "ICICI BANK"	String	Mandatory
bank_pincode	Bank Pincode. Exact length of 6. E.g. - "756021"	String	Mandatory
ifsc_code	IFSC code of the Bank.11-character code with the first four alphabetic characters representing the bank name, and the last six characters (usually numeric, but can be alphabetic) representing the branch. The fifth character is 0 (zero). E.g. - "ICIC0000918"	String	Mandatory
email_id	Email ID. E.g. - "[email protected]"	String	Not Mandatory
mobilenumber	Mobile Number of Company. It should be of 10 digits. It must Not be NULL. E.g.-"8452066043"	String	Mandatory
aadhar_no	Aadhar Number. Enter a 12-digit Aadhaar Number. E.g. - "************"	String	Mandatory
dob	Date of birth. dob should be in dd/mm/yyyy format. E.g. - "05/01/1998"	String	Mandatory
gst_number	GST Number. It should be 15 characters long. The first 2 characters should be a number. The next 10 characters should be the PAN number of the taxpayer. The 13th character (entity code) should be a number from 1-9 or an alphabet. The 14th character should be Z. The 15th character should be an alphabet or a number. E.g. - "22FMIPK0100K1Z5"	String	Not Mandatory
lat	Latitude. E.g. - "67567.9090"	String	Mandatory
long	Longitude. E.g. - "98.090"	String	Mandatory
bcagentid	BC Agent ID. (5 ≤ length ≤ 100) E.g. -"Archana"	String	Mandatory
bcagentname	BC Agent Name. (3 ≤ length ≤ 49). E.g. - "Devi"	Integer	Not Mandatory
middlename	Middle Name	String	Mandatory
lastname	Last Name. (1 ≤ length ≤ 49). E.g. - “Kar”	String	Mandatory
companyname	Company Name. (3 ≤ length ≤ 199). E.g. - "iserveu”	String	Mandatory
address	Address. Address length is more than 3. E.g. - "Bhubaneswar"	String	Mandatory
area	Area. (5 ≤ length ≤ 30). E.g. - "bhubaneswar"	String	Mandatory
pincode	Pincode. Exact length of 6. E.g. - 752107	String	Mandatory
mobilenumber	Mobile Number. Must have length of exactly 10. Accept Only Indian Mobile Numbers (i.e. Starting with digits 6-9). E.g. - "6510090750"	String	Mandatory
shopaddress	Shop Address. (5 ≤ length ≤ 200). E.g. - "bhubaneswar"	String	Mandatory
shopstate	State in which the Shop is. (5 ≤ length ≤ 50). E.g. - "Odisha"	String	Mandatory
shopname	Name of the Shop. Itshould be in English language, otherlanguage names are not allowed. (3 ≤ length ≤ 100). E.g. - "Haldiram sweets"	String	Mandatory
shopcity	City where the Shop is. (5 ≤ length ≤ 50). E.g. - "bhubaneswar"	String	Mandatory
shopdistrict	District where the shop is. (5 ≤ length ≤ 50). E.g. - "Khorda"	String	Mandatory
shoparea	Area where the shop is. (5 ≤ length ≤ 30). E.g. - "bhubaneswar"	String	Mandatory
shoppincode	Pincode of the Shop. Exact length of 6. E.g. - "751024"	String	Mandatory
pancard	Pancard Number. PAN is a ten-digit unique alphanumeric. E.g. - "FMIPK0100K"	String	Mandatory

Sample Request Body

---

{ "productType": "POS", "deviceSerialNo": "5J769500", "account_number": "571070507511", "bank_name": "ICICI BANK", "bank_pincode": "756021", "ifsc_code": "ICIC0000918", "email_id": "devi@gmail.com", "aadhar_no": "105218008099", "dob": "05/01/1998", "gst_number": "22FMIPK0100K1Z5", "lat": "67567.9090", "long": "98.090", "bcagentid": "Archana", "bcagentname": "Devi", "middlename": "", "lastname": "Kar", "companyname": "iserveu", "address": "Bhubaneswar", "area": "bhubaneswar", "pincode": 752107, "mobilenumber": "6510090750", "shopaddress": "bhubaneswar", "shopstate": "Odisha", "shopname": "Haldiram sweets", "shopcity": "bhubaneswar", "shopdistrict": "Khorda", "shoparea": "bhubaneswar", "shoppincode": "751024", "pancard": "FMIPK0100K" }

Response Body Parameters

Parameters	Parameter Description	Data Type
status	Transaction Status(SUCCESS/FAILED) E.g. - "SUCCESS"	String
statusCode	Transaction Status Code (0/1). E.g. - 0	String
statusDesc	Status Description. E.g. - "User created successfully"	String
bcagentregistrationres	BC Agent Registration.	String
status	BC Agent Registration Status. E.g. - "1"	String
bcagentid	BC Agent ID. E.g. - "Archana"	String
description	Description. E.g. - "SUCCESSFULLY UPDATED"	String

Sample Response Body

Success :

{ "status": "SUCCESS", "statusCode": 0, "statusDesc": "User created successfully", "Data": { "bcagentregistrationres": { "status": "1", "bcagentid": "Archana", "description": "SUCCESSFULLY UPDATED" } } }

Failed:

Missing Bcagentid

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

Status Codes

Code	Significance	Description
0	SUCCESS	Successful
1	FAILED	Unsuccessful