Authorizations
Query Parameters
Aggregate results over time, e.g., by week or by quarter
Available options:
day, week, month, quarter, year Example:
"month"
end_user_id for statistics; either end_user_id or end_user_heron_id is required
Example:
"your_end_user_id"
Filter by specific account reference IDs
Example:
["1234", "5678"]Filter for transactions with timestamp before the input value (as date)
Example:
"2025-10-21"
Filter by specific categories
Example:
[
"ctg_W5LuusLByeioYYPAXmC7Nq",
"ctg_YNScBihVnfXqdgzppVE8pH"
]Filter for transactions with timestamp after the input value (as date)
Example:
"2025-10-22"
Filter by specific merchants
Example:
[
"mrc_jdbYydhLZHcWuaS8v8UXkN",
"mrc_Lfhnj8vNe3JN8mHZeRXcjm"
]Heron-generated id for end user; either end_user_id or end_user_heron_id is required
Example:
"eus_9wK2Cs9mNSzowptGpB2aUB"
Pivot results by merchant or by category
Available options:
category, merchant Example:
"category"
ISO 4217 currency code to convert to
Available options:
GBP, USD, EUR Example:
"USD"
Response
200 - application/json
OK