Get end user transactions

curl --request GET \
  --url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/transactions \
  --header 'x-api-key: <api-key>'

{
  "_meta": {
    "next_url": "<string>",
    "num_results": 123,
    "page": 123,
    "per_page": 123,
    "prev_url": "<string>"
  },
  "transactions_enriched": [
    {
      "amount": -42.42,
      "description": "GOOGLE *ADS12340929 [email protected] US",
      "account_id": "checking_account_202348",
      "account_number": "1234567890",
      "annotation": {
        "annotator": {
          "context": "sync",
          "priority_type": "gold_standard"
        },
        "category": {
          "label": "Rent",
          "heron_id": "ctg_NxuE6DEaPGMXCjZrZ2vyXo"
        },
        "confidence": 123,
        "model_version": "<string>"
      },
      "balance": 423,
      "counterparty": "GOOGLE",
      "currency": "USD",
      "data_source_account_heron_id": "dsa_RAqgeYTWkKYfUGfyFZy9PN",
      "data_source_heron_id": "dso_KgadxHdrTGtYda4tjgHvCH",
      "end_user_id": "my_best_customer_203948",
      "features": {
        "description_clean": "GOOGLE ADS",
        "duplicate_of_id": "txn_7p9fVaHJToygHX8ps4sY59",
        "has_matching_transaction": true,
        "is_potential_duplicate": true,
        "is_recurring": true
      },
      "heron_id": "txn_8pAXmBn9PTWq9Cx5JXVp5q",
      "last_updated": "2025-12-12T10:00:51.477810",
      "merchant": {
        "name": "<string>",
        "url": "<string>",
        "categories": [
          {
            "code": "7311",
            "description": "Advertising services",
            "slug": "advertising_services"
          }
        ],
        "group_id": "Uber",
        "heron_id": "mrc_MQ6m783Jf7Ewj7nk5KyJYy",
        "icon_url": "<string>",
        "is_priority": true,
        "logo_url": "<string>"
      },
      "reference_id": "my_favourite_transaction_231098",
      "request_id": "req_WtcsBmM8XDkf9HktbwRZDg",
      "timestamp": "2021-11-12T10:38:05Z",
      "transaction_code": "card"
    }
  ]
}

GET

api

end_users

{end_user_id_or_heron_id}

transactions

Get end user transactions

curl --request GET \
  --url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/transactions \
  --header 'x-api-key: <api-key>'

{
  "_meta": {
    "next_url": "<string>",
    "num_results": 123,
    "page": 123,
    "per_page": 123,
    "prev_url": "<string>"
  },
  "transactions_enriched": [
    {
      "amount": -42.42,
      "description": "GOOGLE *ADS12340929 [email protected] US",
      "account_id": "checking_account_202348",
      "account_number": "1234567890",
      "annotation": {
        "annotator": {
          "context": "sync",
          "priority_type": "gold_standard"
        },
        "category": {
          "label": "Rent",
          "heron_id": "ctg_NxuE6DEaPGMXCjZrZ2vyXo"
        },
        "confidence": 123,
        "model_version": "<string>"
      },
      "balance": 423,
      "counterparty": "GOOGLE",
      "currency": "USD",
      "data_source_account_heron_id": "dsa_RAqgeYTWkKYfUGfyFZy9PN",
      "data_source_heron_id": "dso_KgadxHdrTGtYda4tjgHvCH",
      "end_user_id": "my_best_customer_203948",
      "features": {
        "description_clean": "GOOGLE ADS",
        "duplicate_of_id": "txn_7p9fVaHJToygHX8ps4sY59",
        "has_matching_transaction": true,
        "is_potential_duplicate": true,
        "is_recurring": true
      },
      "heron_id": "txn_8pAXmBn9PTWq9Cx5JXVp5q",
      "last_updated": "2025-12-12T10:00:51.477810",
      "merchant": {
        "name": "<string>",
        "url": "<string>",
        "categories": [
          {
            "code": "7311",
            "description": "Advertising services",
            "slug": "advertising_services"
          }
        ],
        "group_id": "Uber",
        "heron_id": "mrc_MQ6m783Jf7Ewj7nk5KyJYy",
        "icon_url": "<string>",
        "is_priority": true,
        "logo_url": "<string>"
      },
      "reference_id": "my_favourite_transaction_231098",
      "request_id": "req_WtcsBmM8XDkf9HktbwRZDg",
      "timestamp": "2021-11-12T10:38:05Z",
      "transaction_code": "card"
    }
  ]
}

