Statements
Last updated May 19th, 2022
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.
Response Object
Request
1234567891011121314151617181920212223242526
{
"status": "successful",
"message": "Transactions retrieved successfully",
"timestamp": "2024-05-07T13:23:27.123Z",
"data": [
{
"id": "66321893cd7b216069425e55",
"type": "debit",
"amount": 14,
"narration": "0235416643:WTax.Pd:01-04-2024to 30-04-2024",
"balance": null,
"date": "2024-04-30T00:00:00.000Z"
},
{
"id": "66321893cd7b216069425e72",
"type": "credit",
"amount": 500000,
"narration": "NIP:SAMUEL OLAMIDE-Subscription",
"balance": null,
"date": "2024-01-07T00:00:00.000Z"
}
],
"meta": {
"count": 31
}
}
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 | array |
| data.statement.id | 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 |
| data.date | 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 |