Skip to main content

Transactions Statement API

As a PostaPay merchant, you have the ability to fetch your transactions statement directly from our API. To fetch your statement, you need to make a GET call to the following url with your merchant_code as the query parameter.

info

You will only be able to fetch transactions statement in the Production Environment.

Alt test Endpoint: https://sandbox.postapay.app/api/v1/transactions/?merchant_code=1234

Query Parameters​

FieldTypeDescriptionExample
merchant_codeNumberA unique number assigned to an organization/merchant registered with ViewTech, through which payment is received (can be Paybill or Till number)1234
start_datestringThis is the date from which you want to filter transactions.Note that this must be submitted together with end date parameter2023-10-23
end_datestringThis is the date to which you want to filter transactions. Note that this must be submitted together with start date parameter2023-10-28
transaction_codestringYou can provide the transaction code as part of the query parameters to fetch the transactionQHJSDJKL4
Example full query parameters​
https://sandbox.postapay.app/api/v1/transactions/?merchant_code=1234&start_date=2023-10-23&end_date=2023-10-28&transaction_code=QHJSDJKL4&page=1&page_size=2

sample request
Headers
    Key: Authorization
    Value: Bearer cFJZcjZ6anEwaThM6UmYyMkJmWm9nMHFRR2xWOQ==

Response Parameters​

sample response
{
   "status":true,
   "message":"Transactions List",
   "detail":"List of transactions",
   "links":{
      "next":"https://sandbox.postapay.app/api/v1/transactions/?merchant_code=1234&page=1&page_size=2",
      "previous":null
   },
   "count":137,
   "current_page":1,
   "pages":69,
   "data":{
      "transactions":[
         {
            "id":1234,
            "merchant_code":"60****1",
            "transaction_amount":500.0,
            "transaction_charges":0.0,
            "transaction_type":"TRANSACTION IN",
            "transaction_code":"SPEJ*****Q7V2PD",
            "transaction_description":"14-600**1-07*****77",
            "transaction_reference":"DEP/14-600**1-07*****77",
            "transaction_date":"2023-08-02",
            "payment_details":{
               "party_B_account_number":"07*******7",
               "party_B_account_name":null,
               "channel_name":"AIRTEL MONEY",
               "channel_transaction_reference":null
            },
            "result_code":"SP00000",
            "result_description":"Transaction completed successfully",
            "reversal_status":"NOT REVERSED",
            "created_date":"2023-08-02T10:11:36+03:00"
         },
         {
            "id":1235,
            "merchant_code":"1234",
            "transaction_amount":100.0,
            "transaction_charges":0.0,
            "transaction_type":"TRANSACTION IN",
            "transaction_code":"SPE****9DIVZ",
            "transaction_description":"FT2*****D8RW4",
            "transaction_reference":"DEP/FT****RW4",
            "transaction_date":"2023-08-02",
            "payment_details":{
               "party_B_account_number":"KCB-DF****JK",
               "party_B_account_name":null,
               "channel_name":"KCB",
               "channel_transaction_reference":null
            },
            "result_code":"SP00000",
            "result_description":"Transaction completed successfully",
            "reversal_status":"NOT REVERSED",
            "created_date":"2023-08-02T10:10:18+03:00"
         }
      ]
   }
}