Transactions
A transaction in zeeh represents any instance in which money moves into or out of an account. This could be a purchase at a business, a payroll deposit, a transfer from one account to another, an ATM withdrawal, etc. Each transaction belongs to only one account.
Features:
You can filter out your customer's transactions based on specific date range.
You can filter out specific transactions of customer based on the narration. e.g Uber, airtime, salary, bank charges, POS etc
You can filter out only debit transactions or credit transactions.
You can receive your customer's data in a paginated form which you can display on your dashboard on the fly page by page, via setting the paginate query parameter to true and setting a number to the limit parameter.
This transactions endpoint provides the following object on success:
API Object​
{
"paging": null,
"totalPages": 492,
"curPage": 2,
"numberOfPages": 246,
"previousPageNumber": 1,
"nextPageNumber": 3,
},
"data": [
{
"type": "debit",
"amount": 53.75,
"narration": "Transfer Charges",
"date": "31/05/2021 11:38:20",
"closingBalance": 33425.57,
"tranId": "NIP-DCO-1833962182"
},
{
"type": "debit",
"amount": 33000,
"narration": "NIP CR/DOE OKAFOR NGOZI/GTB",
"date": "01/06/2021 18:00:01",
"closingBalance": 425.57,
"tranId": "NIP-DCO-1835532466"
}
]
}
Account Fields​
Field | Description | Type |
---|---|---|
paging | An object which contains important pagination data such as the total, the current page, the previous and the next page link. | object |
totalPages | The total number of transactions tied to this account | number |
curPage | The current page of this transaction API. | number |
numberOfPages | The number of pages of this transaction API. | number |
previousPageNumber | The previous page of this transaction API. | number |
nextPageNumber | The next page of this transaction API. | number |
data | This is an array of objects which contains every transaction data | string |
data.type | This is type of financial transaction be it debit or credit. | string |
data.amount | The monetary amount of the transaction. | number |
data.narration | This refers to the description or extra details that is attached to the said account. | string |
data.date | The date the transaction was created. | string |
data.closingBalance | The balance of the said accout after the transaction. | number |
data.tranId | ID tied to this particular transaction | string |