Transactions
A transaction 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": {
"total": 190,
"page": 2,
"previous": "https://api.withmono.com/accounts/:id/transactions?page=2",
"next": "https://api.withmono.com/accounts/:id/transactions?page=3",
},
"data": [
{
"_id": "62a05bc04112ea670bd09812",
"type": "debit",
"amount": 147085,
"narration": "VC POS Loc-215016609012--BOLA NURAT YUSUFF OY NG",
"date": "2022-05-30T16:03:00.000Z",
"balance": 1021841,
"currency": "NGN",
"category": "online_transactions"
},
{
"_id": "62a05bc04112ea670bd13465",
"type": "credit",
"amount": 300009,
"narration": "NIP/FCMB/DANIEL AFOLABI/App food o To Zenith Bank FUNKE OJO",
"date": "2022-05-30T15:44:00.000Z",
"balance": 1168926,
"currency": "NGN",
"category": "transfer"
}
]
}
Transaction 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 |
paging.total | The total number of transactions tied to this account | number |
paging.page | The current page of this transaction API. | number |
paging.previous | The previous page of this transaction API. | string |
paging.next | The next page of this transaction API. | object |
data | This is an array of objects which contains every transaction data | string |
data._id | ID tied to this particular transaction | string |
data.amount | The monetary amount of the transaction in lowest denomination e.g Kobo (Nigeria), Pesewa (Ghana). | number |
data.date | The date the transaction was created. | string |
data.narration | This refers to the description or extra details that is attached to the said account. | string |
data.type | This is type of financial transaction be it debit or credit. | string |
data.category | The channel through which the transaction occured. | string |
Updated 4 months ago