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-Endpoint-Ip	String	End Customer IP Address	M	N
X-Ipay-Outlet-Id	String	Merchant unique ID	M	Y

Request Parameters

Parameter Name	Type	Description	Mandatory (M) , Optional (O)
mobileNumber	String	Mobile number of the Remitter	M
txnMode	String	Mode of the DMT Transaction (Values can be NEFT/ ALL)	O

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":"999999999",
    "txnMode":"NEFT"
}'

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": "9999999999",
        "firstName": "Abc",
        "lastName": "Abc",
        "city": "Abc",
        "pincode": "123456",
        "limitPerTransaction": 5000,
        "limitTotal": "100.00",
        "limitConsumed": "0.00",
        "limitAvailable": "100.00",
        "limitDetails": {
            "maximumDailyLimit": "100.00",
            "consumedDailyLimit": "0.00",
            "availableDailyLimit": "100.00",
            "maximumMonthlyLimit": "100.00",
            "consumedMonthlyLimit": "0.00",
            "availableMonthlyLimit": "100.00"
        },
        "beneficiaries": [
            {
                "id": "6833226d4f16c7798c",
                "name": "ABC",
                "account": "324456786567",
                "ifsc": "SBIN0010800",
                "bank": "State Bank of India",
                "beneficiaryMobileNumber": "999999999",
                "verificationDt": null
            }
        ],
        "isTxnOtpRequired": true,
        "isTxnBioAuthRequired": false,
        "isImpsAllowed": true,
        "isNeftAllowed": true,
        "isFaceAuthAvailable": true,
        "validity": "2025-11-12 11:48:18",
        "referenceKey": "uwQeaBp5+ROv7JO5EAVoq0stfqRvvj/7agIjTFnCWU3YLFM/xrHfuIP0QMKOwHa2",
        "pidOptionWadh": "E0jzJ/P8UopUHAieZn8CKqS4WPMi5ZSYXgfnlfkWjrc="
    },
    "timestamp": "2025-11-12 11:33:20",
    "ipay_uuid": "h000a0565a20-b3ec-43dd-9529-f845b2314484-RPkLqXG7Yh2l",
    "orderid": null,
    "environment": "LIVE"
}