Menu
API - crea richiesta
API - crea richiesta
Crea una richiesta di pagamento sulla piattaforma Soisy.
Richiesta
Endpoint
Sandbox: https://api.sandbox.soisy.it/api/shops/{shopId}/requests
Produzione: https://api.soisy.it/api/shops/{shopId}/requests
Metodi accettati
POST
Autenticazione
Questa API richiede l’autenticazione tramiteshopId e header X-Auth-Token.Prerequisiti
Per accedere a questo endpoint è necessario aver completato con successo la creazione di un ordine.Parametri
| Parametro | Obbligatorio | Tipo | Formato | Descrizione |
|---|---|---|---|---|
| amount | Sì | Intero | Totale da richiedere, in centesimi di € | |
| instalments | Sì | Intero | Numero di rate, da 3 a 60 | |
| privacy | Sì | Booleano | Approvazione dell’informativa privacy da parte dell’utente | |
| marketing | No | Booleano | Approvazione della policy marketing da parte dell’utente | |
| fiscalCode | Sì | Stringa | 16 caratteri | Codice fiscale |
| jobDescription | Sì | Stringa | Tipologia di lavoro. Valori consentiti: student, retired, unemployed, inheritance, entrepreneur, self_employed, seasonal_worker, freelance_professional, employee_open_ended_contract, employee_fixed_term_contract. | |
| actualJobEndingDate | No* | Stringa | MM/YYYY | Data fine lavoro. Obbligatorio se jobDescription è employee_fixed_term_contract |
| vatId | No* | Stringa | 11 caratteri | Partita IVA. Obbligatoria se jobDescription è entrepreneur |
| vatCountry | No* | Stringa | 2 caratteri maiuscoli | Paese partita IVA. Obbligatorio se jobDescription è entrepreneur |
| zeroInterestRate | No | Booleano | Abilita il tasso zero. (#) Se omesso, verrà utilizzato l’impostazione del Canale di Vendita. |
Risposta
L’API restituisce un oggetto JSON.Codici HTTP di risposta
| Codice | Descrizione |
|---|---|
| 201 | Risorsa creata |
| 400 | Errore di sintassi o di dominio |
| 403 | Impossibile autenticare la richiesta |
| 404 | Risorsa non trovata |
| 500 | Errore di sistema |
Risposta valida
L’API restituisce un oggetto JSON contenente i dati della richiesta appena creata. I parametri restituiti sono:
{
"apr": <float>,
"fiscalCode": <stringa>,
"totalRepayment": <intero>,
"instalmentAmount": <intero>,
"zeroInterestRate": <booleano>
"additionalDataNeeded": <booleano>
}
Dove:
| Parametro | Tipo | Descrizione |
|---|---|---|
| apr | Intero | TAEG, in centesimi di € |
| fiscalCode | Stringa | Codice fiscale |
| totalRepayment | Intero | Totale da ripagare, in centesimi di € |
| instalmentAmount | Intero | rata da pagare, in centesimi di € |
| zeroInterestRate | Booleano | Indica se è attivo il tasso zero |
| additionalDataNeeded | Booleano | Indica se sono richieste ulteriori informazioni nelle chiamate di Richiesta approvazione e Invio documenti |
Risposta di errore
L’oggetto JSON restituito in caso di errore varia a seconda del codice HTTP di risposta.Errore 400
Le risposte con questo codice HTTP indicano un errore lato client. La richiesta inviata conteneva un parametro formalmente errato.
{
"errors": {
{parametro}: [
{messaggio}
]
}
}
Di seguito sono elencati gli errori possibili:
| Parametro | Messaggio |
|---|---|
| amount | Questo valore dovrebbe essere compreso tra 5000 e 1500000 |
| privacy | Questo valore dovrebbe essere uguale a “true”. |
| jobDescription | Questo valore non dovrebbe essere vuoto |
| actualJobEndingDate | Formato data non valido. Il corretto formato è il seguente: MM/YYYY |
| vatId | La P.IVA deve essere una stringa |
| Il codice paese della P.IVA deve essere una stringa | |
| Il codice paese della P.IVA non è valido | |
| La P.IVA non è valida per il paese | |
| fiscalCode | Codice fiscale non valido |
| instalments | Il numero di rate deve essere compreso fra 3 e 60 |
Errore 403
La richiesta inviata contiene delle credenziali non valide. Controlla lo shopId e l’headerX-Auth-Token. Trovi maggiori info sulle credenziali nel paragrafo dell’autenticazione.
{
"errors": "Authentication Failed"
}
Errore 409
La richiesta inviata non può essere completata. Maggiori informazioni sono contenuti nel messaggio d’errore.
{
"errors": "messaggio"
}
Errore 500
Le risposte con questo codice HTTP indicano che si è verificato un errore di sistema.
{
"errors": "System error"
}
