Maximum of 12 months returned
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/
Body
- application/json-patch+json
- application/json
- text/json
- application/*+json
The BYOD affordability processing request
Unique identifier for the account to have the affordability calculated
Currency code for the transactions, currently supported codes are GBP and USD.
- UK Environment (Production)
https://uk.api.atto.co/insights-engine/v1/affordability
- US Environment (Production)
https://us.api.atto.co/insights-engine/v1/affordability
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://uk.api.atto.co/insights-engine/v1/affordability?useLegacyCategorisation=false&confidenceFloor=0' \
-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"
}
]
}'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 }