Aadhaar Pay

Headers Parameters

Name

Type

Description

Mandatory (M) , Optional (O)

Provided by INSTANTPAY (Y/N)

X-Ipay-Auth-Code

String

Auth Code- 1 (Fixed)

X-Ipay-Client-Id

String

Unique Client ID

X-Ipay-Client-Secret

String

Unique Client Secret

X-Ipay-Outlet-Id

String

Merchant Unique ID

X-Ipay-Endpoint-Ip

String

End Customer IP Address

Sample Request Parameters

Name

Type

Mandatory (M) , Optional (O)

Description

bankiin

String

M

Unique bank identification number (You will get it from Bank List API)

latitude

String

M

Current location latitude

longitude

String

M

Current location longitude

mobile

String

M

User Mobile no

amount

String

M

Amount to be withdrawn

externalRef

String

M

Unique Transaction Id

biometricData

Array

M

Biometric data details

biometricData.encryptedAadhaar

String

M

Aadhaar Number in aes-256-cbc encryption

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

O

When connecting the Device to RD service send ftype 2 in the request.

biometricData.iCount

String

O

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

base-64 encoded encrypted pid block.

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

POST /fi/aeps/aadhaarPay HTTP/1.1
Host: api.instantpay.in
X-Ipay-Auth-Code: 1
X-Ipay-Client-Id: YWY3OTAzYzNlM2ExZTJlOX923SyPZlQWg5sCmZbpfcw=
X-Ipay-Client-Secret: 261abf121c3e7b3fbf0bc6a71ed0b4e36e4ad2bcc760a1712cefe33da769090b
X-Ipay-Endpoint-Ip: 14.142.186.142
X-Ipay-Outlet-Id: 186318
Content-Type: application/json
Content-Length: 3946

