Outlet Registration

This API is used to create sender.

Request Parameters

ParametersTypeRequirementDescription
otpReferenceStringMandatoryOtp Reference Id
otpStringMandatoryOTP received on Mobile
genderStringMandatoryOutlet Gender (Male, Female or
Other)
categoryStringMandatoryDescribes the Outlet category
(General, OBC, ST, or SC)
fatherOrSpouseNameStringMandatoryFather or Spouse Name of the Outlet
physicallyHandicappedStringMandatoryDescribe the Physically
Handicapped (Handicapped or
Not Handicapped)
alternateOccupationTypeStringMandatoryDescribe the alternate Outlet
occupation (Government, Self
Employed, Public Sector,
Private, Other or None)
alternateOccupationDescriptionStringOptional (Mandatory if alternateOccupationType is Other )Describe Outlet Occupation
highestEducationStringMandatoryDescribes the highest education
qualification of the Outlet (Under
10th, 10th, 12th, Graduate or
Post Graduate)
operatingHoursFromStringMandatoryDescribes the Outlet shop opening
hours. Example: (09:00 AM)
operatingHoursToStringMandatoryDescribes the Outlet shop closing
hours. Example: (06:00 PM)
courseStringMandatoryDescribes the CSP course
(IIBF Advance, IIBF Basic,
Certified by Bank, or None)
courseCompletionDateStringOptionalDescribes the date of passing of
the course (Not applicable for
none) Format (MM/DD/YYYY)
instituteNameStringOptionalDescribes the institute name from
where the Outlet has done the
course (Not applicable for none)
deviceNameStringMandatoryDescribes the device name
(Laptop, or Handheld)
connectivityTypeStringMandatoryDescribe the Outlet connectivity
type (Landline, Mobile, or VSAT)
connectionProviderStringMandatoryDescribe the provider’s name.
Example: Airtel, JIO
weeklyOffStringMandatoryDescribe the CSP week off.
expectedAnnualTurnoverStringMandatoryExpected annual turnover of Outlet
expectedAnnualIncomeStringMandatoryExpected annual turnover of Outlet

Sample Request

curl --location 'https://api.instantpay.in/fi/remit/out/nepal/outletRegistration' \
--header 'X-Ipay-Auth-Code: 1' \
--header 'X-Ipay-Client-Id: YWY3OTAzYzNlM2ExZTJlOfh549Gzt+5IEcETrD5Yx+Q=' \
--header 'X-Ipay-Client-Secret: 82e4755d7c1cf636816addfe1460936d7b64612208df87f3000aa5b56fc926d1' \
--header 'X-Ipay-Endpoint-Ip: 125.0.0.1' \
--header 'X-Ipay-Outlet-Id: 72762' \
--header 'Content-Type: application/json' \
--data '{
    "otpReference": "123456789",
    "otp": "112111",
    "gender": "Male",
    "category": "General",
    "fatherOrSpouseName": "RohanSINGH rawat",
    "physicallyHandicapped": "Not Handicapped",
    "alternateOccupationType": "None",
    "alternateOccupationDescription": "",
    "highestEducation": "10th",
    "operatingHoursFrom": "12:00 AM",
    "operatingHoursTo": "23:00 PM",
    "course": "None",
    "courseCompletionDate": "",
    "instituteName": "",
    "deviceName": "Laptop",
    "connectivityType": "Mobile",
    "connectionProvider": "JIO",
    "weeklyOff": "None",
    "expectedAnnualTurnover": 100000,
    "expectedAnnualIncome": 100000
}'
POST /fi/remit/out/nepal/outletRegistration HTTP/1.1
Host: api.instantpay.in
X-Ipay-Auth-Code: 1
X-Ipay-Client-Id: YWY3OTAzYzNlM2ExZTJlOfh549Gzt+5IEcETrD5Yx+Q=
X-Ipay-Client-Secret: 82e4755d7c1cf636816addfe1460936d7b64612208df87f3000aa5b56fc926d1
X-Ipay-Endpoint-Ip: 125.0.0.1
X-Ipay-Outlet-Id: 72762
Content-Type: application/json
Content-Length: 659

{
    "otpReference": "123456789",
    "otp": "112111",
    "gender": "Male",
    "category": "General",
    "fatherOrSpouseName": "RohanSINGH rawat",
    "physicallyHandicapped": "Not Handicapped",
    "alternateOccupationType": "None",
    "alternateOccupationDescription": "",
    "highestEducation": "10th",
    "operatingHoursFrom": "12:00 AM",
    "operatingHoursTo": "23:00 PM",
    "course": "None",
    "courseCompletionDate": "",
    "instituteName": "",
    "deviceName": "Laptop",
    "connectivityType": "Mobile",
    "connectionProvider": "JIO",
    "weeklyOff": "None",
    "expectedAnnualTurnover": 100000,
    "expectedAnnualIncome": 100000
}

Response Parametes

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

Sample Response

{
    "statuscode": "TUP",
    "actcode": "OUTLETEKYC",
    "status": "Outlet registered successfully, Kindly initiate E-Kyc",
    "data": null,
    "timestamp": "2024-07-03 11:31:58",
    "ipay_uuid": "h0009c6e8e88-2c69-4925-b205-6c9412ad6d50-0bSpX6BWlzcZ",
    "orderid": null,
    "environment": "LIVE"
}

📘

Info :

For API Headers Click Here

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