post https://api.instantpay.in/fi/aeps/cashDeposit
AePS Cash Deposit refers to depositing cash into a bank account using the Aadhaar Enabled Payment System (AePS). It allows you to perform cash deposit into your bank account using your Aadhaar number and fingerprint authentication.
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 | Y |
| X-Ipay-Outlet-Id | String | Merchant Unique ID | M | N |
Request Parameters
| Name | Type | Mandatory (M) , Optional (O) | Description |
|---|---|---|---|
| bankiin | String | M | Bank IIN Number |
| mobile | String | M | Customer mobile number |
| amount | String | M | Amount to be deposited |
| latitude | String | M | latitude of current location |
| longitude | String | M | longitude of current location |
| biometricData | Array | M | Biometric Data |
| biometricData.encryptedAadhaar | String | M | Customer aadhaar number in encrypted. |
| biometricData.dc | String | M | Returned by RD Service when using biometric authentication. Registered Device code. |
| biometricData.sessionKey | String | M | Returned by RD Service when using biometric authentication. AES session key generated dynamically for every txn. |
| biometricData.ci | String | M | Returned by RD Service when using biometric authentication. Public key certificate identifier of UIDAI using which skey was encrypted. |
| biometricData.hmac | String | M | Returned by RD Service when using biometric authentication. SHA -256 Hash of PID XML and then encrypted and base 64 encoded |
| biometricData.pidData | String | M | Returned by RD Service when using biometric authentication. |
| biometricData.pidDataType | String | M | Returned by RD Service when using biometric authentication. Protobuff format or XML format. |
| biometricData.dpId | String | M | Returned by RD Service when using biometric authentication. Device provider Id. |
| biometricData.srno | String | O | Received from biometric machine |
| biometricData.ts | String | O | Received from biometric machine |
| biometricData.sysid | String | O | Received from biometric machine |
| biometricData.mi | String | M | Returned by RD Service when using biometric authentication. RD model Id. |
| biometricData.mc | String | M | Returned by RD Service when using biometric authentication. encrypted registered device public key certificate |
| biometricData.fCount | String | O | Total number of FIR records which was part of input. |
| biometricData.fType | String | M | When connecting the Device to RD service send ftype 2 in the request. |
| biometricData.iCount | String | Total number of IIR records which was part of input. | |
| biometricData.pCount | String | O | Number of face photo records to be captured (0 to 1). |
| biometricData.iType | String | O | ISO format (0 for IIR), 0 (IIR) is default. |
| biometricData.qScore | String | M | If quality check is done, send a normalized score that is between 0 and 100. Device providers may allow configuration within RD service to use specific quality check algorithms to be enabled. |
| biometricData.nmPoints | String | M | Number of minutiae points when FMR is captured. Applications may use this for accepting or retrying the capture. |
| biometricData.rdsVer | String | M | Returned by RD Service when using biometric authentication. RD Service version. |
| biometricData.rdsId | String | M | Returned by RD Service when using biometric authentication. RD Service Id. |
| biometricData.errCode | String | O | 0(Default)- Request success |
| biometricData.errInfo | String | O | Information about the error |
Sample Request
curl --location --request POST 'https://api.instantpay.in/fi/aeps/cashDeposit' \
--header 'X-Ipay-Auth-Code: {{authCode}}' \
--header 'X-Ipay-Client-Id: {{clientId}}' \
--header 'X-Ipay-Client-Secret: {{clientSecret}}' \
--header 'X-Ipay-Endpoint-Ip: {{endPointIP}}' \
--header 'X-Ipay-Outlet-Id: {{outletId}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"bankiin": "607152",
"latitude": "28.509360",
"longitude": "77.297310",
"mobile": "9971462546",
"amount": "150",
"externalRef": "1742895735-cash-deposit-test",
"biometricData": {
"encryptedAadhaar": "MGUxZGRjMjk0ZmRlNTg5lq+q1DuKYlNMI=",
"dc": "f9c79000-e322-4695-b561-49bbad5a1377",
"ci": "20250923",
"hmac": "HMFoo0mmEuj997nNVJuPzs2/zcDusWMSnCHdmj3Ce91oRuIeiI8jCWL6g1hfW4If",
"dpId": "MANTRA.MSIPL",
"mc": "MIIEADCCAuigAwIBAgIIRjM2QjE2RDcwDQYJ/BDaKeWSqs/f96eo5Zq+8P",
"pidDataType": "X",
"rdsId": "RENESAS.MANTRA.001",
"sessionKey": "k19v6Gx4DLTf2dq4F28owzUhmc54SAZ/b6lA1D//Rn1KbtQNSzReW2o/g==",
"mi": "MFS110",
"errCode": "0",
"errInfo": "Success",
"fCount": "1",
"fType": "2",
"iCount": "0",
"iType": null,
"pCount": "0",
"pType": null,
"srno": "6216079",
"sysid": "2d4d1b694b96a3f0",
"ts": "2025-03-25T15:12:09+05:30",
"pidData": "MjAyNS0wMy0yK0RXXCtVhGrSiHEsmXk7YF29ot67DRBy8ld0g3gII635BbfLsd/nxoLQ==",
"qScore": "78",
"nmPoints": "38",
"rdsVer": "1.3.0"
}
},
POST /fi/aeps/cashDeposit HTTP/1.1
Host: api.instantpay.in
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}}
Content-Type: application/json
{
"bankiin": "607152",
"latitude": "28.509360",
"longitude": "77.297310",
"mobile": "9971462546",
"amount": "150",
"externalRef": "1742895735-cash-deposit-test",
"biometricData": {
"encryptedAadhaar": "MGUxZGRjMjk0ZmRlNTg5No3mOSn4SNlq+q1DuKYlNMI=",
"dc": "f9c79000-e322-4695-b561-49bbad5a1377",
"ci": "20250923",
"hmac": "HMFoo0mmEuj997nNVJuPzs2/zcDusWMSnCHdmj3Ce91oRuIeiI8jCWL6g1hfW4If",
"dpId": "MANTRA.MSIPL",
"mc": "MIIEADCCAuigAwIBAgIIRjM2QjE2RDcwDQYJKoZIhvcNAQELBQAwgfwxKjAoBgNVBAMTIURTIE1hbnRyYSBTb2Z0ZWNoIEluZGlhIFB2dCBMdGQgMjFVMFMGA1UEMxNMQi0yMDMgU2hhcGF0aCBIZXhhIE9wcG9zaXRlIEd1amFyYXQgSGlnaCBDb3VydCBTLkcgSGlnaHdheSBBaG1lZGFiYWQgLTM4MDA2MDESMBAGA1UECRMJQUhNRURBQkFEMRAwDgYDVQQIEwdHVUpBUkFUMR0wGwYDVQQLExRURUNITklDQUwgREVQQVJUTUVOVDElMCMGA1UEChMcTWFudHJhIFNvZnRlY2ggSW5kaWEgUHZ0IEx0ZDELMAkGA1UEBhMCSU4wHhcNMjUwMzE3MDU0MjAwWhcNMjUwNjAxMDk1NzMwWjCBgjEPMA0GA1UEAxMGTUZTMTEwMQswCQYDVQQLEwJJVDEOMAwGA1UEChMFTVNJUEwxEjAQBgNVBAcTCUFobWVkYWJhZDELMAkGA1UECBMCR0oxCzAJBgNVBAYTAklOMSQwIgYJKoZIhvcNAQkBFhVzdXBwb3J0QG1hbnRyYXRlYy5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC8kUOA74p86hHmg0oWvSqKFboVvayp0hi28yTTIilds2k8I/RbSJG50GseyTwJGYLdwIrT6aui31sI3GvQuikwP84y5TnMRkG2N4HOtIlQeaXdi55ANbAwWbb7EaEO3YIEicrJfdp2PIBFYSDQkNCkn7Z3udlkaFEx3DG5hYH8pgmIHqMWdz1E4VBnUUeBVFBwy4EL7qNFMQa6Gee5PXBbtn+E3F8KRnepHBoBNGmkQ9yyXQdmTH/p45SB8UNu9Plj/DZMXg4Bci2AyY2gUOm9yQSNDnmTBdZGiew5OlTPH4eVzihWF63pscKn3GEUkUjcBdbwFe4+9o4mGUtqvsy9AgMBAAEwDQYJKoZIhvcNAQELBQADggEBAAd8B1SDCH3IvmR9zVV1IIF7Zqu+zIHac4Mcxt5cyiXss9nbyiwDjRhJIfyEOKAHhpwqvcpU0tCjmkMjuPikHw94NrIua+xtEywJEbzn1jrIW9gGaEChuM44qeRld3MFhCECyE+Sc9NnDwyvq7bRtG0nt0VNUpOXaM54fM4Z0YX5tmLB1xnK6BYQLlP8QH/nL0gG63gm+lHFqIoHAmY/jGgZy11rluNh9g0eo3Xa2QgVo5SeZ+pNponyv+nV++zhjJh2TxvD5u/kaZRJ54geeJa/nE/BDaKeWSqs/f96eo5Zq+8PL6Kh2MVrLfHSKtKqjFGchs18L6pJmq0nzXEALPY=",
"pidDataType": "X",
"rdsId": "RENESAS.MANTRA.001",
"sessionKey": "k19v6Gx4DLSAZ/b6lA1D//Rn1KbtQNSzReW2o/g==",
"mi": "MFS110",
"errCode": "0",
"errInfo": "Success",
"fCount": "1",
"fType": "2",
"iCount": "0",
"iType": null,
"pCount": "0",
"pType": null,
"srno": "6216079",
"sysid": "2d4d1b694b96a3f0",
"ts": "2025-03-25T15:12:09+05:30",
"pidData": "MjAyNS0wMy0yNVQxNToxMTo1NayXf+oAGOJAaJf5BbfLsd/nxoLQ==",
"qScore": "78",
"nmPoints": "38",
"rdsVer": "1.3.0"
}
},
Response Parameter
| 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": {
"externalRef": "1742895735-cash-deposit-test",
"bankName": "HDFC Bank",
"accountNumber": "xxxxxxxx8374",
"ipayId": "1250325151218NLPRL",
"transactionMode": "DR",
"payableValue": "149.71",
"transactionValue": "150.00",
"openingBalance": null,
"closingBalance": null,
"operatorId": "-1",
"walletIpayId": null,
"bankAccountBalance": null,
"miniStatement": []
},
"timestamp": "2025-03-25 15:12:20",
"ipay_uuid": "h0009e83f420-d741-43d9-a002-034aee5f9f38-3i5c8gatA99Z",
"orderid": null,
"environment": "LIVE",
"internalCode": null
},
Note:
Click here for guidelines for entering data in latitude/ longitude parameter.