Authorizations
Query Parameters
ISO 4217 currency code to convert to
Available options:
GBP
, USD
, EUR
Example:
"USD"
Filter by specific merchants
Example:
[
"mrc_jVjRPWMxqYc379pePc4nH4",
"mrc_5KkA62LZYpZ2CFEpmcqR3G"
]
Aggregate results over time, e.g., by week or by quarter
Available options:
day
, week
, month
, quarter
, year
Example:
"month"
Filter for transactions with timestamp after the input value (as date)
Example:
"2025-08-26"
Filter by specific categories
Example:
[
"ctg_SdUbo9ueQHU26KLSDJFR4L",
"ctg_QhuxyHvmNSP6Qhp73Azegu"
]
Pivot results by merchant or by category
Available options:
category
, merchant
Example:
"category"
Heron-generated id for end user; either end_user_id or end_user_heron_id is required
Example:
"eus_9RmWMqAEJevC7svCuQez3a"
end_user_id for statistics; either end_user_id or end_user_heron_id is required
Example:
"your_end_user_id"
Filter for transactions with timestamp before the input value (as date)
Example:
"2025-08-25"
Response
200 - application/json
OK
The response is of type object
.