This API is used to create sender.
Request Parameters
Parameters | Requirement | Description |
|---|---|---|
name | Mandatory | Name of the customer |
gender | Mandatory | Gender of the Remitter |
dob | Mandatory | Date of Birth of the customer. Format (YYYY-MM-DD) |
address | Mandatory | Address of the Remitter. |
city | Mandatory | City of the Remitter. |
state | Mandatory | State of the Remitter. |
district | Mandatory | District of the Remitter. |
nationality | Mandatory | Nationality of the Remitter. |
Mandatory | Email Id of the Remitter | |
employer | Mandatory | Employer of the Remitter |
idType | Mandatory | Id Type of Customer |
idNumber | Mandatory | Id Number |
idExpiryDate | Optional | Id Expiry Date |
idIssuedPlace | Optional | Id Issued Place |
incomeSource | Mandatory | Income Source |
remitterType | Mandatory | Describes the Remitter Type |
incomeSourceType | Mandatory | Describes the Remitter source of income |
annualIncome | Mandatory | Describes the Remitter Salary |
otpReference | Mandatory | Otp Reference Id |
otp | Mandatory | OTP 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 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": "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