Onboard Merchant
Onboard Merchant
Postman Collection
URL
POST : /v1/service/aeps/merchantOnBoardHeaders
Content-Type (String) required
application/json
application/json
Authorization (String) required
Basic Auth
Basic Auth
Accept (String) required
application/json
application/json
Body Params
firstName (String) Required
First Name of the Merchant (Max Length: 30)
First Name of the Merchant (Max Length: 30)
middleName (String) Optional
Middle Name of the Merchant (Max Length: 30)
Middle Name of the Merchant (Max Length: 30)
lastName (String) Optional
Last Name of the Merchant (Max Length: 30)
Last Name of the Merchant (Max Length: 30)
mobile (String) Required
Mobile Number of the Merchant (Max Length: 10)
Mobile Number of the Merchant (Max Length: 10)
email (String) Required
Email of the Merchant (Max Length: 50)
Email of the Merchant (Max Length: 50)
address (String) Required
Address of the Merchant (Max Length: 150)
Address of the Merchant (Max Length: 150)
state (Number) Required
State Id (Max Length: 5)
State Id (Max Length: 5)
district (Number) Required
District Id (Max Length: 5)
District Id (Max Length: 5)
pinCode (String) Required
Pin Code of the Merchant (Max Length: 6)
Pin Code of the Merchant (Max Length: 6)
dob (String) Required
DOB of the Merchant (Max Length: YYYY-MM-DD)
DOB of the Merchant (Max Length: YYYY-MM-DD)
aadhaarNo (String) Required
Aadhaar number of the Merchant (Max Length: 12)
Aadhaar number of the Merchant (Max Length: 12)
panNo (String) Required
Pan number of the Merchant (Max Length: 10)
Pan number of the Merchant (Max Length: 10)
service (String) Required
Api Service Type (Like ICICI) (Max Length: Fixed)
Api Service Type (Like ICICI) (Max Length: Fixed)
merchantCode (String) Optional
Merchant unique ID (Max Length: Empty String)
Merchant unique ID (Max Length: Empty String)
shopName (String) Required
Merchant shop name (Max Length: 50)
Merchant shop name (Max Length: 50)
shopAddress (String) Required
Merchant shop address (Max Length: 100)
Merchant shop address (Max Length: 100)
shopPin (String) Required
Merchant Shop Pin Code (Max Length: 6)
Merchant Shop Pin Code (Max Length: 6)
Request
Example Request
curl --location --request POST '/v1/service/aeps/merchantOnBoard' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic e3tsb2NfdXNlcn19Ont7bG9jX3Bhc3N9fQ==' \
--data-raw '{
"firstName":"abc",
"middleName":"",
"lastName":"xyz",
"mobile":"9999999999",
"email":"example@example.com",
"address":"Lucknow ",
"state":34,
"district":657,
"pinCode":"224204",
"dob":"1996-03-13",
"aadhaarNo":"930000240095",
"panNo":"ASDFG1234H",
"service":"I",
"merchantCode":"",
"shopName":"XYZ CSC Point",
"shopAddress":"2/34, Adarsh Nagar, Lucknow",
"shopPin":"224204"
}'
Response Samples
- SUCCESS
- FAILED
{
"code": "0x0200",
"message": "000: Merchant onboard successfully.",
"status": "SUCCESS",
"data": {
"merchantCode": "MC000123123",
"firstName": "abc",
"middleName": "",
"lastName": "xyz",
"mobile": "9999999999",
"email": "example@example.com",
"pinCode": "224204",
"dob": "1996-03-13",
"aadhaarNo": "930000240095",
"panNo": "ASDFG1234H",
"status": "A",
"remarks": "",
"service": "ICICI",
"cd": "True",
"be": "True",
"cw": "True",
"ms": "True",
"eKycStatus": "False",
"state": "Uttar Pradesh",
"district": "Lucknow",
"shopName": "XYZ CSC Point",
"shopAddress": "2/34, Adarsh Nagar, Lucknow",
"shopPin": "224204"
}
}
{
"code": "0x0202",
"status": "FAILURE",
"message": "Merchant Onboard Failed"
}
Response Code
| Status Code | Status | Message |
|---|---|---|
| 0x0200 | SUCCESS | TRANSACTION SUCCESSFULL |
| 0x0201 | UNAUTHORIZED | UNAUTHORIZED USER |
| 0x0202 | FAILURE | FAILURE USER |
| 0x0203 | MISSING_PARAMETER | MISSING PARAMETER |
| 0x0204 | CONNECTION_TIMEOUT | CONNECTION TIMEOUT |
| 0x0205 | SOMETHING_WENT_WRONG | SOMETHING WENT WRONG |
| 0x0206 | PENDING | TRANSACTION PENDING |
| 0x0208 | 2FA | TWO FACTOR AUNTHENTICATION |