Categorise Transactions

Enrich transaction data using the Categorisation endpoint.

Formatting Requirements

To ensure accurate processing and categorisation, please adhere to the following formatting rules when submitting transaction data:

  1. Amount Sign Convention:

    1. Credit (Incoming transactions): must be negative 🚨
    2. Debit (Outgoing transactions): must be positive 🚨
    {
      "original_description": "Salary Payment",
      "amount": -5000.00   // Credit 
    }
    
    {
      "original_description": "Noggin Store",
      "amount": 150.75     // Debit 
    }

    This convention is required for correct transaction direction detection and downstream categorisation.

  2. Date Format:

    1. Dates must be provided in the following format: YYYY-MM-DD 🚨
    2. No other date formats are supported

Failure to follow these conventions may result in incorrect categorisation or rejected requests.


Optional Fields

To enhance categorisation accuracy, you should include the following additional contextual fields in your request payload.

  1. Customer Name: The name of the customer as it appears on the account.
  2. Account Information: A list of bank accounts associated with the provided transactions.
🚧

Note: Omitting these fields will result in reduced accuracy.

Body Params
string
Defaults to Millicent Fawcett

The name of the customer as it appears on the account. This is an optional field which can improve the categorisation of transactions.

accounts
array of objects

An optional array of bank account details linked to the provided transactions from your customer. These details can improve the categorisation of transactions.

accounts
transactions
array of objects
required

An array of bank transaction objects.

transactions*
Headers
string
required

The API key provided for the Categorisation endpoint.

Responses

400

Bad Request

401

Unauthorized

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json