Create end user transactions (async)

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

{
  "request_id": "<string>",
  "transactions_loaded": 123
}

POST

api

end_users

{end_user_id_or_heron_id}

transactions

Create end user transactions (async)

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

{
  "request_id": "<string>",
  "transactions_loaded": 123
}

Authorizations

x-api-key

string

header

required

Path Parameters

end_user_id_or_heron_id

string

required

Body

application/json

transactions

object[]

required

Minimum array length: 1

Show child attributes

transactions.account_id

string

required

Your unique ID for account associated with transaction

Maximum string length: 400

Example:

"checking_account_202348"

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.currency

string

required

ISO 4217 currency code

Required string length: 3

Example:

"USD"

transactions.description

string

required

The text description for the transaction

Example:

"GOOGLE *ADS12340929 [email protected] US"

transactions.reference_id

string

required

Your unique ID for transaction

Maximum string length: 140

Example:

"my_favourite_transaction_231098"

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.date

string<date> | null

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

Example:

"2020-04-27"

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.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"

balances

object[] | null

Bank account balance information for a particular account_id. The balance here must be the latest balance after all the transactions in this batch have been applied.

Show child attributes

balances.account_id

string

required

Maximum string length: 400

Example:

"checking_account_202348"

balances.batch_closing_balance

number

required

The closing balance for this account after the transactions in this batch

Example:

25000.45

Response

201 - application/json

request_id

string

Unique UUID per request

transactions_loaded

integer

The number of transactions loaded

Get apitransactions Get apitransactions

⌘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

Path Parameters

Body

Response