Skip to content

Atto Developer Documentation (all)

Download OpenAPI description
Languages
Servers
UK Environment (Production)

https://uk.api.atto.co/

US Environment (Production)

https://us.api.atto.co/

Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations

Integration

If you wish to categorise any transactions that you have, you can do so using the POST /insights-engine/v1/enrich-transactions endpoint. This will be using the data supplied via the endpoint in the request. Please ensure that this product is enabled for your app by talking to support before using this endpoint.

In response to your call, you will receive a JSON object containing the original transations with added classes and categories along with confidence score, and merchant name.

Authentication

This API requires a bearer token using the api:data scope

Adds categorisation, classification and predicts a merchant name for transactions supplied.

Request

Security
Bearer
Query
useLegacyCategorisationboolean

Flag whether to use the latest or legacy categorisation service

Default false
confidenceFloornumber(double)

Value from 0.0 to 1.0 which will return transactions as uncategorised if the category confidence is below this value

Default 0
Body

Request body for categorisation

referenceIdstringnon-emptyrequired

Unique identifier for the categorisation request

countryCodestringnon-emptyrequired

Country code for the account of the transactions

currencyCodestringnon-emptyrequired

Currency code for the transactions, currently supported codes are GBP and USD.

transactionsArray of objects or null(DirectID.Data.API.Models.Categorisation.Request.CategorisationTransaction)

Transaction data. Maximum limit for the number of transactions is 5000.

curl -i -X POST \
  'https://uk.api.atto.co/insights-engine/v1/enrich-transactions?useLegacyCategorisation=false&confidenceFloor=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "referenceId": "string",
    "countryCode": "string",
    "currencyCode": "string",
    "transactions": [
      {
        "transactionId": "string",
        "description": "string",
        "amount": 0.1,
        "creditDebitIndicator": "Credit",
        "status": "Pending",
        "bookingDate": "string"
      }
    ]
  }'

Responses

Categorisation result for the supplied transactions

Bodyapplication/jsonArray [
referenceIdstring or null

Unique identifier for the categorisation request

countryCodestring or null

Country code for the account of the transactions

currencyCodestring or null

Currency code for the transactions, currently supported codes are GBP and USD.

transactionsArray of objects or null(DirectID.Data.API.Models.Categorisation.Response.CategorisationTransactionResponse)
]
Response
application/json
[ { "referenceId": "string", "countryCode": "string", "currencyCode": "string", "transactions": [] } ]
Operations
Operations
Operations
Operations