Implement this API to onboard an outlet to the InstantPay platform. InstantPay will update the outlet profile if it's already registered.
Header ParametersFor Header reference Click here
Request Parameters
Parameter Key | Requirement | Descriptions |
|---|---|---|
mobile | Mandatory | Mobile Number of the outlet |
name | Mandatory | Name of the merchant as per PAN |
gender | Mandatory | Gender of the merchant (It will be M,F or T) |
pan | Mandatory | PAN of merchant |
Mandatory | Email Address of the Merchant (recommended as in Aadhaar) | |
address | Mandatory | Address Array |
address.full | Mandatory | Full address of the Merchant |
address.city | Mandatory | City Name of the Merchant |
address.pincode | Mandatory | Address pincode |
aadhaar | Mandatory | Encrypted Aadhar Number with algorithm aes-256-cbc |
dateOfBirth | Mandatory | User date of birth format ( YYYY-MM-DD) |
latitude | Mandatory | Exact location of the Merchant must be represented in degrees |
longitude | Mandatory | Exact location of the Merchant must be represented in degrees |
Sample Request
curl --location 'https://api.instantpay.in/user/outlet/signup/minKyc' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Ipay-Auth-Code: 1' \
--header 'X-Ipay-Client-Id: {{clientId}}' \
--header 'X-Ipay-Client-Secret: {{clientSecret}}' \
--header 'X-Ipay-Endpoint-Ip: 45.115.105.205' \
--data-raw '{
"mobile": "9876543210",
"name" : "Shahbaz Ali",
"gender" : "M",
"pan": "ABCDE1234F",
"email": "[email protected]",
"address": {
"full": "Sarai Dubey, Gt Road, Aligarh",
"city": "Aligarh",
"pincode": "202001"
},
"aadhaar": "ZDEzNTg1OWQzNmE5NmY5ZG4koGZnmLAlV2Of7dgQyBI=",
"dateOfBirth": "1990-04-05",
"latitude": "21.91223",
"longitude": "82.019339"
}'POST /user/outlet/signup/minKyc HTTP/1.1
Host: api.instantpay.in
Accept: application/json
Content-Type: application/json
X-Ipay-Auth-Code: 1
X-Ipay-Client-Id: {{clientId}}
X-Ipay-Client-Secret: {{clientSecret}}
X-Ipay-Endpoint-Ip: 45.115.105.205
Content-Length: 423
{
"mobile": "9876543210",
"name" : "Shahbaz Ali",
"gender" : "M",
"pan": "ABCDE1234F",
"email": "[email protected]",
"address": {
"full": "Sarai Dubey, Gt Road, Aligarh",
"city": "Aligarh",
"pincode": "202001"
},
"aadhaar": "ZDEzNTg1OWQzNmE5NmY5ZG4koGZnmLAlV2Of7dgQyBI=",
"dateOfBirth": "1990-04-05",
"latitude": "21.91223",
"longitude": "82.019339"
}
Note :Latitude and Longitude must be represented in degrees with 4 digits after decimal.
Please ensure that the address entered is the same as the address registered with Aadhaar.
The name and date of birth must exactly match the details registered with PAN.
Response Parameters
| Parameter Key | Type | Description |
|---|---|---|
| outletId | String | Unique Merchant Outlet Id |
| name | String | Merchant Name |
| dateOfBirth | String | Date of birth Format (YYYY-MM-DD) |
| gender | String | M - Male / F - Female /T - Transgender |
| pincode | String | Area Pincode |
| state | String | Merchant State Name |
| districtName | String | Merchant District name |
| address | String | Merchant Address |
| profilePic | String | Merchant profile Pic |
Sample Response
{
"statuscode": "TXN",
"actcode": null,
"status": "Transaction Successful",
"data": {
"outletId": 37464,
"name": "A**HIT G**TA",
"dateOfBirth": "1999-02-22",
"gender": "M",
"pincode": "2*2**1",
"state": "UTTAR PRADESH",
"districtName": "ALIGARH",
"address": "13/52 SARAI ***** GT ROAD *****",
"profilePic": null
},
"timestamp": "2023-08-01 17:56:51",
"ipay_uuid": "h00099c92a83-dc41-4acf-859d-5cdd879e6d45",
"orderid": "1230801175651SDQQE",
"environment": "SANDBOX",
"internalCode": null
}