curl --request GET \
--url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/bank_statement_summary \
--header 'x-api-key: <api-key>'
{
"average": {
"average_balance": {
"amount": "1234.56",
"currency": "USD"
},
"average_balance_to_revenue_ratio": 123,
"dd_reversals": 123,
"ending_balance": {
"amount": "1234.56",
"currency": "USD"
},
"holdback_percentage": 123,
"low_balance_days": 123,
"mca_credits": {
"amount": "1234.56",
"currency": "USD"
},
"mca_debits": {
"amount": "1234.56",
"currency": "USD"
},
"negative_balance_days": 123,
"no_deposits": 123,
"no_od_nsf": 123,
"no_overdraft_transactions": 123,
"no_revenue": 123,
"no_withdrawals": 123,
"non_revenue": {
"amount": "1234.56",
"currency": "USD"
},
"starting_balance": {
"amount": "1234.56",
"currency": "USD"
},
"total_deposits": {
"amount": "1234.56",
"currency": "USD"
},
"total_revenue": {
"amount": "1234.56",
"currency": "USD"
},
"total_withdrawals": {
"amount": "1234.56",
"currency": "USD"
}
},
"by_data_source_account_heron_id": {},
"by_month": {},
"by_month_by_data_source_account_heron_id": {},
"grouping": "<string>",
"rolling_30_days_from_last_txn": {},
"rolling_30_days_from_today": {},
"total": {
"average_balance": {
"amount": "1234.56",
"currency": "USD"
},
"average_balance_to_revenue_ratio": 123,
"dd_reversals": 123,
"ending_balance": {
"amount": "1234.56",
"currency": "USD"
},
"holdback_percentage": 123,
"low_balance_days": 123,
"mca_credits": {
"amount": "1234.56",
"currency": "USD"
},
"mca_debits": {
"amount": "1234.56",
"currency": "USD"
},
"negative_balance_days": 123,
"no_deposits": 123,
"no_od_nsf": 123,
"no_overdraft_transactions": 123,
"no_revenue": 123,
"no_withdrawals": 123,
"non_revenue": {
"amount": "1234.56",
"currency": "USD"
},
"starting_balance": {
"amount": "1234.56",
"currency": "USD"
},
"total_deposits": {
"amount": "1234.56",
"currency": "USD"
},
"total_revenue": {
"amount": "1234.56",
"currency": "USD"
},
"total_withdrawals": {
"amount": "1234.56",
"currency": "USD"
}
}
}
Get the bank statement summary by month for an end user
curl --request GET \
--url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/bank_statement_summary \
--header 'x-api-key: <api-key>'
{
"average": {
"average_balance": {
"amount": "1234.56",
"currency": "USD"
},
"average_balance_to_revenue_ratio": 123,
"dd_reversals": 123,
"ending_balance": {
"amount": "1234.56",
"currency": "USD"
},
"holdback_percentage": 123,
"low_balance_days": 123,
"mca_credits": {
"amount": "1234.56",
"currency": "USD"
},
"mca_debits": {
"amount": "1234.56",
"currency": "USD"
},
"negative_balance_days": 123,
"no_deposits": 123,
"no_od_nsf": 123,
"no_overdraft_transactions": 123,
"no_revenue": 123,
"no_withdrawals": 123,
"non_revenue": {
"amount": "1234.56",
"currency": "USD"
},
"starting_balance": {
"amount": "1234.56",
"currency": "USD"
},
"total_deposits": {
"amount": "1234.56",
"currency": "USD"
},
"total_revenue": {
"amount": "1234.56",
"currency": "USD"
},
"total_withdrawals": {
"amount": "1234.56",
"currency": "USD"
}
},
"by_data_source_account_heron_id": {},
"by_month": {},
"by_month_by_data_source_account_heron_id": {},
"grouping": "<string>",
"rolling_30_days_from_last_txn": {},
"rolling_30_days_from_today": {},
"total": {
"average_balance": {
"amount": "1234.56",
"currency": "USD"
},
"average_balance_to_revenue_ratio": 123,
"dd_reversals": 123,
"ending_balance": {
"amount": "1234.56",
"currency": "USD"
},
"holdback_percentage": 123,
"low_balance_days": 123,
"mca_credits": {
"amount": "1234.56",
"currency": "USD"
},
"mca_debits": {
"amount": "1234.56",
"currency": "USD"
},
"negative_balance_days": 123,
"no_deposits": 123,
"no_od_nsf": 123,
"no_overdraft_transactions": 123,
"no_revenue": 123,
"no_withdrawals": 123,
"non_revenue": {
"amount": "1234.56",
"currency": "USD"
},
"starting_balance": {
"amount": "1234.56",
"currency": "USD"
},
"total_deposits": {
"amount": "1234.56",
"currency": "USD"
},
"total_revenue": {
"amount": "1234.56",
"currency": "USD"
},
"total_withdrawals": {
"amount": "1234.56",
"currency": "USD"
}
}
}
Determines how to group transactions. It supports calendar month (by_month) or rolling 30-day period (from last txns with rolling_30_days_from_last_txn or from today with rolling_30_days_from_today)
by_month
, by_data_source_account_heron_id
, rolling_30_days_from_last_txn
, rolling_30_days_from_today
, by_month_by_data_source_account_heron_id
Account ids to include in the summary, if not provided, all accounts are included
Number of full calendar months to show in the summary
x >= 1
OK
The response is of type object
.
Was this page helpful?