post
https://api.instantpay.in/reports/statement
Fetch Statement of your InstantPay Collect Orders that you have linked with your InstantPay account.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Header Parameters
| Name | Type | Description | Mandatory (M) , Optional (O) | Provided by INSTANTPAY (Y/N) |
|---|---|---|---|---|
| X-Ipay-Auth-Code | String | 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 | N |
Request Parameters
| Parameters | Type | Mandatory (M) , Optional(O) | Description |
|---|---|---|---|
| bankProfileId | String | M | 0 (Fixed) |
| accountNumber | String | M | Account number |
| pagination | Array | M | Details of pagination |
| pagination.pageNumber | String | M | Current Page Number |
| pagination.recordsPerPage | String | M | Number of Details per Page |
| filters | Array | M | Details of filters |
| filters.txnDateFrom | String | M | From Date (YYYY-MM-DD) |
| filters.txnDateTo | String | M | To Date (YYYY-MM-DD) |
| isOrder | boolean | M | It will be True |
Sample Request
curl --location --request POST 'https://api.instantpay.in/reports/statement' \
--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 'Content-Type: application/json' \
--data-raw '{
"bankProfileId" : "0",
"accountNumber" : "7428585742",
"pagination" : {
"pageNumber" : 1,
"recordsPerPage" : 20
},
"filters": {
"txnDateFrom": "2022-04-26",
"txnDateTo": "2022-04-26"
},
"isOrder" : true
}'POST /reports/statement 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}}
Content-Type: application/json
{
"bankProfileId" : "0",
"accountNumber" : "7428585742",
"pagination" : {
"pageNumber" : 1,
"recordsPerPage" : 20
},
"filters" : {
"fromDate": "2022-04-28",
"toDate": "2022-04-29"
},
"isOrder" : true
}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": {
"meta": {
"totalPages": 1,
"currentPage": 1,
"totalRecords": 2,
"recordsOnCurrentPage": 0,
"recordFrom": 0,
"recordTo": 0
},
"records": [
{
"status": "SUCCESS",
"txnDateTime": "2022-04-28 17:16:47",
"ipayOrderId": "12****************QV",
"clientOrderId": "99**********39",
"transactionId": "13********56",
"settlementIpayOrderId": "1220********QBQV",
"productCode": "RJP",
"productName": "Reliance Jio",
"subProductCode": "ALL",
"subProductName": null,
"txnMode": "DR",
"txnChargedValue": "19.79",
"orderValue": "20.00",
"convenienceFee": "0.00",
"txnSurcharge": "0.0000",
"txnCashback": "0.2200",
"txnTds": "0.0110",
"narrationValue0": "70******49",
"narrationValue1": "",
"narrationValue2": "",
"narrationValue3": "",
"narrationValue4": "",
"narrationValue5": "",
"narrationValue6": "",
"narrationValue7": "",
"narrationValue8": "CASH",
"narrationValue9": "13.0414,80.2520|600018",
"responseCode": "TXN",
"responseMsg": "Transaction Successful"
},
{
"status": "SUCCESS",
"txnDateTime": "2022-04-28 17:15:39",
"ipayOrderId": "122***************LXF",
"clientOrderId": "999***********330",
"transactionId": "13**********64",
"settlementIpayOrderId": "",
"productCode": "RJP",
"productName": "Reliance Jio",
"subProductCode": "ALL",
"subProductName": null,
"txnMode": "DR",
"txnChargedValue": "19.79",
"orderValue": "20.00",
"convenienceFee": "0.00",
"txnSurcharge": "0.0000",
"txnCashback": "0.2200",
"txnTds": "0.0110",
"narrationValue0": "70*********71",
"narrationValue1": "",
"narrationValue2": "",
"narrationValue3": "",
"narrationValue4": "",
"narrationValue5": "",
"narrationValue6": "",
"narrationValue7": "",
"narrationValue8": "CASH",
"narrationValue9": "13.0414,80.2520|600018",
"responseCode": "TXN",
"responseMsg": "Transaction Successful"
}
]
},
"timestamp": "2022-04-29 14:58:48",
"ipay_uuid": "h00596*******-cd7c-4e36-****-1483cdc7ec4c",
"orderid": null,
"environment": "LIVE",
"internalCode": null
}