API Reference
/
Affordability Engine
/
Processes affordability for the 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 All Rights Reserved © The IDCO. Ltd
 Terms of Service
Languages
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

Revoke Consent

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

Income Verification Engine

Operations

Affordability Engine

Operations

Authentication

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

Processes affordability for the transactions supplied.

Request

Maximum of 12 months returned

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

The BYOD affordability processing request

referenceIdstringnon-emptyrequired

Unique identifier for the account to have the affordability calculated

includeFlexibleCostsboolean

Includes flexible costs in the affordability calculation

currencyCodestringnon-emptyrequired

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

countryCodestringnon-emptyrequired

Country code for the account of the transactions

transactionsArray of objects or null(DirectID.Data.API.Models.Affordability.Request.AffordabilityTransaction)
curl -i -X POST \
  'https://uk.api.atto.co/insights-engine/v1/affordability?confidenceFloor=0&useLegacyCategorisation=false' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "referenceId": "string",
    "includeFlexibleCosts": true,
    "currencyCode": "string",
    "countryCode": "string",
    "transactions": [
      {
        "transactionId": "string",
        "description": "string",
        "amount": 0.1,
        "creditDebitIndicator": "Credit",
        "status": "Pending",
        "bookingDate": "string"
      }
    ]
  }'

Responses

Affordability Calculations for the supplied transactions

Bodyapplication/json
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.

affordabilityMonthsArray of objects or null(DirectID.Data.API.Models.Affordability.Response.MonthAffordability)

List of Month Affordability

estimatedCalculatedIncomenumber(double)read-only

Calculated Income Estimate

estimatedFixedCostsnumber(double)read-only

Calculated Fixed Cost Estimate

estimatedFlexibleCostsnumber(double)read-only

Calculated Flexible Costs Estimate

estimatedDebtFeesnumber(double)read-only

Calculated Debt Fees Estimate

estimatedAffordabilitynumber(double)read-only

Calculated Affordability Estimate

Response
application/json
{
  "referenceId": "string",
  "countryCode": "string",
  "currencyCode": "string",
  "affordabilityMonths": [
    { … }
  ],
  "estimatedCalculatedIncome": 0.1,
  "estimatedFixedCosts": 0.1,
  "estimatedFlexibleCosts": 0.1,
  "estimatedDebtFees": 0.1,
  "estimatedAffordability": 0.1
}

Get Statement

Operations
API Support
Contact Us
Terms
All Rights Reserved © The IDCO. Ltd | Company registered in Scotland SC400459 | AISP registration number 798579 | Data Protection ICO number ZA384596