Enrich transactions (sync)

curl --request POST \
  --url https://app.herondata.io/api/transactions \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "transactions": [
    {
      "amount": -42.42,
      "description": "GOOGLE *ADS12340929 [email protected] US",
      "account_id": "checking_account_202348",
      "balance": 423,
      "categories_default": "shopping",
      "currency": "USD",
      "date": "2020-04-27",
      "end_user_id": "my_best_customer_203948",
      "mcc_code": "<string>",
      "order": 123,
      "reference_id": "my_favourite_transaction_231098",
      "timestamp": "2021-11-12T10:38:05Z",
      "transaction_code": "card"
    }
  ]
}
'

{
  "_summary": {
    "request_id": "<string>"
  },
  "transactions": [
    {
      "amount": -42.42,
      "description": "GOOGLE *ADS12340929 [email protected] US",
      "account_id": "checking_account_202348",
      "balance": 423,
      "categories": [
        {
          "annotator": "predicted",
          "confidence": 0.5,
          "heron_id": "ctg_KdU6wWmGSirLaroMKMBC9W",
          "label": "Rent",
          "model_version": "f5dc95c9-cbbc-48bb-bc94-4e4a44f24d63"
        }
      ],
      "currency": "USD",
      "description_clean": "GOOGLE ADS",
      "duplicate_of_id": "txn_7Bw88kjrQmo5Vko56fFa5u",
      "end_user_id": "my_best_customer_203948",
      "has_matching_transaction": true,
      "is_potential_duplicate": true,
      "is_recurring": true,
      "merchant": {
        "name": "<string>",
        "url": "<string>",
        "categories": [
          {
            "code": "7311",
            "description": "Advertising services",
            "slug": "advertising_services"
          }
        ],
        "group_id": "Uber",
        "heron_id": "mrc_5JzGMsVvAMgFd68isytoS8",
        "icon_url": "<string>",
        "is_priority": true,
        "logo_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_hi3eGHpHoTU5HZisZrdmTt",
      "timestamp": "2021-11-12T10:38:05Z",
      "transaction_code": "card"
    }
  ]
}

POST

api

transactions

Enrich transactions (sync)

curl --request POST \
  --url https://app.herondata.io/api/transactions \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "transactions": [
    {
      "amount": -42.42,
      "description": "GOOGLE *ADS12340929 [email protected] US",
      "account_id": "checking_account_202348",
      "balance": 423,
      "categories_default": "shopping",
      "currency": "USD",
      "date": "2020-04-27",
      "end_user_id": "my_best_customer_203948",
      "mcc_code": "<string>",
      "order": 123,
      "reference_id": "my_favourite_transaction_231098",
      "timestamp": "2021-11-12T10:38:05Z",
      "transaction_code": "card"
    }
  ]
}
'

