Skip to content

Transaction Categorisation Feedback

Note

For more precise documentation see the swagger UI / Open API version of the documentation

Base_url

https://app.herondata.io/api


Posting transaction categorisation 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": [
        {
            "reference_id": "string",
            "category_label": "string",
            "end_user_id": "string"
        }
    ]
}

Where:

  • reference_id is the reference ID associated with the transaction
  • category_label is the updated category
  • end_user_id is the optional end user identification

So an example request would look as follows:

curl --location --request POST lhttps://app.herondata.io/api/transactions/feedback' \
--header '<your-authorisation>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "transaction_feedback": [
        {
            "reference_id": "this-transaction",
            "category_label": "that-category",
            "end_user_id": "that-user"
        }
    ]
}'