post https://api.instantpay.in/fi/remit/out/nepal/outletRegistration
This API is used to create sender.
Request Parameters
| Parameters | Type | Requirement | Description |
|---|---|---|---|
| otpReference | String | Mandatory | Otp Reference Id |
| otp | String | Mandatory | OTP received on Mobile |
| gender | String | Mandatory | Outlet Gender (Male, Female or Other) |
| category | String | Mandatory | Describes the Outlet category (General, OBC, ST, or SC) |
| fatherOrSpouseName | String | Mandatory | Father or Spouse Name of the Outlet |
| physicallyHandicapped | String | Mandatory | Describe the Physically Handicapped (Handicapped or Not Handicapped) |
| alternateOccupationType | String | Mandatory | Describe the alternate Outlet occupation (Government, Self Employed, Public Sector, Private, Other or None) |
| alternateOccupationDescription | String | Optional (Mandatory if alternateOccupationType is Other ) | Describe Outlet Occupation |
| highestEducation | String | Mandatory | Describes the highest education qualification of the Outlet (Under 10th, 10th, 12th, Graduate or Post Graduate) |
| operatingHoursFrom | String | Mandatory | Describes the Outlet shop opening hours. Example: (09:00 AM) |
| operatingHoursTo | String | Mandatory | Describes the Outlet shop closing hours. Example: (06:00 PM) |
| course | String | Mandatory | Describes the CSP course (IIBF Advance, IIBF Basic, Certified by Bank, or None) |
| courseCompletionDate | String | Optional | Describes the date of passing of the course (Not applicable for none) Format (MM/DD/YYYY) |
| instituteName | String | Optional | Describes the institute name from where the Outlet has done the course (Not applicable for none) |
| deviceName | String | Mandatory | Describes the device name (Laptop, or Handheld) |
| connectivityType | String | Mandatory | Describe the Outlet connectivity type (Landline, Mobile, or VSAT) |
| connectionProvider | String | Mandatory | Describe the provider’s name. Example: Airtel, JIO |
| weeklyOff | String | Mandatory | Describe the CSP week off. |
| expectedAnnualTurnover | String | Mandatory | Expected annual turnover of Outlet |
| expectedAnnualIncome | String | Mandatory | Expected 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 Name | Type | Description |
|---|---|---|
| statuscode | String | InstantPay Status Code |
| actcode | String | Action Code |
| status | String | Status message |
| data | Array | Response Data (If Present) |
| timestamp | String | Response time (YYYY-MM-DD HH:II:SS) |
| ipay_uuid | String | Request reference number |
| orderid | String | Transaction Id ( If transaction otherwise it is null ) |
| enviroment | String | Live/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"
}
Please Note :
If you encounter the error message 'Request failed, please re-onboard the outlet and try again' during outlet registration, you will need to onboard the outlet again using the Merchant Onboarding API.