v1

latestOpenAPI 3.0.02026-07-2412592575.3 KB

categorise transactions

Categorises a given set of transactions

Requires categorisation scope. A maximum of 200 transactions is imposed.

post/categorise-transactions

Request body

accountType'cash' | 'card' | 'savings' | 'pension' | 'investment'

Type of account, defaults to 'cash' if no value is provided

accountIdstring

The id of the account the transaction belongs to. Defaults to random uuid if no value is provided

Example request

{
  "accountId": "c390a94f-2309-4cdf-8d02-b0c5304d9f66",
  "accountType": "cash",
  "transactions": [
    {
      "id": "c390a94f-2309-4cdf-8d02-b0c5304d9f66",
      "description": "Card Purchase SAINSBURYS S/MKTS  BCC",
      "amount": {
        "value": -4500
      },
      "date": "2025-04-29T10:51:34.747Z",
      "proprietaryTransactionCode": "DIRECT DEBIT",
      "merchantCategoryCode": "1234"
    },
    {
      "id": "c390a94f-2309-4cdf-8d02-b0c5304d9f66",
      "description": "WM Morrisons",
      "amount": {
        "value": -5000
      },
      "date": "2025-04-29T10:51:34.747Z",
      "proprietaryTransactionCode": "DEBIT",
      "merchantCategoryCode": "1234"
    }
  ]
}

Response

Successful Categorisation Response

metaobject

Example response

{
  "data": {
    "accountId": "c390a94f-2309-4cdf-8d02-b0c5304d9f66",
    "accountType": "cash",
    "transactions": [
      {
        "id": "c0626412-311e-43c3-b885-793a2de8f492",
        "description": "Amazon",
        "amount": {
          "value": -3000
        },
        "date": "2025-04-29T10:51:34.747Z",
        "counterpartyId": "ba4d83ec-3240-5d6e-b258-11e1c913da62",
        "categoryId": "std:cdc55410-176d-4c71-9bb2-6988b5d4913d"
      }
    ],
    "failedCategorisationIds": []
  }
}