v1

latestOpenAPI 3.1.02026-07-2414704.6 MB

Bank Accounts

Fetch Statement of your all other bank accounts that you have linked with your InstantPay account.

post/statement

Headers

X-Ipay-Auth-Codestring
X-Ipay-Client-Idstring

Unique Client Id Provided by Instantpay

X-Ipay-Client-Secretstring

Unique Client Secret Provided by Instantpay

X-Ipay-Endpoint-Ipstring

Customer Ip Address

Request body

bankProfileIdstring required
accountNumberstring required

Linked Current Account Number

externalRefstring required

Unique Transaction Id

Response

200

statuscodestring
{"stackTrail":"paths:/statement:post:responses:200:content:application/json:schema:properties:actcode","oasType":"schema","type":"unknown"}
statusstring
timestampstring
ipay_uuidstring
{"stackTrail":"paths:/statement:post:responses:200:content:application/json:schema:properties:orderid","oasType":"schema","type":"unknown"}
environmentstring

Example response

{
  "statuscode": "TXN",
  "status": "Transaction Successful",
  "data": {
    "statements": {
      "records": [
        {
          "txnDate": "2022-03-18 17:40:30",
          "txnId": "S60778063",
          "amount": "104814.09",
          "type": "CR",
          "balance": "31311795.24",
          "narration1": "BC ACQ AEPS COMMISSION_170322"
        }
      ]
    }
  },
  "timestamp": "2022-03-21 18:46:52",
  "ipay_uuid": "h00595df6e53-5f93-4a95-b69c-2dcb52cb8c80",
  "environment": "LIVE"
}