API Simulazione Rateale

API simulazione rateale

Richiesta

Endpoint

				
					Sandbox: https://api.sandbox.soisy.it/api/shops/{shopId}/loan-quotes
Produzione: https://api.soisy.it/api/shops/{shopId}/loan-quotes

Metodi accettati

GET

Autenticazione

Questa API non richiede autenticazione. Specificare solo il proprio shopId nell’URL

Parametri

Parametro	Obbligatorio	Tipo	Descrizione
amount	Sì	Intero	Totale dell’ordine o del prodotto, in centesimi di €
instalments	Sì	Intero	Numero di rate, da 3 a 60 (*)
zeroInterestRate	No	Booleano	Abilita il tasso zero. È `false` di default

(*) Il numero massimo di rate può variare a seconda degli accordi presi in fase contrattuale.

Risposta

L’API restituisce un oggetto JSON.

Codici HTTP di risposta

Codice	Descrizione
200	Richiesta completata con successo
400	Errore di sintassi o di dominio
403	Impossibile autenticare la richiesta
404	Risorsa non trovata
500	Errore di sistema

Risposta valida

La risposta contiene la simulazione minima, quella massima e quella media. I parametri restituiti sono:

				
					{
    "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
    }
}

Dove:

Parametro	Tipo	Descrizione
fee	Intero	Commissione Soisy, in centesimi di €
interest	Intero	Interesse (TAN), in centesimi di €
interestRate	Float	Interesse (TAN), in percentuale
totalRepaid	Intero	Totale da pagare, in centesimi di €
apr	Float	TAEG
instalmentAmount	Intero	Rata da pagare, in centesimi di €

Risposta di errore

				
					{
 "errors": {
     "domain": [
         0: "Invalid data."
         ]
     }
}