{
  "_summary": {
    "request_id": "<string>"
  },
  "transactions": [
    {
      "amount": -42.42,
      "description": "GOOGLE *ADS12340929 [email protected] US",
      "account_id": "checking_account_202348",
      "balance": 423,
      "categories": [
        {
          "annotator": "predicted",
          "confidence": 0.5,
          "heron_id": "ctg_KdU6wWmGSirLaroMKMBC9W",
          "label": "Rent",
          "model_version": "f5dc95c9-cbbc-48bb-bc94-4e4a44f24d63"
        }
      ],
      "currency": "USD",
      "description_clean": "GOOGLE ADS",
      "duplicate_of_id": "txn_7Bw88kjrQmo5Vko56fFa5u",
      "end_user_id": "my_best_customer_203948",
      "has_matching_transaction": true,
      "is_potential_duplicate": true,
      "is_recurring": true,
      "merchant": {
        "name": "<string>",
        "url": "<string>",
        "categories": [
          {
            "code": "7311",
            "description": "Advertising services",
            "slug": "advertising_services"
          }
        ],
        "group_id": "Uber",
        "heron_id": "mrc_5JzGMsVvAMgFd68isytoS8",
        "icon_url": "<string>",
        "is_priority": true,
        "logo_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_hi3eGHpHoTU5HZisZrdmTt",
      "timestamp": "2021-11-12T10:38:05Z",
      "transaction_code": "card"
    }
  ]
}

Authorizations

x-api-key

string

header

required

Body

application/json

transactions

object[]

required

Minimum array length: 1

Show child attributes

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 string length: 400

Example:

"checking_account_202348"

transactions.balance

number | null

The running balance of the account after transaction ocurred

Example:

423

transactions.categories_default

string | null

Category of transaction that you may have received from other sources

Example:

"shopping"

transactions.currency

string | null

ISO 4217 currency code

Required string length: 3

Example:

"USD"

transactions.date

string<date> | null

The date of the transaction; 'timestamp' field takes priority over 'date'

Example:

"2020-04-27"

transactions.end_user_id

string | null

Your unique ID for end user associated with transaction

Maximum string length: 140

Example:

"my_best_customer_203948"

transactions.mcc_code

string | null

Merchant category code associated with transaction that you may have received from other sources

transactions.order

integer | null

If sending a batch of transactions, the order in which the transaction occurs, where a higher value is equivalent to a more recent transaction

transactions.reference_id

string | null

Your unique ID for transaction

Maximum string length: 140

Example:

"my_favourite_transaction_231098"

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

string | null

Code associated with transaction to indicate the type of transaction

Maximum string length: 140

Example:

"card"

Response

_summary

object

Show child attributes

_summary.request_id

string

Unique UUID per request

transactions

object[]

only returned for sync enrichment requests

Show child attributes

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 string length: 400

Example:

"checking_account_202348"

transactions.balance

number | null

The running balance of the account after transaction ocurred

Example:

423

transactions.categories

object[]

The category associated with the transaction

Show child attributes

transactions.categories.annotator

string

Annotator type

Example:

"predicted"

transactions.categories.confidence

number

The confidence associated with the category annotation

Example:

0.5

transactions.categories.heron_id

string

Unique ID of category; generated by Heron Data

Example:

"ctg_KdU6wWmGSirLaroMKMBC9W"

transactions.categories.label

string

Label of category

Example:

"Rent"

transactions.categories.model_version

string

The model version that produced the categorisation

Example:

"f5dc95c9-cbbc-48bb-bc94-4e4a44f24d63"

transactions.currency

string | null

ISO 4217 currency code

Required string length: 3

Example:

"USD"

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

Example:

"txn_7Bw88kjrQmo5Vko56fFa5u"

transactions.end_user_id

string | null

Your unique ID for end user associated with transaction

Maximum string 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.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.merchant

object

The merchant associated with the transaction

Show child attributes

transactions.merchant.name

string

required

transactions.merchant.url

string<url>

required

transactions.merchant.categories

object[]

Show child attributes

transactions.merchant.categories.code

string

required

Example:

"7311"

transactions.merchant.categories.description

string | null

Example:

"Advertising services"

transactions.merchant.categories.slug

string | null

Example:

"advertising_services"

transactions.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.merchant.heron_id

string

Example:

"mrc_5JzGMsVvAMgFd68isytoS8"

transactions.merchant.icon_url

string<url> | null

transactions.merchant.is_priority

boolean

transactions.merchant.logo_url

string<url> | null

transactions.payment_processor

object

The payment processor associated with the transaction

Show child attributes

transactions.payment_processor.heron_id

string

Example:

"mrc_nRYdGU7nYuevb7qem65cEb"

transactions.payment_processor.icon_url

string<url> | null

Example:

"https://storage.googleapis.com/heron-merchant-assets/icons/mrc_nRYdGU7nYuevb7qem65cEb.svg"

transactions.payment_processor.logo_url

string<url> | null

Example:

"https://storage.googleapis.com/heron-merchant-assets/logos/mrc_nRYdGU7nYuevb7qem65cEb.svg"

transactions.payment_processor.name

string | null

Example:

"Paypal"

transactions.payment_processor.url

string<url> | null

Example:

"https://www.paypal.com"

transactions.reference_id

string | null

Your unique ID for transaction

Maximum string 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_hi3eGHpHoTU5HZisZrdmTt"

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

string | null

Code associated with transaction to indicate the type of transaction

Maximum string length: 140

Example:

"card"

Get apitransactions Delete transactions

⌘I

API Reference

AppStore

Categories

Credentials

CrmIntegrations

EndUserDataSourceAccounts

EndUserDataSources

EmailTemplates

EndUsers

EndUserEmails

EndUserEnrichers

EndUserEntity

EndUserFiles

FileClass

EndUserCalculations

EndUserAttributes

EnrichmentFeedback

EndUserFinancials

EndUserRules

Integrations

EndUserIntegrations

ISOApplication

EndUserAccounts

Policy

Positions

EnrichedTransactions

Transactions

Funders

Testing

Merchants

Rules

ParsedEndUserSubmission

UserMerchantGroups

Users

Watermarks

Webhooks

Workflows

Authorizations

Body

Response