Signup 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 Key

Requirement

Descriptions

mobile

Mandatory

Mobile Number of the outlet owner
(Mobile Number should be same as registered with Aadhaar)

pan

Mandatory

PAN of outlet owner
(only individual PAN is allowed)

email

Mandatory

Email Address of the outlet owner (recommended as in Aadhaar)

aadhaar

Mandatory

Encrypted Aadhar Number with algorithm aes-256-cbc combined with your Encryption Key

latitude

Mandatory

Latitude of the Outlet

longitude

Mandatory

Longitude of the Outlet

consent

Enum (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": "97******31",
    "pan": "CJ******5F",
    "email": "**************",
    "aadhaar": "FgCOeZ+gRYLH2********************UE4rc5wRPM=",
    "latitude": "*******",
    "longitude": "******",
    "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": "97******31",
    "pan": "CJ******5F",
    "email": "**************",
    "aadhaar": "FgCOeZ+gRYLH2********************UE4rc5wRPM=",
    "latitude": "*******",
    "longitude": "******",
    "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 Key

Type

Description

statuscode

String

InstantPay Status Code

actcode

String

Action code

status

String

Status message

aadhaarNumber

String

Masked Aadhaar

otpReferenceID

String

OTP Ref (Required in Validate API)

hash

String

Hash (Required in Validate API)

Sample Response

{
    "statuscode": "TXN",
    "actcode": null,
    "status": "Transaction Successful",
    "data": {
        "aadhaar": "xxxxxxxx9744",
        "otpReferenceID": "ZjA5YmZmO********************************kN2VhNDEz",
        "hash": "5GuAqAiFN9xMs24fRNlU******************************67a2osFsoiZo6JCEIVXnjZTp4l4"
    },
    "timestamp": "2022-05-12 17:35:30",
    "ipay_uuid": "h00596*************************e2c7b5b",
    "orderid": "1220************RW",
    "environment": "LIVE",
}

πŸ“˜

Aadhaar Encryption (Sample)

For Aadhaar Encryption Details click here

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