Get apitransactions

GET

api

transactions

{reference_id_or_heron_id}

curl --request GET \
  --url https://app.herondata.io/api/transactions/{reference_id_or_heron_id} \
  --header 'Authorization: Basic <encoded-value>'

{
  "transaction_enriched": {
    "account_id": "checking_account_202348",
    "amount": -42.42,
    "annotation": {
      "annotator": {
        "context": "sync",
        "priority_type": "gold_standard"
      },
      "category": {
        "heron_id": "ctg_UibgXehM5QySQZsop8hBjd",
        "label": "Rent"
      },
      "confidence": 123,
      "model_version": "<string>"
    },
    "balance": 423,
    "currency": "USD",
    "description": "GOOGLE *ADS12340929 [email protected] US",
    "end_user_id": "my_best_customer_203948",
    "features": {
      "description_clean": "GOOGLE ADS",
      "duplicate_of_id": "<any>",
      "has_matching_transaction": true,
      "is_potential_duplicate": true,
      "is_recurring": true
    },
    "heron_id": "txn_J8wF9EogEyTSdbbpdXoGLs",
    "last_updated": "2025-04-15T17:04:43.806042",
    "merchant": {
      "categories": [
        {
          "code": "7311",
          "description": "Advertising services",
          "slug": "advertising_services"
        }
      ],
      "group_id": "Uber",
      "heron_id": "mrc_ifF8pnLaH9W4i4ANqaF4z3",
      "icon_url": "<string>",
      "is_priority": true,
      "logo_url": "<string>",
      "name": "<string>",
      "url": "<string>"
    },
    "reference_id": "my_favourite_transaction_231098",
    "request_id": "req_nUKcqx7njuoVjKvghbF9je",
    "timestamp": "2021-11-12T10:38:05Z",
    "transaction_code": "card"
  }
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

reference_id_or_heron_id

string

required

Response

200

application/json

transaction_enriched

object

transaction_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

transaction_enriched.description

string

required

The text description for the transaction

Example:

"GOOGLE *ADS12340929 [email protected] US"

transaction_enriched.account_id

string | null

Your unique ID for account associated with transaction

Maximum length: 400

Example:

"checking_account_202348"

transaction_enriched.annotation

object

The category annotation associated with the transaction

transaction_enriched.balance

number | null

The running balance of the account after transaction ocurred

Example:

423

transaction_enriched.currency

string | null

ISO 4217 currency code

Required string length: 3

Example:

"USD"

transaction_enriched.end_user_id

string | null

Your unique ID for end user associated with transaction

Maximum length: 140

Example:

"my_best_customer_203948"

transaction_enriched.features

object

Features calculated from transaction

transaction_enriched.heron_id

string

Unique ID of transaction; generated by Heron Data

Example:

"txn_J8wF9EogEyTSdbbpdXoGLs"

transaction_enriched.last_updated

string

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

Example:

"2025-04-15T17:04:43.806042"

transaction_enriched.merchant

object

The merchant associated with the transaction

transaction_enriched.reference_id

string | null

Your unique ID for transaction

Maximum length: 140

Example:

"my_favourite_transaction_231098"

transaction_enriched.request_id

string | null

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

Example:

"req_nUKcqx7njuoVjKvghbF9je"

transaction_enriched.timestamp

string | null

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

Example:

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

transaction_enriched.transaction_code

string | null

Code associated with transaction to indicate the type of transaction

Maximum length: 140

Example:

"card"

Was this page helpful?

Get end user transactions Create end user transactions (async)

curl --request GET \
  --url https://app.herondata.io/api/transactions/{reference_id_or_heron_id} \
  --header 'Authorization: Basic <encoded-value>'

{
  "transaction_enriched": {
    "account_id": "checking_account_202348",
    "amount": -42.42,
    "annotation": {
      "annotator": {
        "context": "sync",
        "priority_type": "gold_standard"
      },
      "category": {
        "heron_id": "ctg_UibgXehM5QySQZsop8hBjd",
        "label": "Rent"
      },
      "confidence": 123,
      "model_version": "<string>"
    },
    "balance": 423,
    "currency": "USD",
    "description": "GOOGLE *ADS12340929 [email protected] US",
    "end_user_id": "my_best_customer_203948",
    "features": {
      "description_clean": "GOOGLE ADS",
      "duplicate_of_id": "<any>",
      "has_matching_transaction": true,
      "is_potential_duplicate": true,
      "is_recurring": true
    },
    "heron_id": "txn_J8wF9EogEyTSdbbpdXoGLs",
    "last_updated": "2025-04-15T17:04:43.806042",
    "merchant": {
      "categories": [
        {
          "code": "7311",
          "description": "Advertising services",
          "slug": "advertising_services"
        }
      ],
      "group_id": "Uber",
      "heron_id": "mrc_ifF8pnLaH9W4i4ANqaF4z3",
      "icon_url": "<string>",
      "is_priority": true,
      "logo_url": "<string>",
      "name": "<string>",
      "url": "<string>"
    },
    "reference_id": "my_favourite_transaction_231098",
    "request_id": "req_nUKcqx7njuoVjKvghbF9je",
    "timestamp": "2021-11-12T10:38:05Z",
    "transaction_code": "card"
  }
}

API Reference

Categories

CrmIntegrations

EndUserDataSourceAccounts

EndUserDataSources

EmailTemplates

EndUsers

EndUserEmails

EndUserEnricherFields

EndUserEntity

EndUserFiles

FileClass

EndUserCalculations

EndUserAttributes

EnrichmentFeedback

EndUserFinancials

EndUserRules

Integrations

EndUserIntegrations

ISOApplication

EndUserAccounts

EnrichedTransactions

Transactions

Policy

Testing

Merchants

Rules

ParsedEndUserSubmission

Users

Webhooks

Get apitransactions

Authorizations

Path Parameters

Response