Get apitransactions

GET

api

transactions

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

{
  "_meta": {
    "next_url": "<string>",
    "page": 123,
    "pages": 123,
    "per_page": 123,
    "prev_url": "<string>"
  },
  "_summary": {
    "returned_transactions": 123,
    "transactions": 123
  },
  "transactions": [
    {
      "account_id": "checking_account_202348",
      "account_number": "1234567890",
      "amount": -42.42,
      "balance": 423,
      "categories": [
        {
          "annotator": "predicted",
          "confidence": 0.5,
          "heron_id": "ctg_CBybVA3tB6xcpzy8SKNinM",
          "label": "Rent",
          "model_version": "6f4d5ffa-4f92-4582-b9be-1fe295b2122f"
        }
      ],
      "created": "2025-03-04T17:08:55.149206",
      "currency": "USD",
      "data_source_account_heron_id": "dsa_Br6ZoQnio66hdfYiaTbdqQ",
      "data_source_heron_id": "dso_6Cv42nMiRKxEbLfisXprFC",
      "description": "GOOGLE *ADS12340929 [email protected] US",
      "description_clean": "GOOGLE ADS",
      "duplicate_of_id": "<any>",
      "end_user_id": "my_best_customer_203948",
      "has_matching_transaction": true,
      "heron_id": "txn_KjPQKaF6BdpSpR6ewTPXNE",
      "is_potential_duplicate": true,
      "is_recurring": true,
      "last_updated": "2025-03-04T17:08:55.149225",
      "merchant": {
        "categories": [
          {
            "code": "7311",
            "description": "Advertising services",
            "slug": "advertising_services"
          }
        ],
        "group_id": "Uber",
        "heron_id": "mrc_H4woHtq2y7hw3GLRh4hv62",
        "icon_url": "<string>",
        "is_priority": true,
        "logo_url": "<string>",
        "name": "<string>",
        "url": "<string>"
      },
      "payment_processor": {
        "heron_id": "mrc_nRYdGU7nYuevb7qem65cEb",
        "icon_url": "https://storage.googleapis.com/heron-merchant-assets/icons/mrc_nRYdGU7nYuevb7qem65cEb.svg",
        "logo_url": "https://storage.googleapis.com/heron-merchant-assets/logos/mrc_nRYdGU7nYuevb7qem65cEb.svg",
        "name": "Paypal",
        "url": "https://www.paypal.com"
      },
      "reference_id": "my_favourite_transaction_231098",
      "request_id": "req_gwxinWjDsZDbsLkoJFCQ7n",
      "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.

Query Parameters

has_merchant

boolean | null

Filter by whether the transaction has a merchant entity associated with it

limit

integer

default:1000

Number of transactions to return per page

Required range: 1 <= x <= 10000

timestamp_date_max

string

Filter by latest transaction timestamp

Example:

"2020-04-27"

last_updated_max

string

Filter for transactions whose values were last updated in Heron systems before the specified input value

Example:

"2025-03-04T17:08:55.149609"

heron_id

string

Heron generated Id of transaction

Example:

"txn_aE5iYstkqdTXpWw7KkHiNp"

merchant_heron_id

string

Filter by merchant heron id

include_duplicates

boolean

Whether or not to include duplicate transactions in the response. Defaults to false unless request_id is provided, in which case it defaults to true.

end_user_id

string

End user id of transaction

confidence_min

number

Filter by minimum confidence of annotation associated with transaction

Required range: 0 <= x <= 1

from_date

string

Deprecated; see created_date_ or timestamp_date_

description_keyword

string

Filter by keyword match on transaction description; case insensitive

min_amount

number

Filter by minimum amount of transaction

account_ids

string[] | null

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

confidence_max

number

Filter by maximum confidence of annotation associated with transaction

Required range: 0 <= x <= 1

request_id

string

Request-Id header returned in the response of POST transactions. Sending this parameter will return all transactions sent in a particular POST request, including any duplicates.

merchant_group_id

string

Filter by merchant group id

category_heron_id

string[] | null

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

Example:

"ctg_eXEmnRNEdY6s9KntYcA9iE"

transaction_code

string

Filter by transaction code

created_date_max

string

Filter by latest transaction upload date - when Heron received the transaction

Example:

"2020-04-27"

is_recurring

boolean

Filter by whether the transaction is recurring

has_matching_transaction

boolean

Filter by whether the transaction has a matching transaction

last_updated_min

string

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

Example:

"2025-03-04T17:08:55.149534"

reference_id

string

Reference Id of transaction

created_date_min

string

Filter by earliest transaction upload date - when Heron received the transaction

Example:

"2020-04-27"

timestamp_date_min

string

Filter by earliest transaction timestamp

Example:

"2020-04-27"

description_regex

string

Filter by regex matching transaction description

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

max_amount

number

Filter by maximum amount of transaction

page

integer

default:1

Page of transaction to return

Required range: x >= 1

to_date

string

Deprecated; see created_date_ or timestamp_date_

Response

200

application/json

_meta

object

_summary

object

transactions

object[]

transactions.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.description

string

required

The text description for the transaction

Example:

"GOOGLE *ADS12340929 [email protected] US"

transactions.account_id

string | null

Your unique ID for account associated with transaction

Maximum length: 400

Example:

"checking_account_202348"

transactions.account_number

string

The account number associated with the transaction

Example:

"1234567890"

transactions.balance

number | null

The running balance of the account after transaction ocurred

Example:

423

transactions.categories

object[]

The category associated with the transaction

transactions.created

string

When transaction was created in Heron system

Example:

"2025-03-04T17:08:55.149206"

transactions.currency

string | null

ISO 4217 currency code

Required string length: 3

Example:

"USD"

transactions.data_source_account_heron_id

string

Unique ID of the transaction's data source account

Example:

"dsa_Br6ZoQnio66hdfYiaTbdqQ"

transactions.data_source_heron_id

string

Unique ID of the transaction's data source

Example:

"dso_6Cv42nMiRKxEbLfisXprFC"

transactions.description_clean

string

The cleaned description of the transaction

Example:

"GOOGLE ADS"

transactions.duplicate_of_id

any

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

transactions.end_user_id

string | null

Your unique ID for end user associated with transaction

Maximum length: 140

Example:

"my_best_customer_203948"

transactions.has_matching_transaction

boolean

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

transactions.heron_id

string

Unique ID of transaction; generated by Heron Data

Example:

"txn_KjPQKaF6BdpSpR6ewTPXNE"

transactions.is_potential_duplicate

boolean

Indicates whether the transaction has another transaction similar to it

transactions.is_recurring

boolean

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

transactions.last_updated

string

When transaction was last updated in Heron system; could be from recategorisation or attribute updates

Example:

"2025-03-04T17:08:55.149225"

transactions.merchant

object

The merchant associated with the transaction

transactions.payment_processor

object

The payment processor associated with the transaction

transactions.reference_id

string | null

Your unique ID for transaction

Maximum length: 140

Example:

"my_favourite_transaction_231098"

transactions.request_id

string | null

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

Example:

"req_gwxinWjDsZDbsLkoJFCQ7n"

transactions.timestamp

string | null

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

Example:

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

transactions.transaction_code

string | null

Code associated with transaction to indicate the type of transaction

Maximum length: 140

Example:

"card"

Was this page helpful?

Create end user transactions (async)Enrich transactions (sync)

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

{
  "_meta": {
    "next_url": "<string>",
    "page": 123,
    "pages": 123,
    "per_page": 123,
    "prev_url": "<string>"
  },
  "_summary": {
    "returned_transactions": 123,
    "transactions": 123
  },
  "transactions": [
    {
      "account_id": "checking_account_202348",
      "account_number": "1234567890",
      "amount": -42.42,
      "balance": 423,
      "categories": [
        {
          "annotator": "predicted",
          "confidence": 0.5,
          "heron_id": "ctg_CBybVA3tB6xcpzy8SKNinM",
          "label": "Rent",
          "model_version": "6f4d5ffa-4f92-4582-b9be-1fe295b2122f"
        }
      ],
      "created": "2025-03-04T17:08:55.149206",
      "currency": "USD",
      "data_source_account_heron_id": "dsa_Br6ZoQnio66hdfYiaTbdqQ",
      "data_source_heron_id": "dso_6Cv42nMiRKxEbLfisXprFC",
      "description": "GOOGLE *ADS12340929 [email protected] US",
      "description_clean": "GOOGLE ADS",
      "duplicate_of_id": "<any>",
      "end_user_id": "my_best_customer_203948",
      "has_matching_transaction": true,
      "heron_id": "txn_KjPQKaF6BdpSpR6ewTPXNE",
      "is_potential_duplicate": true,
      "is_recurring": true,
      "last_updated": "2025-03-04T17:08:55.149225",
      "merchant": {
        "categories": [
          {
            "code": "7311",
            "description": "Advertising services",
            "slug": "advertising_services"
          }
        ],
        "group_id": "Uber",
        "heron_id": "mrc_H4woHtq2y7hw3GLRh4hv62",
        "icon_url": "<string>",
        "is_priority": true,
        "logo_url": "<string>",
        "name": "<string>",
        "url": "<string>"
      },
      "payment_processor": {
        "heron_id": "mrc_nRYdGU7nYuevb7qem65cEb",
        "icon_url": "https://storage.googleapis.com/heron-merchant-assets/icons/mrc_nRYdGU7nYuevb7qem65cEb.svg",
        "logo_url": "https://storage.googleapis.com/heron-merchant-assets/logos/mrc_nRYdGU7nYuevb7qem65cEb.svg",
        "name": "Paypal",
        "url": "https://www.paypal.com"
      },
      "reference_id": "my_favourite_transaction_231098",
      "request_id": "req_gwxinWjDsZDbsLkoJFCQ7n",
      "timestamp": "2021-11-12T10:38:05Z",
      "transaction_code": "card"
    }
  ]
}

API Reference

Categories

CrmIntegrations

EndUserDataSourceAccounts

EndUserDataSources

EmailTemplates

EndUsers

EndUserEmails

EndUserEntity

EndUserFiles

EndUserCalculations

EndUserAttributes

EnrichmentFeedback

EndUserFinancials

EndUserRules

Integrations

EndUserIntegrations

ISOApplication

EndUserAccounts

EnrichedTransactions

Transactions

Policy

Testing

Merchants

Rules

ParsedEndUserSubmission

Users

Webhooks

Get apitransactions

Authorizations

Query Parameters

Response