Skip to main content
GET
/
api
/
end_users
/
{end_user_id_or_heron_id}
/
data_source_account_summary
Get data source account summary
curl --request GET \
  --url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/data_source_account_summary \
  --header 'x-api-key: <api-key>'
[
  {
    "data_source_account_summaries": [
      {
        "summary": {
          "actual_holdback_percentage": 123,
          "average_balance": {
            "amount": "1234.56",
            "currency": "USD"
          },
          "average_balance_to_revenue_ratio": 123,
          "dd_reversals": 123,
          "ending_balance": {
            "amount": "1234.56",
            "currency": "USD"
          },
          "expected_mca_debits": {
            "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_mca_credits": 123,
          "no_mca_debits": 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"
          }
        }
      }
    ]
  }
]

Authorizations

x-api-key
string
header
required

Path Parameters

end_user_id_or_heron_id
string
required

Response

200 - application/json

Ok

data_source_account_summaries
object[]
end_user
object