v1
latestOpenAPI 3.0.02026-07-26224386470.0 KBTransactions
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
Request body
Example request
{
"transactions": [
{
"account_id": "checking_account_202348",
"amount": -42.42,
"balance": 423,
"categories_default": "shopping",
"currency": "USD",
"date": "2020-04-27",
"description": "GOOGLE *ADS12340929 cc@google.com US",
"end_user_id": "my_best_customer_203948",
"heron_id": "txn_Yqsbw75xpkSRPK4Ap5Mrvi",
"reference_id": "my_favourite_transaction_231098",
"request_id": "req_drEXA6Vv9ueRURxJXrbVR8",
"timestamp": "2021-11-12T10:38:05Z",
"transaction_code": "card"
}
]
}Response
OK
Example response
{
"transactions": [
{
"account_id": "checking_account_202348",
"amount": -42.42,
"balance": 423,
"categories": [
{
"annotator": "predicted",
"confidence": 0.5,
"heron_id": "ctg_RyeiQRgg2r5jccbXS9SeAi",
"label": "Rent",
"model_version": "0bb197c6-ba24-4a40-af75-7816f27ef34b"
}
],
"currency": "USD",
"description": "GOOGLE *ADS12340929 cc@google.com US",
"description_clean": "GOOGLE ADS",
"duplicate_of_id": "txn_B2AhGvaqL2rWHrUWsArPMp",
"end_user_id": "my_best_customer_203948",
"merchant": {
"categories": [
{
"code": "7311",
"description": "Advertising services",
"slug": "advertising_services"
}
],
"heron_id": "mrc_gkcx4tKTGc2T5v2QiJVuMV"
},
"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_drEXA6Vv9ueRURxJXrbVR8",
"timestamp": "2021-11-12T10:38:05Z",
"transaction_code": "card"
}
]
}