Remitter Registration

This API is used to create sender.

Request Parameters

ParametersRequirementDescription
nameMandatoryName of the customer
genderMandatoryGender of the Remitter
(You will get this from Static Data API)
dobMandatoryDate of Birth of the customer. Format (YYYY-MM-DD)
addressMandatoryAddress of the Remitter.
cityMandatoryCity of the Remitter.
stateMandatoryState of the Remitter.
districtMandatoryDistrict of the Remitter.
nationalityMandatoryNationality of the Remitter.
emailMandatoryEmail Id of the Remitter
employerMandatoryEmployer of the Remitter
idTypeMandatoryId Type of Customer
(You will get this from Static Data API)
idNumberMandatoryId Number
idExpiryDateOptionalId Expiry Date
idIssuedPlaceOptionalId Issued Place
incomeSourceMandatoryIncome Source
(You will get this from Static Data API)
remitterTypeMandatoryDescribes the Remitter Type
1 - Salaried
2 - Self Employed including
Professional
3 - Farmer
4 - Housewife.
Minor customer is not allowed.
incomeSourceTypeMandatoryDescribes the Remitter source of income
1 - Govt
2 - Public sector
3 - Private Sector
4 - Business
5 - Agriculture
6 - Dependent
annualIncomeMandatoryDescribes the Remitter Salary
1 - Rs. 0.00 lacs to Rs. 2.00 Lacs
2 - Rs. 2.00 Lacs to Rs. 5 Lacs
3 - Rs. 5 Lacs to Rs. 10 Lacs
4 - More than Rs. 10 Lacs
otpReferenceMandatoryOtp Reference Id
otpMandatoryOTP received at Remitter Mobile Number.

Sample Request

curl --location --request POST 'https://api.instantpay.in/fi/remit/out/nepal/remitterRegistration' \
--header 'X-Ipay-Auth-Code: 1' \
--header 'X-Ipay-Client-Id: YWY3OTAzYzNlM2ExZTJlOfh549Gzt+5IEcETrD5Yx+Q=' \
--header 'X-Ipay-Client-Secret: 679db35f926b8d0240a8c0d28729528ee8e6d5effa5fa0b20c04454004d2d825' \
--header 'X-Ipay-Endpoint-Ip: 14.142.186.14' \
--header 'X-Ipay-Outlet-Id: 72762' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Sample Name",
    "gender": "Male",
    "dob": "1981-08-24",
    "address": "Sample Address",
    "mobile": "7428585742",
    "state": "State Name",
    "district": "District Name",
    "city": "City Name",
    "nationality": "Nationality",
    "email": "",
    "employer": "employerName",
    "idType": "Aadhaar Card",
    "idNumber": "Aadhaar Number",
    "idExpiryDate": "",
    "idIssuedPlace": "",
    "incomeSource": "Business",
    "remitterType": 1,
    "incomeSourceType": 3,
    "annualIncome": 2,
    "otpReference": "d322d9b0-e60b-4af2-94cf-57d8f4449b6f",
    "otp": "123456"
}
POST /fi/remit/out/nepal/remitterRegistration HTTP/1.1
Host: api.instantpay.in
X-Ipay-Auth-Code: 1
X-Ipay-Client-Id: YWY3OTAzYzNlM2ExZTJlOfh549Gzt+5IEcETrD5Yx+Q=
X-Ipay-Client-Secret: 679db35f926b8d0240a8c0d28729528ee8e6d5effa5fa0b20c04454004d2d825
X-Ipay-Endpoint-Ip: 14.142.186.14
X-Ipay-Outlet-Id: 72762
Content-Type: application/json
Content-Length: 600

{
    "name": "Sample Name",
    "gender": "Male",
    "dob": "1981-08-24",
    "address": "Sample Address",
    "mobile": "7428585742",
    "state": "State Name",
    "district": "District Name",
    "city": "City Name",
    "nationality": "Nationality",
    "email": "",
    "employer": "employerName",
    "idType": "Aadhaar Card",
    "idNumber": "Aadhaar Number",
    "idExpiryDate": "",
    "idIssuedPlace": "",
    "incomeSource": "Business",
    "remitterType": 1,
    "incomeSourceType": 3,
    "annualIncome": 2,
    "otpReference": "d322d9b0-e60b-4af2-94cf-57d8f4449b6f",
    "otp": "123456"
}

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": "TXN",
    "actcode": null,
    "status": "Transaction Successful",
    "data": {
        "id": "649881",
        "mobile": "7428585742",
        "firstName": "Sample Name",
        "gender": "Male",
        "dob": "1994-12-15",
        "address": "Sample Address",
        "city": "City Name",
        "state": "State Name",
        "district": "District Name",
        "nationality": "Nationality",
        "employer": "Instantpay Store",
        "incomeSource": "Business",
        "status": "Unverified",
        "approveStatus": "Commented",
        "approveComment": "Customer ID Copy Not Uploaded",
        "ids": [
            {
                "idType": "Aadhaar Card",
                "idNumber": "XXXXXXXX5677"
            }
        ],
        "transactionCount": {
            "day": "0",
            "month": "0",
            "year": "0"
        },
        "beneficiaries": []
    },
    "timestamp": "2022-10-13 12:45:29",
    "ipay_uuid": "h068977d53cb-96bc-4c8b-ae73-858b69a25c4d",
    "orderid": null,
    "environment": "LIVE",
    "internalCode": null
}

📘

Info :

For API Headers Click Here

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