Transactions
Last updated April 8th, 2024
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.
You can filter out your customers’ transactions based on a specific date range.
You can filter out specific transactions of customers 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 page by page, via setting the paginate query parameter to true and setting a number to the limit parameter.
Response Object
Request
{
"status": "successful",
"message": "Transaction retrieved successfully",
"timestamp": "2024-04-12T06:18:17.117Z",
"data": [
{
"id": "66141bbff58d2687e7d91234",
"narration": "PG00001",
"amount": 500,
"type": "debit",
"balance": 1500,
"date": "2023-12-14T00:02:00.500Z",
"category": "unknown"
},
{
"id": "66141bbff58d2687e7d91235",
"narration": "0000132312091322123456789012345 NIP TRANSFER",
"amount": 1000,
"type": "debit",
"balance": 2000,
"date": "2023-12-09T13:23:00.100Z",
"category": "bank_charges"
},
],
"meta": {
"total": 307,
"page": 1,
"previous": null,
"next": "https://api.withmono.com/v2/66141b98aaa34e17e8cfdb76/transactions?page=2"
}
}
Transactions Fields
| Field | Description | Type |
| status | This returns the status of API call made which could be 'successful' or 'failed'. | string |
| message | This field returns the API response message | string |
| data | This field returns an object with all the user's account data | object |
| data.paging | An object which contains important pagination data such as the total, the current page, the previous and the next page link. | object |
| data.paging.page | The current page of this transaction API. | number |
| data.paging.total | The total number of transactions tied to this account | number |
| data.paging.previous | The previous page of this transaction API. | string |
| data.paging.next | The next page of this transaction API. | object |
| data.transactions | This is an array of objects which contains every transaction data | array |
| data.transactions._id | ID tied to this particular transaction | string |
| data.transactions.amount | The monetary amount of the transaction in lowest denomination e.g Kobo (Nigeria), Pesewa (Ghana). | number |
| data.transactions.date | The date the transaction was created. | string |
| data.transactions.narration | This refers to the description or extra details that is attached to the said account. | string |
| data.transactions.type | This is type of financial transaction be it debit or credit. | string |
| data.transactions.category | The channel through which the transaction occured. | string |