v1

latestOpenAPI 3.0.02026-07-26224386470.0 KB
Transactions

Create end user transactions (async)

Upload transactions for a specific end user. Does not include enriching transactions -- set end user status = 'ready' to initiate processing. For synchronous enrichment, please instead use "Enrich transactions (sync). Either timestamp (preferred) or date must be present in the transaction payload."

post/api/end_users/{end_user_id_or_heron_id}/transactions

Path parameters

end_user_id_or_heron_idstring required

Request body

Example request

{
  "balances": [
    {
      "account_id": "checking_account_202348",
      "batch_closing_balance": 25000.45
    }
  ],
  "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",
      "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

request_idstring

Unique UUID per request

transactions_loadedinteger

The number of transactions loaded