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

Atto Developer Documentation (all)

Download OpenAPI description

index.json

index.yaml

Overview

URL

https://www.atto.co/about/contact

API Support

support@atto.co

License

Servers

UK Environment (Production)

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

US Environment (Production)

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

Get Token

Operations

Connect Invitation

Operations

Get Consents

Operations

Bank Account Verification

Operations

Bank Data

Operations

Income Verification

Operations

Affordability

Operations

Bank Data (stored)

Operations

Income Verification (stored)

Operations

Payment Account Confirmation

Operations

Affordability (stored)

Operations

Atto Score

Operations

Consumer Financial Health

Operations

Business Financial Health

Operations

Categorisation Engine

Operations

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": [ … ]
  }
]

Income Verification Engine

Operations

Affordability Engine

Operations

Get Statement

Operations

Atto Developer Documentation (all)

Get Token

Connect Invitation

Get Consents

Revoke Consent

Bank Account Verification

Bank Data

Income Verification

Affordability

Bank Data (stored)

Income Verification (stored)

Payment Account Confirmation

Affordability (stored)

Atto Score

Consumer Financial Health

Business Financial Health

Categorisation Engine

Authentication

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

RequestExpand all

Responses

Was this helpful?

Income Verification Engine

Affordability Engine

Get Statement

Request