Telco Transactions

This resource is to get all telco-related account transactions such as the transaction id, type, narration, balance after the date/time of the transaction and the currency.

API Reference

API Object

Features:

  • You can filter out your customer's transactions based on a specific date range.
  • You can filter out specific transactions of a customer based on the narration. e.g VTU, Monthly plan 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 telco transactions endpoint provides the following object on success:

API Object

{
  "paging": {
    "total": 25,
    "page": 1,
    "previous": null,
    "next": "https://api.withmono.com/accounts/62f15763982abb0d25e1fefd/transactions?page=2"
  },
  "data": [
    {
      "_id": "62f15769982abb0d25e1ff8b",
      "type": "debit",
      "amount": 500000,
      "narration": "20GB Monthly Plan",
      "balance": 7659,
      "date": "2022-07-26T16:20:37.000Z",
      "currency": "NGN"
    },
    {
      "_id": "62f15769982abb0d25e1ff8c",
      "type": "credit",
      "amount": 500000,
      "narration": "VTU",
      "balance": 507660,
      "date": "2022-07-26T16:16:17.000Z",
      "currency": "NGN"
    },
    {
      "_id": "62f15769982abb0d25e1ff8d",
      "type": "debit",
      "amount": 150000,
      "narration": "6GB Weekly Plan",
      "balance": 7659,
      "date": "2022-07-24T18:47:44.000Z",
      "currency": "NGN"
    }
  ]
}

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

Did this page help you?