post https://api.instantpay.in/fi/remit/out/domestic/v2/remitterProfile
Header Parameters
| Name | Type | Description | Mandatory (M) , Optional (O) | Provided by INSTANTPAY (Y/N) |
|---|---|---|---|---|
| X-Ipay-Auth-Code | String | Auth Code - 1 (Fixed) | M | Y |
| X-Ipay-Client-Id | String | Unique Client ID | M | Y |
| X-Ipay-Client-Secret | String | Unique secret key | M | Y |
| X-Ipay-Outlet-Id | String | Merchant unique ID | M | Y |
| X-Ipay-Endpoint-Ip | String | End Customer IP Address | M | N |
Request Parameters
| Name | Type | Description |
|---|---|---|
| mobileNumber | Number | Mobile number of the Remitter |
Sample Request
curl --location 'https://api.instantpay.in/fi/remit/out/domestic/v2/remitterProfile' \
--header 'X-Ipay-Endpoint-Ip: 14.142.186.142' \
--header 'X-Ipay-Client-Id: YWY3OTAzYxxxxxxxxGzt+5IEcETrD5Yx+Q=' \
--header 'X-Ipay-Client-Secret: 82e4755d7c1cfxxxxxxxxxxxxx2208df87f3000aa5b56fc926d1' \
--header 'X-Ipay-Auth-Code: 1' \
--header 'X-Ipay-Outlet-Id: 12345' \
--header 'Content-Type: application/json' \
--data '{
"mobileNumber":"9876543210"
}'
curl --location --request GET 'https://api.instantpay.in/fi/remit/out/domestic/remitterProfile?mobile=7428585742' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
X-Ipay-Auth-Code: {{authCode}}
X-Ipay-Client-Id: {{clientId}}
X-Ipay-Client-Secret: {{clientSecret}}
X-Ipay-Endpoint-Ip: {{endPointIP}}
X-Ipay-Outlet-Id:{{outletId}}
Response 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 | Current time (YYYY-MM-DD HH:II:SS) |
| ipay_uuid | String | Request reference number |
| orderid | String | Transaction Id ( If transaction otherwise it is null ) |
| environment | String | Live |
Sample Response If Remitter Not Found
{
"statuscode": "RNF",
"actcode": null,
"status": "Remitter Not Found",
"data": {
"validity": "2025-01-06 12:05:05",
"referenceKey": "s2ZfT5Bf0nzj1U0GZImtc646XxciZEMmo50OyDqJWjzfq8VciasgGQq6KsBIQss9",
"isTxnOtpRequired": true,
"isTxnBioAuthRequired": false,
"isFaceAuthAvailable": false,
"pidOptionWadh": "TF/lfPuh1n4ZY1xizYpqikIBm+gv65r51MFNek4uwNw="
},
"timestamp": "2025-01-06 11:50:06",
"ipay_uuid": "h0009de6c30e-d938-4a8b-98db-b2324866ff1f-U3QVbBlbLWMw",
"orderid": null,
"environment": "LIVE",
"internalCode": null
}
Important Info :
pidOptionWadh is the value which you need to pass in the pidOptions request, when sending request to RD Service for Biometric data.
Sample Response if Remitter is Registered
{
"statuscode": "TXN",
"actcode": null,
"status": "Success",
"data": {
"mobileNumber": “9876543210”,
"firstName": "John",
"lastName": "Doe",
"city": "NEW DELHI",
"pincode": "110044",
"limitPerTransaction": 5000,
"limitTotal": "25000.00",
"limitConsumed": "40.00",
"limitAvailable": "24960.00",
"limitDetails": {
"maximumDailyLimit": "25000.00",
"consumedDailyLimit": "40.00",
"availableDailyLimit": "24960.00",
"maximumMonthlyLimit": "25000.00",
"consumedMonthlyLimit": "40.00",
"availableMonthlyLimit": "24960.00"
},
"beneficiaries": [
{
"id": "bc607ec901164b636d747cda039e99cf",
"name": "John Doe",
"account": "32595104123",
"ifsc": "SBIN0000001",
"bank": "STATE BANK OF INDIA",
"beneficiaryMobileNumber": "9773744260",
"verificationDt": "2024-11-05 13:08:28"
},
{
"id": "fd85cfd370e219195a63f5c2c68d3c6f",
"name": "Instantpay",
"account": "9188606228799",
"ifsc": "PYTM0123456",
"bank": "PAYTM PAYMENTS BANK LTD",
"beneficiaryMobileNumber": "9971462546",
"verificationDt": "2020-03-09 12:08:27"
}
],
"isTxnOtpRequired": true,
"isTxnBioAuthRequired": false,
"validity": "2024-11-05 15:23:28",
"referenceKey": "eQJgp/xnEmxgcECVKTeqBveQqekPO9zDdnsHJGldvztYBQEByrUoAdYpbm5hDD5X"
},
"timestamp": "2024-11-05 15:08:28",
"ipay_uuid": "h0009d6a50fc-37cd-4d5e-a580-56a2425742e4-e0vU7m91ZlvB",
"orderid": null,
"environment": "LIVE",
"internalCode": null
}