Authorizations

x-api-key

string

header

required

Path Parameters

end_user_id_or_heron_id

string

required

Query Parameters

category_heron_id

string[] | null

Filter by the heron_id of the category that the transaction is annotated with

Example:

"ctg_bZ3444BQF4f9yssbjcuf2C"

account_ids

string[] | null

Account ids to include. If not provided, all accounts are included

last_updated_min

string<date-time> | null

Filter for transactions whose values were last updated in Heron systems after the specified input value, isoformat

Example:

"2025-12-12T10:00:53.624625"

page

integer

default:1

Results page

Required range: x >= 1

per_page

integer

default:100

Desired results per page

Required range: 1 <= x <= 50000

order_by

enum<string>

default:id_asc

What to order transactions by

Available options:

amount_asc,

amount_desc,

abs_amount_asc,

abs_amount_desc,

description_asc,

description_desc,

timestamp_asc,

timestamp_desc,

id_asc,

id_desc,

confidence_asc,

confidence_desc,

created_asc,

created_desc

Response

200 - application/json

_meta

object

Show child attributes

_meta.next_url

string<url> | null

the URL of the next page

_meta.num_results

integer

the number of results returned

_meta.page

integer

current page

_meta.per_page

integer

the max number of results per page

_meta.prev_url

string<url> | null

the URL of the last page

transactions_enriched

object[]

Show child attributes

transactions_enriched.amount

number

required

Amount. Inflows to an account should be positive, and outflows from an account should be negative. If using Plaid, please flip the amount sign for all transactions.

Example:

-42.42

transactions_enriched.description

string

required

The text description for the transaction

Example:

"GOOGLE *ADS12340929 [email protected] US"

transactions_enriched.account_id

string | null

Your unique ID for account associated with transaction

Maximum string length: 400

Example:

"checking_account_202348"

transactions_enriched.account_number

string | null

The account number of the data source account associated with the transaction

Example:

"1234567890"

transactions_enriched.annotation

object

The category annotation associated with the transaction

Show child attributes

transactions_enriched.annotation.annotator

object

Show child attributes

transactions_enriched.annotation.annotator.context

enum<string>

required

Available options:

sync,

async_,

manual,

undetermined

transactions_enriched.annotation.annotator.priority_type

enum<string>

required

Available options:

gold_standard,

client_feedback,

tagging_ui,

reconcile,

heuristic,

classifier,

undetermined,

positions_detection

transactions_enriched.annotation.category

object

Show child attributes

transactions_enriched.annotation.category.label

string

required

The label of the category

Example:

"Rent"

transactions_enriched.annotation.category.heron_id

string

Unique ID of the category generated by Heron Data

Example:

"ctg_NxuE6DEaPGMXCjZrZ2vyXo"

transactions_enriched.annotation.confidence

number

transactions_enriched.annotation.model_version

string

transactions_enriched.balance

number | null

The running balance of the account after transaction ocurred

Example:

423

transactions_enriched.counterparty

string | null

The counterparty associated with the transaction, if available

Example:

"GOOGLE"

transactions_enriched.currency

string | null

ISO 4217 currency code

Required string length: 3

Example:

"USD"

transactions_enriched.data_source_account_heron_id

string | null

The heron ID of the data source account associated with the transaction

Example:

"dsa_RAqgeYTWkKYfUGfyFZy9PN"

transactions_enriched.data_source_heron_id

string | null

