Introduction
Provides an estimate of the amount to settle a finance agreement on a user defined date. Please contact us for free implementation consultancy if you plan on integrating this endpoint. Although customer_rate, monthly_payment_gbp, advance_gbp & gfv_gbp are mandatory parameters, it is possible to omit one of these four parameters with minimal loss of accuracy.
Header
When making calls to our API, include the following header:
x-api-key:your-api-key-here
Example Request
https://api.oneautoapi.com/oneauto/settlementcalculator?start_date=2020-01-01&term_months=48&number_monthly_payments=48&settlement_date=2020-01-01&customer_rate=12.3&monthly_payment_gbp=123.45&advance_gbp=12345&gfv_gbp=6789.1
Example Sandbox Request
https://sandbox.oneautoapi.com/oneauto/settlementcalculator?start_date=2020-01-01&term_months=48&number_monthly_payments=48&settlement_date=2020-01-01&customer_rate=12.3&monthly_payment_gbp=123.45&advance_gbp=12345&gfv_gbp=6789.1
Request Parameters
start_date
mandatory, string, e.g. 2020-01-01
The date on which the agreement started.
term_months
mandatory, string, e.g. 48
The scheduled term of the finance agreement.
number_monthly_payments
mandatory, string, e.g. 48
The number of monthly payments as supplied by the financial provider.
settlement_date
mandatory, string, e.g. 2020-01-01
The settlement date.
customer_rate
mandatory, string, e.g. 12.3
The customer rate (as supplied by financial institution) or APR if unavailable.
monthly_payment_gbp
mandatory, string, e.g. 123.45
The monthly payment in GBP.
advance_gbp
mandatory, string, e.g. 12345
The advanced payment in GBP.
gfv_gbp
mandatory, string, e.g. 6789.1
The guaranteed future value in GBP. For Hire Purchase (HP) agreement this parameter should be set as zero.
Sample Response
{
"success": true,
"result": {
"settlement_amount_gbp": 12345.67
},
"error": "If there is an error the message would go here"
}Response Parameters
success
e.g. true
Whether the api call was successful
settlement_amount_gbp
e.g. 12345.67
The settlement in GBP.
error
e.g. If there is an error the message would go here
Details of what went wrong with the api call
Status Codes
200
success, chargeable
Request has been successfully received and a response has been sent.
202
accepted, non-chargeable
Request has been received and accepted for processing, but the action has not yet been completed.
204
no content, non-chargeable
Request has been successfully received but there is no content to return e.g. if an invalid VRM has been sent.
206
partial content, non-chargeable
Request has been successfully received but limited content is returned e.g. if an invalid VRM has been sent.
400
bad request, non-chargeable
Request was not received e.g. if any required parameters are missing.
403
forbidden, non-chargeable
Request was rejected e.g. if the API key is invalid or the service is not enabled.
429
too many requests, non-chargeable
API key rate limit/quota has been exceeded.
500
internal server error, non-chargeable
We are unable to process the request e.g. if the API is under extremely heavy load.
503
service unavailable, non-chargeable
Service is temporarily unavailable. Contact help@oneautoapi.com
