Simulazione

Questo endpoint restituisce la simulazione di un pagamento rateale. Ti consente di ottenere un'anteprima del pagamento rateale, ad esempio per mostrare sulla pagina prodotto quanto costerebbe pagarlo a rate. Ecco un esempio dell'utilizzo di questa feature:

Simulazione di un prestito

Soisy definisce l'interesse sul cliente calcolandolo in base al suo merito creditizio. La API Simulazione permette, infatti, di mostrare diversi esempi di costo rata. Per semplicità, gli esempi sono 3: costo minimo, costo medio e costo massimo. Sarai quindi libero di mostrare al tuo cliente un esempio di rata. Noi suggeriamo di usare il costo medio.

Il valore reale, che potremo calcolare solo dopo il checkout una volta recuperati alcuni dati effettivi dei clienti, potrebbe essere diverso, ma comunque entro il range di rata minima e massima fornito da questa API.

Le richieste effettuate non vengono salvate sui nostri server.


Richiesta

Endpoint

Sandbox: http://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 richiede l'autenticazione tramite shopId e header X-Auth-Token

Parametri

Parametro Obbligatorio Tipo Formato Descrizione
amount Intero Totale dell'ordine o del prodotto, in centesimi di €
instalments 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."
         ]
     }
}