Cash Withdrawal

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

amount

String

M

Amount to be withdrawn

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

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

curl --location --request POST 'https://api.instantpay.in/fi/aeps/cashWithdrawal' \
--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-Outlet-Id: {{outletId}}' \
--data-raw '"Body": {
        "bankiin": "5****4",
        "latitude": "2*.***1",
        "longitude": "7*.****1",
        "mobile": "99******01",
        "amount": "10",
        "externalRef": "1651065364367",
        "biometricData": {
            "encryptedAadhaar": "GWFDLdnHmGF7Am6oG4F6X6GNyO02eQj24hlOiK/Y+js=",
            "dc": "81cfa394-d641-44cf-835d-cb65532bbc20",
            "ci": "20221021",
            "hmac": "I5EODHg8w1bkDDzUn5tJGJ8K0ZKBMGa4iD+yQgI63Hr6OwKy7KEkCdemVK5yFEP3",
            "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": "j8ZosXKbnzqqiXScig0WE3Rg3EZyGZKvscEMcQcSCOfdif0g7ccHUVLf+LVKOdm5EEWNbtxDSItk3GK1v3/f9fcWEIMbtvDkv4kkZlPs35TFsGkfO/hk5YLmjrFSHjMNqUYazajMQ2Tnvv1hFBLIVe1pJbeLqLYLt9Pj98heZhxbgpOdu1P7h0MMAzpPjv7NBIIeF+GUPH2qL45ui/cjJLd0F2r4YFq091Pl38OkKYbGTPeYdIvs6Oe5ZYfvnD1OU/i8ZBz5wgqYSmtrebcM1EbA6YxURmM03qLV8fqa8O/e3hyOE3tQ3hf1Z27oZckwgZYgzgtyrlaltemewD5hrQ==",
            "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:46:04+05:30",
            "pidData": "MjAyMi0wNC0yN1QxODo0NjowNLL1HoqElpz2slVi9REBE0SWvCFZFIDkDLN7fyjOF/c2oCR+YYPakGCjwlUUQyinqcuK0VEpdP14UqJd5r4nkqds8atvH/h0RTrupNJXVgyVkRkuWzpWRllvv0PGSvqJf/G6x7hGpFYq2JhAkN48xQO8f7L3XOzfrckd84M10yrlIUFZDlWCfx9CwghRLNYOFzQkD/Hqf9RHG1b7vi9R16RP8LIjCwS5w/GsumylYT++ad1Qug0hZYcneZJHf7Z6zK/43LBO6AuXc9ZbaZdBBymvqrrHsT50J4/P34ENzcmA4mBK3TnIfVPPZ6SNI2msZqbu7YM2O5CLoT6EE8DcvC9TwJqAVqV4ddVH3R2CkwCvDMQ+Lt08tUS8R5sxCYmUnR7BQk8kVHHiRhSZUfcJcQYTmdJKKv4wRi84ZEAfOwHPJ/rZU5hzJf6VdRoz48aJM1iv9ehg+4idng+HfbvnP99h68xEr5FHYT0cpFz91LfosKYmm2X6ioHCtHd+AASpyyBA0FGHSVvDRSZ4M+PtLG/jLGV1C61iMZZ2VkNZPoOH3XlqOup2ACOYECFaVcjYF6YM/T2wLj/7hFSCXKcQ4nmICpHY+3adbYnFmsoLnhQDZZbHyVuGWMFDvfg+jNk0c3S9XzFUaIqBDtw74o51Zzgn1s6ysmjjWzwt1R96golmhwtvHUET9fvB8UCC9nkweriTW2NbX9P84nngvijMZzE1BUUy5r7TP3nDYHIDcOgGRxYZdNC/Hn+G7dL8wx3C1d2Sg6Cwepz/09+jxNuFeE7Nznmd/v/ngoXaLzhSsNp11hC9lLukRoyvvp+rX/GPMrSW2jvTdL13YlijonK0ekmoqH9Vd7QBRCvxXTMVMC9byal+AUiCx7h0CCX+gByFGTstHDTa0MHmepOIG8G5xCJQqiY8EOxrWAi+halfFGMY9ztW/fgXlVGkjhtFbQTUDyGecfQeDSL31vOgCwVX5ts9g6G2GXMdpEYt8m25y3Dd6unL6eowpHGfKlJ3Gtkqc/XQvvRdo7iIMz2xkYOd3qBhwhwdhMN6doxtEIUFw0Q33JPlfZ/Z998rU5CDHscnvgDFC1vISTl4W0RvbnLSa2mh3N0Y67o+KacwVWOA5Yj9Qvx5T84qPeK3J233hUVctFjVsd1cjBTVXxTOSqjPRYVJwAljLlvWjwOhvA8OapyvWIVJa3viCNvR2RCTFR5npYlYn4/LlDotyGKKw7SlT14gwouMAMwYbROxFXjp7g5spX/UGohh4jCjIlWZKQFyyURXKm+j8EjJ8gvH47JgC+UE/TAI4qqH",
            "qScore": "100",
            "nmPoints": "46",
            "rdsVer": "1.0.3"
        }
    }'
POST /aeps/cashWithdrawal 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}}
X-Ipay-Outlet-Id:{{outletId}}

