Sign in

v1

latestOpenAPI 3.0.02026-07-26224386470.0 KB
EndUserCalculations

Get EndUser recurring transactions report

Get a report of recurring transactions grouped by merchant or counterparty for an end user

get/api/end_users/{end_user_id_or_heron_id}/recurring_transactions_report

Path parameters

end_user_id_or_heron_idstring required

Query parameters

account_idsstring[] nullable

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

[
  "1234"
]

Response

OK

avg_confidencenumber
counterpartystring
frequency'not_enough_data' | 'same_day' | 'irregular' | 'daily' | 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'annually' | 'weekday' | 'twice_weekly'
merchant_group_idstring
merchant_heron_idstring
merchant_namestring

Example response

[
  {
    "avg_amount": {
      "currency": "USD"
    },
    "transactions": [
      {
        "amount": {
          "currency": "USD"
        }
      }
    ]
  }
]