This API furnishes the data on monthly basics and helps you get the Beginning balance, Ending balance, Daily balance, Average balance, Income source, and expenses destination.
{
"status":200,
"data":{
"message":"We are able to fetch data",
"method":"GET",
"api":"/v2/data/transaction-balance-summary”,
"job_id": "KVWJUrwQ78333309",
"count":{{"number of objects in summary"}}
"summary":[
{
"institution_id":2,
"account_id":"q4Iudadsa0Aszlu1qB0q2MQ==",
"beginning_balance":50000.0,
"avg_balance":1520000.0,
"ending_balance":4482873.0,
"month":"4",
"year":"2021",
"monthly_total_income":{
"total_income":999999,
"credit_transaction":12
},
"monthly_total_expense":{
"total_expense":33333,
"debit_transaction":23
},
"daily_balance":[
{
"date":"2021-03-31",
"balance":50000.0
},
{
"date":"2021-04-04",
"balance":1520000.0
},
{
"date":"2021-04-05",
"balance":1385128.0
},
{
"date":"2021-04-06",
"balance":148128.0
},
{
"date":"2021-04-07",
"balance":168128.0
},
{
"date":"2021-04-08",
"balance":349405.0
},
{
"date":"2021-04-11",
"balance":270467.0
},
{
"date":"2021-04-14",
"balance":63467.0
},
{
"date":"2021-04-15",
"balance":48467.0
},
{
"date":"2021-04-18",
"balance":28467.0
},
{
"date":"2021-04-20",
"balance":621533.0
},
{
"date":"2021-04-21",
"balance":771612.0
},
{
"date":"2021-04-22",
"balance":4482873.0
},
{
"date":"2021-04-25",
"balance":3647073.0
},
{
"date":"2021-04-26",
"balance":5124073.0
},
{
"date":"2021-04-27",
"balance":2012461.0
}
],
"minimum_daily_balance":0.0,
"maximum_daily_balance":99999.0,
"top_income":[
{
"source":"Brick",
"frequency":1,
"total_amount":2.0335035E7
},
{
"source":"John Doe",
"frequency":8,
"total_amount":5988000.0
},
{
"source":"Doe John",
"frequency":4,
"total_amount":2007000.0
}
],
"top_expense":[
{
"source":"Doe John",
"frequency":5,
"total_amount":2.8855559E7
},
{
"source":"Brick",
"frequency":16,
"total_amount":7565000.0
},
{
"source":"John Doe",
"frequency":1,
"total_amount":3000000.0
}
]
}
]
},
"metadata":{
"entity":"Insight",
"source":{{API/Widget/Dashboard/SDK/Portal}}
},
"error":null
}
Response Parameters
| Key Parameters | Data Type | Description |
|---|---|---|
| summary-institution_id | Integer | Institution identification number |
| summary-account_id | String | Account Identification number from end-user's financial account |
| summary-beginning_balance | Float | Balance on the first day of each month |
| summary-avg_balance | Float | Balance at the end of each day and divides it by the number of calendar days |
| summary-ending_balance | Float | Balance on the last day of each month |
| summary-month | String | Return Historical Balance based on this month |
| summary-year | String | Returns Historical Balance based on this year |
| summary-monthly_total_income-total_income | Float | Total amount of money received in one month |
| summary-monthly_total_income-credit_transaction | Float | Total inbound transaction in one month |
| summary-monthly_total_expense-total_expense | Float | Total amount of money sent in one month |
| summary-monthly_total_expense-debit_transaction | Float | otal outbound transaction in one month |
| summary-daily_balance-date | Date(DD-MM-YYYY) | Date for daily transactions |
| summary-daily_balance-balance | Float | Daily balances |
| summary-minimum_daily_balance | Float | Minimum balance for any day |
| summary-maximum_daily_balance | Float | Maximum balance for any day |
| summary-top_income-source | String | Source of income received by the user |
| summary-top_income-frequency | Float | Total inbound transaction received by the user from the particular source |
| summary-top_income-total_amount | Float | Total amount of money received by the user from the particular source |
| summary-top_expense-source | String | Destination of outbound transaction done by the user |
| summary-top_expense-frequency | Float | Total outbound transaction done by the user to the particular source |
| summary-top_expense-total_amount | Float | Total amount of money sent by the user to the particular source |