Implement this API to onboard an outlet to the InstantPay platform. InstantPay will update the outlet profile if it's already registered.
Header Parameters
For Header reference Click here
Request Parameters
Parameter Key | Requirement | Descriptions |
|---|---|---|
mobile | Mandatory | Mobile Number of the outlet owner |
pan | Mandatory | PAN of outlet owner |
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 --request POST 'https://api.instantpay.in/user/outlet/signup/minKyc' \
--header 'X-Ipay-Auth-Code: {{authCode}}' \
--header 'X-Ipay-Client-Id: {{clientId}}' \
--header 'X-Ipay-Client-Secret: {{clientSecret}}' \
--header 'X-Ipay-Endpoint-Ip: {{endPointIP}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"mobile" : "92XXXXXXXX08",
"email" : "[email protected]",
"pan" : "AAAAA1111P",
"address" : {
"full" : "xyz",
"city" : "Delhi",
"pincode" : "110011",
},
"aadhaar" : "gCOeZ+gRYLH2UE4rc5wRPM",
"dateOfBirth" : "1992-10-12",
"latitude" : “28.745678”,
"longitude" : “77.24234”
}'POST user/outlet/signup/minKyc HTTP/1.1
Host: api.instantpay.in
X-Ipay-Auth-Code: {{authCode}}
X-Ipay-Client-Id: {{clientId}}
X-Ipay-Client-Secret: {{clientSecret}}
X-Ipay-Endpoint-Ip: {{endPointIP}}
Content-Type: application/json
{
"mobile": "92XXXXXXXX08",
"email": "[email protected]",
"pan": "AAAAA1111P",
"address": {
"full": "xyz",
"city": "Delhi",
"pincode": "110011",
},
"aadhaar": "gCOeZ+gRYLH2UE4rc5wRPM",
"dateOfBirth": "1992-10-12",
"latitude": 36.9697,
"longitude": -3.1393
}Note :
Latitude and Longitude must be represented in degrees with 4 digits after decimal.
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
}Consent Text :
I hereby give my consent and submit voluntarily at my own discretion, my Aadhaar Number or VID for the
purpose of establishing my identity on the portal. The Aadhaar submitted herewith shall not be used for
any purpose other than mentioned, or as per the requirements of the law.