"Body": {
        "bankiin": "5****4",
        "latitude": "2*.***1",
        "longitude": "7*.****1",
        "mobile": "99******01",
        "amount": "10",
        "externalRef": "1651065364367",
        "biometricData": {
            "encryptedAadhaar": "GWFDLdnHmGF7Am6oG4F6X6GNyO02eQj24hlOiK/Y+js=",
            "dc": "81cfa394-d641-44cf-835d-cb65532bbc20",
            "ci": "20221021",
            "hmac": "I5EODHg8w1bkDDzUn5tJGJ8K0ZKBMGa4iD+yQgI63Hr6OwKy7KEkCdemVK5yFEP3",
            "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": "j8ZosXKbnzqqiXScig0WE3Rg3EZyGZKvscEMcQcSCOfdif0g7ccHUVLf+LVKOdm5EEWNbtxDSItk3GK1v3/f9fcWEIMbtvDkv4kkZlPs35TFsGkfO/hk5YLmjrFSHjMNqUYazajMQ2Tnvv1hFBLIVe1pJbeLqLYLt9Pj98heZhxbgpOdu1P7h0MMAzpPjv7NBIIeF+GUPH2qL45ui/cjJLd0F2r4YFq091Pl38OkKYbGTPeYdIvs6Oe5ZYfvnD1OU/i8ZBz5wgqYSmtrebcM1EbA6YxURmM03qLV8fqa8O/e3hyOE3tQ3hf1Z27oZckwgZYgzgtyrlaltemewD5hrQ==",
            "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:46:04+05:30",
            "pidData": "MjAyMi0wNC0yN1QxODo0NjowNLL1HoqElpz2slVi9REBE0SWvCFZFIDkDLN7fyjOF/c2oCR+YYPakGCjwlUUQyinqcuK0VEpdP14UqJd5r4nkqds8atvH/h0RTrupNJXVgyVkRkuWzpWRllvv0PGSvqJf/G6x7hGpFYq2JhAkN48xQO8f7L3XOzfrckd84M10yrlIUFZDlWCfx9CwghRLNYOFzQkD/Hqf9RHG1b7vi9R16RP8LIjCwS5w/GsumylYT++ad1Qug0hZYcneZJHf7Z6zK/43LBO6AuXc9ZbaZdBBymvqrrHsT50J4/P34ENzcmA4mBK3TnIfVPPZ6SNI2msZqbu7YM2O5CLoT6EE8DcvC9TwJqAVqV4ddVH3R2CkwCvDMQ+Lt08tUS8R5sxCYmUnR7BQk8kVHHiRhSZUfcJcQYTmdJKKv4wRi84ZEAfOwHPJ/rZU5hzJf6VdRoz48aJM1iv9ehg+4idng+HfbvnP99h68xEr5FHYT0cpFz91LfosKYmm2X6ioHCtHd+AASpyyBA0FGHSVvDRSZ4M+PtLG/jLGV1C61iMZZ2VkNZPoOH3XlqOup2ACOYECFaVcjYF6YM/T2wLj/7hFSCXKcQ4nmICpHY+3adbYnFmsoLnhQDZZbHyVuGWMFDvfg+jNk0c3S9XzFUaIqBDtw74o51Zzgn1s6ysmjjWzwt1R96golmhwtvHUET9fvB8UCC9nkweriTW2NbX9P84nngvijMZzE1BUUy5r7TP3nDYHIDcOgGRxYZdNC/Hn+G7dL8wx3C1d2Sg6Cwepz/09+jxNuFeE7Nznmd/v/ngoXaLzhSsNp11hC9lLukRoyvvp+rX/GPMrSW2jvTdL13YlijonK0ekmoqH9Vd7QBRCvxXTMVMC9byal+AUiCx7h0CCX+gByFGTstHDTa0MHmepOIG8G5xCJQqiY8EOxrWAi+halfFGMY9ztW/fgXlVGkjhtFbQTUDyGecfQeDSL31vOgCwVX5ts9g6G2GXMdpEYt8m25y3Dd6unL6eowpHGfKlJ3Gtkqc/XQvvRdo7iIMz2xkYOd3qBhwhwdhMN6doxtEIUFw0Q33JPlfZ/Z998rU5CDHscnvgDFC1vISTl4W0RvbnLSa2mh3N0Y67o+KacwVWOA5Yj9Qvx5T84qPeK3J233hUVctFjVsd1cjBTVXxTOSqjPRYVJwAljLlvWjwOhvA8OapyvWIVJa3viCNvR2RCTFR5npYlYn4/LlDotyGKKw7SlT14gwouMAMwYbROxFXjp7g5spX/UGohh4jCjIlWZKQFyyURXKm+j8EjJ8gvH47JgC+UE/TAI4qqH",
            "qScore": "100",
            "nmPoints": "46",
            "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": {
            "bankName": "CANARA BANK",
            "accountNumber": "xxxxxxxx4916",
            "ipayId": "CNA012226915183546",
            "transactionMode": "CR",
            "payableValue": "2.00",
            "transactionValue": "2.00",
            "openingBalance": "477.10",
            "closingBalance": "479.10",
            "operatorId": "226915975186",
            "walletIpayId": "1220926151836HXNZH",
            "bankAccountBalance": "199.59",
            "miniStatement": []
        },
        "timestamp": "2022-09-26 15:18:36",
        "ipay_uuid": "h005975b57d4-d1a0-4c89-90b0-b21e47732597",
        "orderid": "1220926151836HXNZH",
        "environment": "LIVE",
        "internalCode": null
    }

📘

Aadhaar Encryption (Sample)

For Aadhaar Encryption Details click here

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