post https://api.instantpay.in/fi/aeps/miniStatement
A mini statement in AEPS (Aadhaar Enabled Payment System) typically provides a brief overview of recent transactions associated with a bank account linked to an Aadhaar card. This statement usually includes details such as the date, time, transaction type, and amount of the transactions.
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 | Mandatory (M) , Optional (O) | Description |
---|---|---|---|
bankiin | String | M | Unique bank identification number (You will get it from list of banks API) |
latitude | String | M | Current location latitude |
longitude | String | M | Current location longitude |
mobile | String | M | User Mobile no |
externalRef | String | M | Unique Reference number |
biometricData | Array | M | Biometric data details |
biometricData.encryptedAadhaar | String | M | Aadhar details in encrypted form. |
biometricData.dc | String | M | Returned by RD Service when using biometric authentication. Registered Device code. |
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.dpId | String | M | Returned by RD Service when using biometric authentication. Device provider Id. |
biometricData.mc | String | M | Returned by RD Service when using biometric authentication. encrypted registered device public key certificate |
biometricData.pidDataType | String | M | Returned by RD Service when using biometric authentication. Protobuff format or XML format. |
biometricData.sessionKey | String | M | Returned by RD Service when using biometric authentication. AES session key generated dynamically for every txn. |
biometricData.mi | String | M | Returned by RD Service when using biometric authentication. RD model Id. |
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 |
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 | M | Total number of IIR records which was part of input. |
biometricData.iType | String | O | ISO format (0 for IIR), 0 (IIR) is default. |
biometricData.pCount | String | O | Number of face photo records to be captured (0 to 1). |
biometricData.pType | String | M | Face format |
biometricData.srno | String | M | Serial Number of biometric device. |
biometricData.sysid | String | O | System Id |
biometricData.ts | String | O | Current Timestamp. |
biometricData.pidData | String | M | Returned by RD Service when using biometric authentication. |
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. |
Sample Request
curl --location --request POST 'https://api.instantpay.in/fi/aeps/miniStatement' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Ipay-Auth-Code: {{authCode}}' \
--header 'X-Ipay-Client-Id: {{clientId}}' \
--header 'X-Ipay-Client-Secret: {{clientSecret}}' \
--header 'X-Ipay-Endpoint-Ip: {{endPointIP}}' \
--data-raw ' {
"bankiin": "109104",
"latitude": "21.3241",
"longitude": "70.1321",
"mobile": "7428585742",
"externalRef": "1672908701918"
"biometricData": {
"encryptedAadhaar": "GWFDLdnHmGF7Am6oG4F6X6GNyO02eQj24hlOiK/Y+js=",
"dc": "81cfa394-d641-44cf-835d-cb65532bbc20",
"ci": "20221021",
"hmac": "B1q0v2t9Ebv+ubVCRSBV/9drAQCyvBv0Hw7mwuhxZ3eUp5DjfD1dAl0ovaaVGwOl",
"dpId": "STARTEK.ACPL",
"mc": "MIIDgDCCAmigAwIBAgIFAAZeW+IwDQYJKoZIhvcNAQELBQAwdDEdMBsGA1UEAxMUQklKQVkgQU1BUk5BVEggU0lOSEExEDAOBgNVBAgTB0dVSkFSQVQxETAPBgNVBAsTCERJUkVDVE9SMSEwHwYDVQQKExhBQ0NFU1MgQ09NUFVURUNIIFBWVCBMVEQxCzAJBgNVBAYTAklOMB4XDTIyMDQyNjA2MDg0M1oXDTIyMDUyNjA2MDg0M1owUTELMAkGA1UEBhMCSU4xEDAOBgNVBAgMB0d1amFyYXQxDTALBgNVBAoMBFVTRVIxDTALBgNVBAsMBFVTRVIxEjAQBgNVBAMMCVBST0RfVVNFUjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMk3kObEzchV/cithqKtBslzmafe4ky0mpPYwp4zTwt/d5RJ2JbtKnWYYLHJ8IUCXbhGPMtAmiZAG3fA6tlCw71z0rimo11g8GUQasfkKZE93V0cO8zW+V4Mi/V27mNfduZBGeGRyf5YPq4JDA3GnKrW7kSiHpUJ+KMp8QWZA5vqam0kknqGO06Zpx0x8jOmV27z3XN8Xh/3nDOfTh+NelQ6dkrLCkHpN4oWYPmj+uIF/JrTfPtgYe9+54z6LO/K3zNfHSsZtuO7IWWvC3DYFRoDLzc9pVAQ5DP0xxrEUYwJJu258NNrd4ouZel+EIEFg73FM9fTV5VxmmGxaQQugLECAwEAAaM8MDowDAYDVR0TBAUwAwEB/zALBgNVHQ8EBAMCAYYwHQYDVR0OBBYEFIuDs650JC9y2NFbmYq8mLXQLmEDMA0GCSqGSIb3DQEBCwUAA4IBAQAT9FUmGdDb9f1BpIhk0Ak3Zko2sggSMD9ORg7veRKTUEvX5xUNowDT37jgXWPRIn3lZ9pHIbJOL4oDLPQACpL2GReagcwGWyhm9J9ICO7Z0mocXhc/M101fWlpX0qEUhpNgaz+AqXWmM5vj6eeGd50xTXKirVmlzlnqwzc+1RNu3fP0h5HQhxd2HIroffLHLBEzVZMIaLZ7NBuMdCdfSfYa9fFAyFJ/WhT4hskcRNecZLoH89Bk1fgJMd7MnFXpe1JQqgZqE1REp+wDQom0DRxtyLT8a8HndP/1Fn/PiXP+AaJOmGiJMNZ66QBirdAxfQUhozPlich2KVFeOagTmyB",
"pidDataType": "X",
"sessionKey": "KAebH/4NCyDdrXVu7H6FVamT4mZnwl8peHNzyx46KG6c9YMtyd652MeRsr9HX6tFa5t9BPH0l4VzVALFMK6AD5Ql2+gOEY0i+CwlvoDuMGNIJTP8uqvm1fy8iG1VXTBnUevPQqKqIZrd+fnc0Tzts4C38YPW3hH2yWzZyKgii3OPw6KXtPp2j8/7Z71lnJkt6FlhyLhtmzE03o7Dbq5BunpdAYKNarXMxYGUy2ECGBKd995+nCUyDDl/g+fQuHHRhV7goVRE/btsihX3X9Oe9ccraKdsOoh917wI8IYrakGivV5hmn85kplD4AcS0wE4QFS1nNvXUxBOocL+1MwuiQ==",
"mi": "FM220U",
"rdsId": "ACPL.WIN.001",
"errCode": "0",
"errInfo": "",
"fCount": "1",
"fType": "2",
"iCount": 0,
"iType": "",
"pCount": 0,
"pType": "",
"srno": "N00115075",
"sysid": "MDAyNTM4ODU4MUI0OTgwNU4wQ1YxODM4TUIwMDU0NDk3SkFOMENWMDM2MjM3NDEw",
"ts": "2022-04-27T18:43:29+05:30",
"pidData": "MjAyMi0wNC0yN1QxODo0MzoyOSUxMT0lLsc/TjgrIhSnqQuLIVotyxAtu0vn8Lhcb0qLiL1cyIdapva5YwdQIyqCSDl8MYb1c95LPdiOygsskq8/HOWthwez+YfR/w6CKIbmeETOeMPOS8iuM0pdtCeWpSLy6iSKm1fay57WhceMyVGH7rg7Mh2QZyWr65ddiNJrUESWGXbRACZLPt6yCLGbPHy06qQE9Nl8rPpsBoxZWfjPp6fc+uBndoTHoHDirOPV29tbewLHCv0gPMPEFkRRhq7Rul7wksFpP1qJdZWGTLwIzDEo8C4S7E1sR7uthtE+X1frN/zLl1M8gCRkwg+bdtMrYlTGf753368y2D7+zeTUKNTfCeVOFyaPz6zP3wm6IuVM3HBQ49pFZNR1nlWRCGgS+5xqyUdgJTJS/6s/fxLi/PcsFz2Ul4BGyhcGqKEKYEa3ufdyDIf1sTXJHE5N7VmJT8Fa9UNwBClrTji6jdbEW8lhoVuHP1FptcyVT7UZ12c8Vheo+uSpcpZeeQlUWUBAXkMsnl/NTYdTLuBdaY2D9LdyuWHzZwj2U2Sluu5zSLgszEAL5qztSnVjtW/yq+YWVFfvOzSdxHx59Rrt0JF5vDMRfokIfKEIzO/7C84xxe4bY15PqxRWEJiXmfMkYpUxi+2Fbec9cHygzVgK3wP2IWhT/8ksENXNp0FjEPIfhMtxG5PeqyKNwgew5Lzt7tBjL3FLEqg8MHfSLizcjuew/QzR8zUMPeSOcX3ByvuLGEluVJ8RM8sQdoiVv3ALewBSEUie+Vo6x/Kio6mR27sLbfUuD+q+jCYKSdDq4gpYGO46qzDa5YVzO1DTf20Quwz122s32ICGQ49U1MoMSRPOCwMoroIbMF1qvCRUa83amj95fk/7Xi7VJh2zneAlLhx7imRyp+mdAVG46jGbXgMDKC3Y2OL/GVYY6yEudgfyObfV80icK57vy6rQ0Q9FS+EdsWbxlX68Hje+JpidUwiaaquhqAz+GjOZjJPGirYFVN0n7SNqMqvzOh/lcWBwlhVoKA/YZrMEn5gtyXKY7/ecaOtc9+bCqExt+uCXOdJLRUTarKUran60fN5wurBHzMoZTeOTesG9UdM175c4bCN8BAVLu1TLUG7fuqm5oZ+VyFXmkMMrMhNLnPLaeExrTp0APDnwxs/xcONiBlMKKCR5qoftsalfc9W1HWvhv5BnAgM1JMtisQK88BccmGWsb9g4fzQtlbHoUR/mHP5O8YDRQ8bsWfB2wkS5p8s4gQ8CLDtwjlHK1StS9UC99YvPUX7axHsd14Y=",
"qScore": "100",
"nmPoints": "44",
"rdsVer": "1.0.3"
}
}'
POST /aeps/miniStatement HTTP/1.1
Host: api.instantpay.in
Accept: application/json
Content-Type: application/json
X-Ipay-Auth-Code: {{authCode}}
X-Ipay-Client-Id: {{clientId}}
X-Ipay-Client-Secret: {{clientSecret}}
X-Ipay-Endpoint-Ip: {{endPointIP}}
"Body": {
"bankiin": "109104",
"latitude": "21.3241",
"longitude": "70.1321",
"mobile": "7428585742",
"externalRef": "1672908701918"
"biometricData": {
"encryptedAadhaar": "GWFDLdnHmGF7Am6oG4F6X6GNyO02eQj24hlOiK/Y+js=",
"dc": "81cfa394-d641-44cf-835d-cb65532bbc20",
"ci": "20221021",
"hmac": "B1q0v2t9Ebv+ubVCRSBV/9drAQCyvBv0Hw7mwuhxZ3eUp5DjfD1dAl0ovaaVGwOl",
"dpId": "STARTEK.ACPL",
"mc": "MIIDgDCCAmigAwIBAgIFAAZeW+IwDQYJKoZIhvcNAQELBQAwdDEdMBsGA1UEAxMUQklKQVkgQU1BUk5BVEggU0lOSEExEDAOBgNVBAgTB0dVSkFSQVQxETAPBgNVBAsTCERJUkVDVE9SMSEwHwYDVQQKExhBQ0NFU1MgQ09NUFVURUNIIFBWVCBMVEQxCzAJBgNVBAYTAklOMB4XDTIyMDQyNjA2MDg0M1oXDTIyMDUyNjA2MDg0M1owUTELMAkGA1UEBhMCSU4xEDAOBgNVBAgMB0d1amFyYXQxDTALBgNVBAoMBFVTRVIxDTALBgNVBAsMBFVTRVIxEjAQBgNVBAMMCVBST0RfVVNFUjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMk3kObEzchV/cithqKtBslzmafe4ky0mpPYwp4zTwt/d5RJ2JbtKnWYYLHJ8IUCXbhGPMtAmiZAG3fA6tlCw71z0rimo11g8GUQasfkKZE93V0cO8zW+V4Mi/V27mNfduZBGeGRyf5YPq4JDA3GnKrW7kSiHpUJ+KMp8QWZA5vqam0kknqGO06Zpx0x8jOmV27z3XN8Xh/3nDOfTh+NelQ6dkrLCkHpN4oWYPmj+uIF/JrTfPtgYe9+54z6LO/K3zNfHSsZtuO7IWWvC3DYFRoDLzc9pVAQ5DP0xxrEUYwJJu258NNrd4ouZel+EIEFg73FM9fTV5VxmmGxaQQugLECAwEAAaM8MDowDAYDVR0TBAUwAwEB/zALBgNVHQ8EBAMCAYYwHQYDVR0OBBYEFIuDs650JC9y2NFbmYq8mLXQLmEDMA0GCSqGSIb3DQEBCwUAA4IBAQAT9FUmGdDb9f1BpIhk0Ak3Zko2sggSMD9ORg7veRKTUEvX5xUNowDT37jgXWPRIn3lZ9pHIbJOL4oDLPQACpL2GReagcwGWyhm9J9ICO7Z0mocXhc/M101fWlpX0qEUhpNgaz+AqXWmM5vj6eeGd50xTXKirVmlzlnqwzc+1RNu3fP0h5HQhxd2HIroffLHLBEzVZMIaLZ7NBuMdCdfSfYa9fFAyFJ/WhT4hskcRNecZLoH89Bk1fgJMd7MnFXpe1JQqgZqE1REp+wDQom0DRxtyLT8a8HndP/1Fn/PiXP+AaJOmGiJMNZ66QBirdAxfQUhozPlich2KVFeOagTmyB",
"pidDataType": "X",
"sessionKey": "KAebH/4NCyDdrXVu7H6FVamT4mZnwl8peHNzyx46KG6c9YMtyd652MeRsr9HX6tFa5t9BPH0l4VzVALFMK6AD5Ql2+gOEY0i+CwlvoDuMGNIJTP8uqvm1fy8iG1VXTBnUevPQqKqIZrd+fnc0Tzts4C38YPW3hH2yWzZyKgii3OPw6KXtPp2j8/7Z71lnJkt6FlhyLhtmzE03o7Dbq5BunpdAYKNarXMxYGUy2ECGBKd995+nCUyDDl/g+fQuHHRhV7goVRE/btsihX3X9Oe9ccraKdsOoh917wI8IYrakGivV5hmn85kplD4AcS0wE4QFS1nNvXUxBOocL+1MwuiQ==",
"mi": "FM220U",
"rdsId": "ACPL.WIN.001",
"errCode": "0",
"errInfo": "",
"fCount": "1",
"fType": "2",
"iCount": 0,
"iType": "",
"pCount": 0,
"pType": "",
"srno": "N00115075",
"sysid": "MDAyNTM4ODU4MUI0OTgwNU4wQ1YxODM4TUIwMDU0NDk3SkFOMENWMDM2MjM3NDEw",
"ts": "2022-04-27T18:43:29+05:30",
"pidData": "MjAyMi0wNC0yN1QxODo0MzoyOSUxMT0lLsc/TjgrIhSnqQuLIVotyxAtu0vn8Lhcb0qLiL1cyIdapva5YwdQIyqCSDl8MYb1c95LPdiOygsskq8/HOWthwez+YfR/w6CKIbmeETOeMPOS8iuM0pdtCeWpSLy6iSKm1fay57WhceMyVGH7rg7Mh2QZyWr65ddiNJrUESWGXbRACZLPt6yCLGbPHy06qQE9Nl8rPpsBoxZWfjPp6fc+uBndoTHoHDirOPV29tbewLHCv0gPMPEFkRRhq7Rul7wksFpP1qJdZWGTLwIzDEo8C4S7E1sR7uthtE+X1frN/zLl1M8gCRkwg+bdtMrYlTGf753368y2D7+zeTUKNTfCeVOFyaPz6zP3wm6IuVM3HBQ49pFZNR1nlWRCGgS+5xqyUdgJTJS/6s/fxLi/PcsFz2Ul4BGyhcGqKEKYEa3ufdyDIf1sTXJHE5N7VmJT8Fa9UNwBClrTji6jdbEW8lhoVuHP1FptcyVT7UZ12c8Vheo+uSpcpZeeQlUWUBAXkMsnl/NTYdTLuBdaY2D9LdyuWHzZwj2U2Sluu5zSLgszEAL5qztSnVjtW/yq+YWVFfvOzSdxHx59Rrt0JF5vDMRfokIfKEIzO/7C84xxe4bY15PqxRWEJiXmfMkYpUxi+2Fbec9cHygzVgK3wP2IWhT/8ksENXNp0FjEPIfhMtxG5PeqyKNwgew5Lzt7tBjL3FLEqg8MHfSLizcjuew/QzR8zUMPeSOcX3ByvuLGEluVJ8RM8sQdoiVv3ALewBSEUie+Vo6x/Kio6mR27sLbfUuD+q+jCYKSdDq4gpYGO46qzDa5YVzO1DTf20Quwz122s32ICGQ49U1MoMSRPOCwMoroIbMF1qvCRUa83amj95fk/7Xi7VJh2zneAlLhx7imRyp+mdAVG46jGbXgMDKC3Y2OL/GVYY6yEudgfyObfV80icK57vy6rQ0Q9FS+EdsWbxlX68Hje+JpidUwiaaquhqAz+GjOZjJPGirYFVN0n7SNqMqvzOh/lcWBwlhVoKA/YZrMEn5gtyXKY7/ecaOtc9+bCqExt+uCXOdJLRUTarKUran60fN5wurBHzMoZTeOTesG9UdM175c4bCN8BAVLu1TLUG7fuqm5oZ+VyFXmkMMrMhNLnPLaeExrTp0APDnwxs/xcONiBlMKKCR5qoftsalfc9W1HWvhv5BnAgM1JMtisQK88BccmGWsb9g4fzQtlbHoUR/mHP5O8YDRQ8bsWfB2wkS5p8s4gQ8CLDtwjlHK1StS9UC99YvPUX7axHsd14Y=",
"qScore": "100",
"nmPoints": "44",
"rdsVer": "1.0.3"
}
}
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": {
"externalRef": "1672908701918",
"bankName": "ICICI Bank",
"accountNumber": "xxxxxxxx7259",
"ipayId": "CNA012300514211687",
"transactionMode": "CR",
"payableValue": "0.95",
"transactionValue": "0.00",
"openingBalance": "769.96",
"closingBalance": "770.91",
"operatorId": "300514648629",
"walletIpayId": "1230105142117KQVGY",
"bankAccountBalance": "163.00",
"miniStatement": [
{
"date": "02/01/2023",
"txnType": "CR",
"amount": "1.00",
"narration": "01015522"
},
{
"date": "18/10/2022",
"txnType": "DR",
"amount": "2000.00",
"narration": "NFI/CASH"
},
{
"date": "17/10/2022",
"txnType": "CR",
"amount": "2000.00",
"narration": "APBS/PM"
},
{
"date": "01/10/2022",
"txnType": "CR",
"amount": "1.00",
"narration": "01015522"
},
{
"date": "01/07/2022",
"txnType": "CR",
"amount": "1.00",
"narration": "01015522"
},
{
"date": "01/06/2022",
"txnType": "DR",
"amount": "2000.00",
"narration": "NFI/CASH"
},
{
"date": "31/05/2022",
"txnType": "CR",
"amount": "2000.00",
"narration": "APBS/PM"
},
{
"date": "02/04/2022",
"txnType": "CR",
"amount": "1.00",
"narration": "01015522"
},
{
"date": "01/01/2022",
"txnType": "CR",
"amount": "1.00",
"narration": "01015522"
}
]
},
"timestamp": "2023-01-05 14:21:17",
"ipay_uuid": "h005982670ba-ac90-4e3d-b95e-5e0d3cc34c76",
"orderid": "1230105142117KQVGY",
"environment": "LIVE",
"internalCode": null
}
Aadhaar Encryption (Sample)
For Aadhaar Encryption Details click here
Please Note :
To avoid transaction failures and account suspension, for every merchant you need to pass the unique outlet Id in the headers.