Sign in

v1

latestOpenAPI 3.0.02026-07-26224386470.0 KB
EndUserCalculations

Get EndUser merchant summary

Get the summary of transactions by merchant for an end user for given categories or analytics groups

get/api/end_users/{end_user_id_or_heron_id}/merchant_summary

Path parameters

end_user_id_or_heron_idstring required

Query parameters

category_label_or_heron_idstring[] nullable
analytics_groupstring[] nullable
[
  "debt"
]
group_by_counterparty_txn_clustersboolean

Whether to group by counterparty transaction clusters

account_idsstring[] nullable

Account ids to include in the summary, if not provided, all accounts are included

[
  "1234"
]

Response

OK

Example response

{
  "by_merchant_summary": [
    {
      "inflow_metrics": {
        "amount": {
          "currency": "USD"
        },
        "estimated_monthly_amount": {
          "currency": "USD"
        },
        "max_amount": {
          "currency": "USD"
        },
        "mean_amount": {
          "currency": "USD"
        },
        "median_amount": {
          "currency": "USD"
        },
        "min_amount": {
          "currency": "USD"
        },
        "mode_amount": {
          "currency": "USD"
        },
        "std_dev_amount": {
          "currency": "USD"
        }
      },
      "net_metrics": {
        "amount": {
          "currency": "USD"
        },
        "estimated_monthly_amount": {
          "currency": "USD"
        },
        "max_amount": {
          "currency": "USD"
        },
        "mean_amount": {
          "currency": "USD"
        },
        "median_amount": {
          "currency": "USD"
        },
        "min_amount": {
          "currency": "USD"
        },
        "mode_amount": {
          "currency": "USD"
        },
        "std_dev_amount": {
          "currency": "USD"
        }
      },
      "outflow_metrics": {
        "amount": {
          "currency": "USD"
        },
        "estimated_monthly_amount": {
          "currency": "USD"
        },
        "max_amount": {
          "currency": "USD"
        },
        "mean_amount": {
          "currency": "USD"
        },
        "median_amount": {
          "currency": "USD"
        },
        "min_amount": {
          "currency": "USD"
        },
        "mode_amount": {
          "currency": "USD"
        },
        "std_dev_amount": {
          "currency": "USD"
        }
      },
      "transactions": [
        {
          "amount": {
            "currency": "USD"
          }
        }
      ]
    }
  ]
}