post
https://api.instantpay.in/fi/remit/out/domestic/v2/beneficiaryRegistration
Headers 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
| Parameters | Type | Description |
|---|---|---|
| mobileNumber | String | Remitter Mobile Number |
| referenceKey | String | referenceKey received in Remitter Profile response |
| latitude | String | Agent Location latitude |
| longitude | String | Agent Location longitude |
| externalRef | String | Your Unique Transaction ID |
| consentTaken | String | consent It will be Y or N |
| biometricData | Array | Biometric Data Array |
| biometricData.ci | String | Returned by RD Service when using biometric authentication. Public key certificate identifier of UIDAI using which skey was encrypted. |
| biometricData.hmac | String | Returned by RD Service when using biometric authentication. SHA -256 Hash of PID XML and then encrypted and base 64 encoded |
| biometricData.pidData | String | base-64 encoded encrypted pid block. |
| biometricData.ts | String | Timestamp return by RD Service |
| biometricData.dc | String | Returned by RD Service when using biometric authentication. Registered Device code. |
| biometricData.mi | String | Returned by RD Service when using biometric authentication. RD model Id. |
| biometricData.dpId | String | Returned by RD Service when using biometric authentication. Device provider Id. |
| biometricData.mc | String | Returned by RD Service when using biometric authentication. encrypted registered device public key certificate |
| biometricData.rdsId | String | Returned by RD Service when using biometric authentication. RD Service Id. |
| biometricData.rdsVer | String | Returned by RD Service when using biometric authentication. RD Service version. |
| biometricData.Skey | String | Returned by RD Service when using biometric authentication. AES session key generated dynamically for every txn |
| biometricData.srno | String | Device Seriol number return by Rd service |
Sample Request
curl --location 'https://api.instantpay.in/fi/remit/out/domestic/v2/remitterKyc' \
--header 'X-Ipay-Endpoint-Ip: 14.142.186.142' \
--header 'X-Ipay-Client-Id: {{clientId}}' \
--header 'X-Ipay-Client-Secret: {{clientSecret}}' \
--header 'X-Ipay-Auth-Code: 1' \
--header 'User-Agent: {{userAgent}}' \
--header 'Content-Type: application/json' \
--data '{
"mobileNumber":"9876543210",
"referenceKey": "",
"latitude": "28.5093",
"longitude": "77.2973",
"externalRef":"2654016c-ff00-4865-a5ca-d174c4978679",
"consentTaken" : "Y",
"biometricData": {
"ci" : "",
"hmac" : "",
"pidData":"",
"ts":"",
"dc" : "",
"mi" : "",
"dpId" : "",
"mc" : "",
"rdsId" : "",
"rdsVer" : "",
"Skey" : "",
"srno":""
}
}'POST /fi/remit/out/domestic/v2/remitterKyc HTTP/1.1
Host: api.instantpay.in
X-Ipay-Endpoint-Ip: 14.142.186.142
X-Ipay-Client-Id: {{clientID}}
X-Ipay-Client-Secret: {{clientSecret}}
X-Ipay-Auth-Code: 1
Content-Type: application/json
Content-Length: 471
{
"mobileNumber":"9876543210",
"referenceKey": "",
"latitude": "28.5093",
"longitude": "77.2973",
"externalRef":"92d7c2af-a034-4d0a-bbb4-ccc413b048f1",
"consentTaken" : "Y",
"biometricData": {
"ci" : "",
"hmac" : "",
"pidData":"",
"ts":"",
"dc" : "",
"mi" : "",
"dpId" : "",
"mc" : "",
"rdsId" : "",
"rdsVer" : "",
"Skey" : "",
"srno":""
}
}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
{
"statuscode": "TXN",
"actcode": null,
"status": "Transaction Successful",
"data": {
"poolReferenceId": "1251216170846LRXLP",
"pool": {
"account": "9876543210",
"openingBal": "991233.63",
"mode": "DR",
"amount": "10.00",
"closingBal": "991233.63"
}
},
"timestamp": "2025-12-16 17:08:47",
"ipay_uuid": "h000a09b3791-d81f-402c-8a6d-c66b9b8518f5-skcmx0V91UG6",
"orderid": "1251216170846LRXLP",
"environment": "LIVE",
"internalCode": null
}