The heron ID of the data source associated with the transaction

Example:

"dso_KgadxHdrTGtYda4tjgHvCH"

transactions_enriched.end_user_id

string | null

Your unique ID for end user associated with transaction

Maximum string length: 140

Example:

"my_best_customer_203948"

transactions_enriched.features

object

Features calculated from transaction

Show child attributes

transactions_enriched.features.description_clean

string

The cleaned description of the transaction

Example:

"GOOGLE ADS"

transactions_enriched.features.duplicate_of_id

any

Indicates that the transaction is a duplicate and gives the heron_id of the original

Example:

"txn_7p9fVaHJToygHX8ps4sY59"

transactions_enriched.features.has_matching_transaction

boolean

Whether the transaction is a transfer; requires end_user_id and timestamp to be present

transactions_enriched.features.is_potential_duplicate

boolean

Indicates whether the transaction has another transaction similar to it

transactions_enriched.features.is_recurring

boolean

Whether the transaction is recurring or not; requires end_user_id and timestamp to be present

transactions_enriched.heron_id

string

Unique ID of transaction; generated by Heron Data

Example:

"txn_8pAXmBn9PTWq9Cx5JXVp5q"

transactions_enriched.last_updated

string<date-time>

When the transaction was last updated, either by updating its enrichments or the values of the transaction itself

Example:

"2025-12-12T10:00:51.477810"

transactions_enriched.merchant

object

The merchant associated with the transaction

Show child attributes

transactions_enriched.merchant.name

string

required

transactions_enriched.merchant.url

string<url>

required

transactions_enriched.merchant.categories

object[]

Show child attributes

transactions_enriched.merchant.categories.code

string

required

Example:

"7311"

transactions_enriched.merchant.categories.description

string | null

Example:

"Advertising services"

transactions_enriched.merchant.categories.slug

string | null

Example:

"advertising_services"

transactions_enriched.merchant.group_id

enum<string> | null

Available options:

Uber,

Google,

Intuit,

debt.mca_or_rbf,

debt.non_bank_business,

debt.equipment_and_auto_leasing,

debt.mortgage,

debt.personal_non_mortgage,

debt.collections,

debt.bank,

invoice_factoring,

transactions_enriched.merchant.heron_id

string

Example:

"mrc_MQ6m783Jf7Ewj7nk5KyJYy"

transactions_enriched.merchant.icon_url

string<url> | null

transactions_enriched.merchant.is_priority

boolean

transactions_enriched.merchant.logo_url

string<url> | null

transactions_enriched.reference_id

string | null

Your unique ID for transaction

Maximum string length: 140

Example:

"my_favourite_transaction_231098"

transactions_enriched.request_id

string | null

ID associated with request, e.g., all transactions in same POST request will have same request_id

Example:

"req_WtcsBmM8XDkf9HktbwRZDg"

transactions_enriched.timestamp

string<date-time> | null

The ISO 8601 timezone aware timestamp of the transaction; takes precedence over 'date'

Example:

"2021-11-12T10:38:05Z"

transactions_enriched.transaction_code

string | null

Code associated with transaction to indicate the type of transaction

Maximum string length: 140

Example:

"card"

Get transactions for a specific position Get apitransactions

⌘I

API Reference

AppStore

API Reference

Categories

Credentials

CrmIntegrations

EndUserDataSourceAccounts

EndUserDataSources

EmailTemplates

EndUsers

EndUserEmails

EndUserEnrichers

EndUserEntity

EndUserFiles

FileClass

EndUserCalculations

EndUserAttributes

EnrichmentFeedback

EndUserFinancials

EndUserIntegrations

EndUserRules

Integrations

ISOApplication

EndUserAccounts

Policy

Positions

EnrichedTransactions

Transactions

Funders

Testing

Merchants

Rules

ParsedEndUserSubmission

UserMerchantGroups

Users

Watermarks

Webhooks

Workflows

Authorizations

Path Parameters

Query Parameters

Response