Maximum of 12 months returned
URL https://www.atto.co/about/contact
API Support support@atto.co
License All Rights Reserved © The IDCO. Ltd
Terms of Service
If you wish to calculate affordability with any transactions that you have, you can do so using the POST /insights-engine/v1/affordability 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.
There are one additional request parameters that can be specified when making a request:
includeFlexibleCosts, when true, returns transactions marked as flexible and will include those transactions in the affordability calculation. When this value is false, it will still return the transactions marked as flexible but will omit those transactions from the affordability calculation. Please note that flexibleCosts and estimatedFlexibleCosts values 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 calculating estimatedAffordability. Note, the default value for this parameter is trueIn response to your call, you will receive a JSON object containing each months affordability with an estimated total for the months supplied.
There is a maximum transaction threshold of 5000 which will return an invalid request response if the number of transaction sent is greater than this.
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.
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"
}
]
}'{ "referenceId": "string", "countryCode": "string", "currencyCode": "string", "affordabilityMonths": [ { … } ], "estimatedCalculatedIncome": 0.1, "estimatedFixedCosts": 0.1, "estimatedFlexibleCosts": 0.1, "estimatedDebtFees": 0.1, "estimatedAffordability": 0.1 }