Skip to content

Transaction Feedback

Info

For more detailed API specs, see our OpenAPI Docs

Posting transaction feedback

In order to continuously improve the categorisation model, you may want to provide corrected categorisations yourself or enable your end users to correct categorisation. Please speak to your Heron Data contact to specify how this feedback should be taken into account for future transactions.

We enable this through a POST request to /transactions/feedback, where the body of the request is of schema:

{
    "transaction_feedback": [
        {
            "transaction_heron_id": "string",
            "category_heron_id": "string"
        }
    ]
}

Where:

  • transaction_heron_id is the Heron ID associated with the transaction that Heron Data generates
  • category_label is the Heron ID associated with the category that Heron Data generates

So an example request would look as follows:

curl --location --request POST https://app.herondata.io/api/transactions/feedback' \
--header '<your-authorisation>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "transaction_feedback": [
        {
            "transaction_heron_id": "txn_089123j",
            "category_heron_id": "ctg_234798k"
        }
    ]
}'