{
  "bankiin": "607396",
  "latitude": "28.6441",
  "longitude": "77.21711",
  "mobile": "9990662401",
  "amount": "1",
  "externalRef": "1652769110778",
  "biometricData": {
    "encryptedAadhaar": "HezoC5sZn77/9DUTcdb10JmN8eqHbErGe+JcphWBqdY=",
    "dc": "48561c93-b778-4134-9f99-237de7f96f72",
    "ci": "20221021",
    "hmac": "hMFQdKgQr55fKtopUyTDK+EURGe0QtDu7m/Inx1FE/FbvQAPtUY2tZgVNdU+f8hk",
    "dpId": "MANTRA.MSIPL",
    "mc": "MIIEGDCCAwCgAwIBAgIEALcbADANBgkqhkiG9w0BAQsFADCB6jEqMCgGA1UEAxMhRFMgTWFudHJhIFNvZnRlY2ggSW5kaWEgUHZ0IEx0ZCA3MUMwQQYDVQQzEzpCIDIwMyBTaGFwYXRoIEhleGEgb3Bwb3NpdGUgR3VqYXJhdCBIaWdoIENvdXJ0IFMgRyBIaWdod2F5MRIwEAYDVQQJEwlBaG1lZGFiYWQxEDAOBgNVBAgTB0d1amFyYXQxHTAbBgNVBAsTFFRlY2huaWNhbCBEZXBhcnRtZW50MSUwIwYDVQQKExxNYW50cmEgU29mdGVjaCBJbmRpYSBQdnQgTHRkMQswCQYDVQQGEwJJTjAeFw0yMjA1MTcwOTI0MzdaFw0yMjA2MDQwNzAxMTJaMIGwMSUwIwYDVQQDExxNYW50cmEgU29mdGVjaCBJbmRpYSBQdnQgTHRkMR4wHAYDVQQLExVCaW9tZXRyaWMgTWFudWZhY3R1cmUxDjAMBgNVBAoTBU1TSVBMMRIwEAYDVQQHEwlBSE1FREFCQUQxEDAOBgNVBAgTB0dVSkFSQVQxCzAJBgNVBAYTAklOMSQwIgYJKoZIhvcNAQkBFhVzdXBwb3J0QG1hbnRyYXRlYy5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDLb115mEgnhxFjrQ1C23O4z6bdOA1aDuNUpN0iApeAwdYAASGFPM1ZMCdlBbPIMJBHAVFyZwyxtXOZdI5s6Ty/XhXsGpSfNYnI2zF0k+Ns4wsgs/75GBHqGBfdj2o/4hwd79hOZZVWMyZnWAphSQ0B2eOgwAW8C7mzLfmWapgopXi7iKlVBwuaPUvg/VtF32z+kxbNVP+Cl69sn82Y8T4FVJgFD7ilo8UWsFdBtmNIhgs3gElA6wwDfd7NhnR18K5jXHozLd1ViCUcwftMbsY2ZNmyswu9KyltS/s3KQIIdVtrk2wsTHOfjXh8csMzChP/Lz5eEl4rxt+koMBA/B2rAgMBAAEwDQYJKoZIhvcNAQELBQADggEBACP2TfzgBS7KgmfIixSc0l1OSSJnGDGS17l424YW3iAP4QcomJaNIlSlV8ty5IwC+WTsHVB8KFmZNtb5jWx75vcHQ7OfKM7bHLRv4PoHU+NMhNOSjbOaIcgp4EnWosA4Ysjc8Qzci5T8yqU3rXnDYTSKwwFduoBPRsg9MdHSiFA4G5vme6eaRl7sFTmqrfwBSNqR/MMfN3vC92fJz1AD2iUwtDmAwL5mqPi/6FqCD+ghk5yTCWt+e5cWjM32TAnWHTaLYZ3kNSbiD/rL4ayxacM4q2+hVqUnw8v0tjsITATi427VN9PZqUZbR5r2MVi9Hmo8i1LKF1Tx/igtPX74MrQ=",
    "pidDataType": "X",
    "sessionKey": "iWjJqk7WzE1/7pYMoHLadtH+EysPIU3gJx//5EWhjuGi1H+sVD0ZR3o0O9gUDkU8BQDPIDIxjqEKBxclCM3RhUb3dN1+T5hGC6PTzdLwZSwN2IazHlrBxGumP72kWpFlzxMWeAYDrenjs7gjwFbTC8ANLok1fiiRTJgp4cNXIW4Dr0SupfkmjSgTIxle9fW8z/RRcbBpzHyr8gQIqcs8Sg3amd12DtcRqsiR2NDHdu+QQIMH56rSOB1SuuEgEf42rhXKZScFeoHoc8t1lZ5/vdFMJ+DRx2Seal34tNyKIr0VtzNL5gEejlG+cm2aO6Z9UBNd45o0WBS2cDh/aHqVVg==",
    "mi": "MFS100",
    "rdsId": "MANTRA.WIN.001",
    "errCode": "0",
    "errInfo": "Success",
    "fCount": "1",
    "fType": "2",
    "iCount": 0,
    "iType": "",
    "pCount": 0,
    "pType": "",
    "srno": "0618138",
    "sysid": "6A7FEBFF0006273FBFF0",
    "ts": "2022-05-17T15:16:26+05:30",
    "pidData": "MjAyMi0wNS0xN1QxNToxNjoyNgkZAzn9w4fx5kqHKDOdQLlxlJ5V96Ylq6tch5RymqcgpKMzs29GoAzBN6u6hHDh0+OQMj9bioK3C7j+5YeYEQj6LBSdWFtWqiyfn8Il6qrMwdVY/RfJJU6fBHYb/UgxVbD0xIZmi3lcFaO/rTPGwNEu1+6k/3ddBAs+SJAjWcalUHBwMdLIIIA+AqoyYoD3jgYqp/B+N1GcRFDPDhoAkOABCo/gB6cTmPIOSiJ8L80PQMK5+icPIythDmpc0pOdJ+NhvqW3gfjyG3JzPxlM1d6KLMEqTkeiyUuCJARuQAoWX5JKRWdsq4yfERhxl4pKLoSP3l7r+2WApMk5I0kUsWpnqW2selM+8L5m0DPP3YW/oPcyy9+e8z5nvZyUISZitgDoTaMYf8b5zgWhuW5Dgvb0IklcT5ToWu/mhLdiCC/btgn1Ft1vlBPlTxZvwW9Qr9/kuNf2xN1UjoFHeFk2XFN8hrW6xqDSVbpSybgbH5dykO3t9z+PfGZw85R2rKdgarfwXG7dQCZfK06O2TujbNPG4B0hCOHvW0x9VGZWWVVUBm5uFnz1Q7XICKQPR84KBM4iuM5V+dWFykN+7eJafExCK8rMOBhfs2dCJSHxmXSaeVfsCyDEjrNgTWcDah7GE5sZ/fiqZcik29kBStOt8dOGOIIudF+etBTyjvaNwnUDXhVTzp86ZHhwYpC9g/1VREkPPfmvfJc77yeOMz/1Gv9n9ApJoeIJkZbgloku7B2MGSEIeffHDQGJ5hDdoeMvpCFSTCISuJofCRe85R+Zu5rHbddZXbISN/whmh7oCjS+51pyuvfBPPig9JRdYEcGpG/Rfhuj//3nAvYqvLSwuKxL0HO9eqvnLCAtH4f7wDWUa8SpVTSXQnyYEzyQSh9rgxoemW4nuT7jCehT9+5TmXY//fkw/JraYOvEDuyw5K4Bf40BuWrnsNoUmw4JC5B7gl7Ukw8ha+3uFOLOU5qk7H20heHjcKUe8cI1lKyH/wdcbAZGOsQ0WVc+h8kp4UdcCvBNow1iCkcZ5x5p7OzBYGVOjoRV7wRZSE15EwcOGD0E1ttRUaW93GtS+3du5BKPch+tNGIYYmvSEElgcw6S4bsuszVDNby/rsmcr6UKO/VzJcDmwCPgVmouCSFSCWuQL57G2GYTqi+E+njngD8ZlD+HWTCobikKr0IDcbHaV1jNCJNfQRsH0euwuTSgQ8lyQ6Gt76n6usVfcMvnFnXc0zxKVepqBazjR/gEX/U3wTK+8eItJPPccK5a6O9eGQTsRotCEi3qmYhdBLiGWA==",
    "qScore": "92",
    "nmPoints": "48",
    "rdsVer": "1.0.3"
}
}

Sample Response

{
        "statuscode": "TXN",
        "actcode": null,
        "status": "Transaction Successful",
        "data": {
            "openingBalance": "3743.34",
            "closingBalance": "3744.34",
            "ipayId": "CIA012213711364760",
            "payableValue": "1.00",
            "transactionValue": "1.00",
            "accountNumber": "xxxxxxxx0473",
            "transactionMode": "CR",
            "operatorId": "213711087026",
            "walletIpayId": "1220517113648NLQTU",
            "bankAccountBalance": 35960.18,
            "miniStatement": null
        },
        "timestamp": "2022-05-17 11:36:48",
        "ipay_uuid": "h00596517e8e-9e21-4643-b995-785a78506235",
        "orderid": "1220517113648NLQTU",
        "environment": "LIVE",
    }

Sample Response Parameters

Name

Type

Description

statuscode

String

InstantPay Status Code

actcode

String

Action Code

status

String

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

📘

Aadhaar Encryption (Sample)

For Aadhaar Encryption Details click here

Language
Click Try It! to start a request and see the response here!