Maximum of 12 months returned
Affordability
Get Token
Connect Invitation
Get Consents
Revoke Consent
Bank Account Verification
Bank Data
Income Verification
Bank Data (stored)
Income Verification (stored)
Payment Account Confirmation
Affordability (stored)
Atto Score
Consumer Financial Health
Business Financial Health
Categorisation Engine
Income Verification Engine
Affordability Engine
Get Statement
Accounts
Atto Developer Documentation (all)
Download OpenAPI description
Overview
URL
API Support
License
Languages
Servers
UK Environment (Production)
https://uk.api.atto.co/
US Environment (Production)
https://us.api.atto.co/
If you wish to get the affordability for a given consent, you can do so using the GET /affordability/v1/consents/:consentId endpoint. Please ensure that this product is enabled for your app by talking to support before using this endpoint.
There is one additional request parameters that can be specified when making a request:
includeFlexibleCosts, whentrue, returns transactions marked as flexible and will include those transactions in the affordability calculation. When this value isfalse, it will still return the transactions marked as flexible but will omit those transactions from the affordability calculation. Please note thatflexibleCostsandestimatedFlexibleCostsvalues will be still shown in case there have been transactions that are associated with flexible costs, but these values are not taken into account while calculatingestimatedAffordability. Note, the default value for this parameter istrue
In response to your call, you will receive a JSON object containing each months affordability with an estimated total for the months supplied with the account details.
- UK Environment (Production)
https://uk.api.atto.co/affordability/v1/consents/{consentId}
- US Environment (Production)
https://us.api.atto.co/affordability/v1/consents/{consentId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://uk.api.atto.co/affordability/v1/consents/{consentId}?includeFlexibleCosts=true' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'Response
application/json
[ { "accountDetails": { … }, "affordabilityMonths": [ … ], "estimatedCalculatedIncome": 0.1, "estimatedFixedCosts": 0.1, "estimatedFlexibleCosts": 0.1, "estimatedDebtFees": 0.1, "estimatedAffordability": 0.1 } ]