Menu
API installment simulation
API installment simulation
Request
Endpoint
Sandbox: https://api.sandbox.soisy.it/api/shops/{shopId}/loan-quotes
Produzione: https://api.soisy.it/api/shops/{shopId}/loan-quotes
Accepted methods
GET
Authentication
This API does not require authentication. Please specify yours onlyshopId in the URLParameters
| Parameter | Obligatory | Type | Format | Description |
|---|---|---|---|---|
| amount | Yes | Entire | Total order or product, in € cents | |
| instalments | Yes | Entire | Number of installments, from 3 to 60 (*) | |
| zeroInterestRate | No | Boolean | Enable zero rate. ISfalse by default |
Answer
The API returns a JSON object.HTTP response codes
| Code | Description |
|---|---|
| 200 | Request completed successfully |
| 400 | Syntax or domain error |
| 403 | Failed to authenticate the request |
| 404 | Resource not found |
| 500 | System error |
Valid answer
The answer contains the minimum, maximum and average simulation. The returned parameters are:
{
"min": {
"fee": 1000,
"interest": 2000,
"interestRate": 5.5,
"totalRepaid": 103000,
"apr": 6.00,
"instalmentAmount": 5000
},
"median": {
"fee": 1000,
"interest": 2500,
"interestRate": 6.0,
"totalRepaid": 103500,
"apr": 7.00,
"instalmentAmount": 5500
},
"max": {
"fee": 1000,
"interest": 3000,
"interestRate": 8.0,
"totalRepaid": 104000,
"apr": 7.50,
"instalmentAmount": 6000
}
}
Where is it:
| Parameter | Type | Description |
|---|---|---|
| Fee | Whole | Soisy Commission, in € cents |
| interest | Total | Interest (TAN), in € cents |
| interestRate | Float | Interest (TAN), as a percentage |
| totalRepaid | Integer | Total to be paid, in € cents |
| Apr | Float | APR |
| instalmentAmount | Full | Installment to be paid, in € cents |
Error response
{
"errors": {
"domain": [
0: "Invalid data."
]
}
}
