Transactions
Enrich transactions (sync)
API Reference
Categories
EndUserDataSourceAccounts
EndUsers
- GETGet EndUser emails
- GETList EndUsers
- PUTUpdate EndUser
- POSTCreate EndUser
- GETList EndUsers with Summary Information
- GETGet EndUser by heron_id or end_user_id
- DELDelete EndUser by heron_id or end_user_id
- GETGet EndUser emails
- GETGet EndUser information
- PATCHPatch EndUser information
- POSTEnrich transactions of EndUser
- GETGet EndUser physical location
- GETRetrieve CRM sync events for an end user
- POSTTrigger a CRM Sync for an End User
EndUserEmails
EndUserEnricherFields
EndUserEntity
- GETGet the definitions for all end user entities
- POSTCreate an end user entity
- PATCHSet the display order of end user entities
- POSTCreate an end user entity attribute
- PATCHSet the display order of end user entity attributes
- DELDelete an EndUserEntityAttribute
- PATCHUpdate an end user entity
- POSTCreate an end user entity attribute
- POSTCreate an end user entity attribute source
- DELDelete an EndUserEntityAttribute
- PATCHUpsert an end user entity
- DELDelete an EndUserEntity
- PATCHUpdate an end user entity
- GETGet the materialised end user entities for an end user
- POSTUpsert the attribute value for an end user entity attribute source
EndUserFiles
- GETAll EndUserFiles
- GETGet recent files by file class
- GETGet file rename rules
- POSTCreate a file rename rule
- GETGet file rename rule variable slugs
- PATCHUpdate a file rename rule
- PATCHUpdate the end user file's class
- GETGet EndUserFile as a base64 string
- POSTTrigger async parsing of an end user file
- PATCHUpdate Parsed Results
- GETGet parsed results from uploaded files
- POSTTrigger file's rename rule
- POSTTrigger splitting a combined end user file into its child files based on its page_classes
- GETGet EndUserFiles
- POSTPost EndUserFile
- GETDownload EndUserFiles
- GETDownload xlsx of parsed results from uploaded files
FileClass
EndUserCalculations
- GETGet EndUser balance
- GETGet EndUser forecasts
- GETGet EndUser statistics
- GETRun industry classification on end user files
- GETGet EndUser anomalies
- GETGet EndUser bank statement summary
- GETGet EndUser metric benchmarks
- GETExport as a spreadsheet
- GETGet EndUser transactions grouped by counterparty or merchant
- GETGet EndUser Heron Score (beta)
- GETGet EndUser merchant summary
- GETGet EndUser named dates
- GETGet EndUser cashflow P&L
- PUTUpdate EndUser P&L layout
- GETGet EndUser recurring transactions report
- GETGet EndUser scorecard
- POSTRequest EndUser scorecard
- GETGet EndUser transaction data coverage
EndUserAttributes
EnrichmentFeedback
EndUserFinancials
EndUserRules
Integrations
- POSTSend a Finicity Connect email to an end user
- POSTTrigger a cashflow report generation for an end user
- POSTTrigger a statement reports generation for an end user
- POSTTrigger a Finicity VOE transactions report generation for an end user
- PUTUpdate an Integration Link
- GETList Integrations
- POSTCreate an integration
- PUTUpdate Integration
- GETGet IntegrationLinks by Integration
- POSTCreate an integration Link
- DEL(Soft-)Delete an integration link
- POSTRefresh an IntegrationLink
EndUserIntegrations
- POSTUpload Inscribe
- GETGet Integration Links
- POSTUpload Ocrolus
- GETGet PDFs
- POSTParse all PDF
- POSTUpload PDF
- POSTUpload Plaid assets
- POSTUpload Plaid transactions
- POSTUpload Yodlee
- PUTUpdate PDF attributes including status
- PATCHSend patch transactions for a pdf statement
- POSTReloads transactions for a pdf
- POSTUnloads transactions for a pdf
ISOApplication
- POSTUpload an ISO application PDF for for an end user
- GETGet EndUser ISO Applications
- POSTUpload an ISO application PDF for automated scrubbing in under 15 seconds
- POSTUpload an ISO application PDF for automated scrubbing in under 15 seconds (base64)
- POSTReprocess a single ISO application
- GETGet the scrubbed results and data validations of an uploaded ISO application by its heron_id (prefixed "iso_")
EndUserAccounts
EnrichedTransactions
Transactions
Merchants
ParsedEndUserSubmission
UserMerchantGroups
Users
Transactions
Enrich transactions (sync)
Enrich and categorize transactions and consume them in a sync response. For business lending and underwriting, please use “Create end user transactions” instead. Please send a maximum of 249 transactions per request.
POST
/
api
/
transactions
curl --request POST \
--url https://app.herondata.io/api/transactions \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"transactions": [
{
"account_id": "checking_account_202348",
"amount": -42.42,
"balance": 423,
"categories_default": "shopping",
"currency": "USD",
"date": "2020-04-27",
"description": "GOOGLE *ADS12340929 [email protected] US",
"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": [
{
"account_id": "checking_account_202348",
"amount": -42.42,
"balance": 423,
"categories": [
{
"annotator": "predicted",
"confidence": 0.5,
"heron_id": "ctg_CbgtZSQ7iAJwcZJXpMkc3F",
"label": "Rent",
"model_version": "fd2c49bb-6ed2-4b33-96bb-3a378cf4b51d"
}
],
"currency": "USD",
"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,
"is_potential_duplicate": true,
"is_recurring": true,
"merchant": {
"categories": [
{
"code": "7311",
"description": "Advertising services",
"slug": "advertising_services"
}
],
"group_id": "Uber",
"heron_id": "mrc_PwJ4WqW86qm99sA9W6XGhk",
"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_adXwG4vYrjHawuU2rAwo3E",
"timestamp": "2021-11-12T10:38:05Z",
"transaction_code": "card"
}
]
}
Authorizations
Body
application/json
Response
200
application/json
OK
The response is of type object
.
Was this page helpful?
curl --request POST \
--url https://app.herondata.io/api/transactions \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"transactions": [
{
"account_id": "checking_account_202348",
"amount": -42.42,
"balance": 423,
"categories_default": "shopping",
"currency": "USD",
"date": "2020-04-27",
"description": "GOOGLE *ADS12340929 [email protected] US",
"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": [
{
"account_id": "checking_account_202348",
"amount": -42.42,
"balance": 423,
"categories": [
{
"annotator": "predicted",
"confidence": 0.5,
"heron_id": "ctg_CbgtZSQ7iAJwcZJXpMkc3F",
"label": "Rent",
"model_version": "fd2c49bb-6ed2-4b33-96bb-3a378cf4b51d"
}
],
"currency": "USD",
"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,
"is_potential_duplicate": true,
"is_recurring": true,
"merchant": {
"categories": [
{
"code": "7311",
"description": "Advertising services",
"slug": "advertising_services"
}
],
"group_id": "Uber",
"heron_id": "mrc_PwJ4WqW86qm99sA9W6XGhk",
"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_adXwG4vYrjHawuU2rAwo3E",
"timestamp": "2021-11-12T10:38:05Z",
"transaction_code": "card"
}
]
}