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	N

📘
Info:
Click Here to know how to get the Credentials.

Request Parameters

Parameters	Type	Mandatory (M) , Optional(O)	Description
bankProfileId	String	M	0 (Fixed)
accountNumber	String	M	Account number
externalRef	String	M	Unique Reference number
pagination	Array	M	Details of pagination
pagination.pageReference	String	M	no of pages
filters	String	M	Details of filters
filters.txnDateFrom	String	M	From Date (YYYY-MM-DD)
filters.txnDateTo	String	M	To Date (YYYY-MM-DD)

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" : "10910",
    "accountNumber" : "7428585742",
    "externalRef" : "PROD12378",
    "pagination" : {
        "pageNumber" : 1,
        "recordsPerPage" : 20
    },
    "filters": {
        "txnDateFrom": "2022-04-26",
        "txnDateTo": "2022-04-26"
    }
    }'

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" : "10910",
    "accountNumber" : "7428585742",
    "externalRef" : "PROD12378",
    "pagination" : {
        "pageNumber" : 1,
        "recordsPerPage" : 20
    },
    "filters": {
        "fromDate" : "2022-03-18",
        "toDate" : "2022-03-21"
    }
}

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": {
    "statements": {
      "pageReference": "",
      "records": [
        {
          "txnDate": "2022-03-18 17:40:30",
          "txnId": "S60778063",
          "amount": "104814.09",
          "type": "CR",
          "balance": "31311795.24",
          "narration1": "BC ACQ AEPS COMMISSION_170322",
          "narration2": ""
        },
        {
          "txnDate": "2022-03-19 08:14:13",
          "txnId": "S73994678",
          "amount": "4000000.00",
          "type": "DR",
          "balance": "27311795.24",
          "narration1": "RTGS|ICICR42022031900500690|TJSB0000155|INSTANTPAY INDIA LIMITED",
          "narration2": ""
        }
      ]
    }
  },
  "timestamp": "2022-03-21 18:46:52",
  "ipay_uuid": "h00595df6e53-5f93-4a95-b69c-2dcb52cb8c80",
  "orderid": null,
  "environment": "LIVE",
  "internalCode": null

}

❗️
Note :
externalRef must be unique and in alpha numeric characters.
This API call is chargeable, For more Information connect with your respective Key Account Manager.