The statement API facilitates the retrieval of a user's financial statement, offering a comprehensive overview of their transaction history. The response includes key details such as transaction type (credit/debit), amount, date, narration, and currency. This API empowers users by providing insights into their financial activities, enabling efficient tracking and analysis of transactions over time.

API Reference

API Object

  "status": "successful",
  "message": "Successfully fetched statement",
  "data": {
    "count": 578,
    "requested_length": null,
    "available_length": 328,
    "statement": [
        "id": "652045cd9d3a9e048485b81b",
        "type": "credit",
        "amount": 6500,
        "balance": null,
        "date": "2023-10-06T17:33:56.000Z",
        "narration": "KIP:WEMA/SAMUEL OLAMIDE/KUDA-",
        "currency": "NGN"

Statements 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 statement data object
data.count The total number of transactions tied to this account number
data.requested_length The total number of transactions requested with respect to the period passed in the query parameter. Please note that the returned value is in days. number
data.available_length The total number of transactions available on this connected account. Please note that the returned value is in days. number
data.statement This is an array of objects which contains every transaction data string ID tied to this particular transaction string
data.statement.amount The monetary amount of the transaction in lowest denomination e.g Kobo (Nigeria), Pesewa (Ghana). number The date the transaction was created. string
data.statement.narration This refers to the description or extra details that is attached to the said account. string
data.statement.type This is type of financial transaction be it debit or credit. string
data.statement.category The channel through which the transaction occured. string