Signup eKYC Initiate

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 KeyRequirementDescriptions
mobileMandatoryMobile Number of the merchant
(Mobile Number should be same as registered with Aadhaar)
panMandatoryPAN of outlet owner
(only individual PAN is allowed)
emailMandatoryEmail Address of the merchant (recommended as in Aadhaar)
aadhaarMandatoryEncrypted Aadhar Number with algorithm aes-256-cbc combined with your Encryption Key
bankAccountNoMandatoryAccount number of the merchant
bankIfscMandatortyIFS Code of the merchant
latitudeMandatoryLatitude of the merchant
longitudeMandatoryLongitude of the merchant
consentEnum (Y/N)Consent should be
accepted by
customer

Sample Request

curl --location --request POST 'https://api.instantpay.in/user/outlet/signup/initiate' \
--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" : "7428585742",
    "email" : "[email protected]",
    "aadhaar": "iVaOiRqmQ15/rnIY+dQbUWihrb7SbJhl+kEIRSb7Q=",
    "pan" : "AAOCS6028B",
    "bankAccountNo" : "7770007428585742",
    "bankIfsc" : "YESB0CMSNOC",
    "latitude" : "8.897394",
    "longitude" : "68.088013",
    "consent" : "Y"
}'
POST /user/outlet/signup/initiate 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" : "7428585742",
    "email" : "[email protected]",
    "aadhaar": "iVaOiRqmQ15/rnIY+dQbUWihrb7SbJhl+kEIRSb7Q=",
    "pan" : "AAOCS6028B",
    "bankAccountNo" : "7770007428585742",
    "bankIfsc" : "YESB0CMSNOC",
    "latitude" : "8.897394",
    "longitude" : "68.088013",
    "consent" : "Y"
}'

📘

Note :

Latitude and Longitude must be represented in degrees with 4 digits after decimal.

📘

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.

Response Parameters

Parameter KeyTypeDescription
statuscodeStringInstantPay Status Code
actcodeStringAction code
statusStringStatus message
dataArrayResponse Data (If Present)
timestampStringResponse time (YYYY-MM-DD HH:MM:SS))
ipay_uuidStringRequest reference number
orderidStringTransaction Id ( If transaction otherwise it is null )
environmentStringLive/Sandbox

Sample Response

{
    "statuscode": "TXN",
    "actcode": null,
    "status": "Transaction Successful",
    "data": {
        "aadhaar": "xxxxxxxx9744",
        "otpReferenceID": "ZjA5YmZmOef982h3929hkN2VhNDEz",
        "hash": "5GuAqAiFN9xMs24fRNlUUnhJ0dFs9jd67a2osFsoiZo6JCEIVXnjZTp4l4"
    },
    "timestamp": "2022-05-12 17:35:30",
    "ipay_uuid": "h00596e3bd-4f83-a8bd-7e08dfddb672-e2c7b5b",
    "orderid": "1220424130343AXKFA",
    "environment": "LIVE",
    "internalCode": null

}

📘

Aadhaar Encryption (Sample)

For Aadhaar Encryption Details click here

Language
Click Try It! to start a request and see the response here!