Completa i dati

Questo endpoint serve a completare la richiesta aggiungendo ulteriori dati del cliente e del documento inviato precedentemente.

Richiesta

Endpoint

Sandbox: https://api.sandbox.soisy.it/api/shops/{shopId}/requests/{fiscalCode}
Produzione: https://api.soisy.it/api/shops/{shopId}/requests/{fiscalCode}

Metodi accettati

PATCH

Autenticazione

Questa API richiede l'autenticazione tramite shopId e header X-Auth-Token.

Prerequisiti

Per accedere a questo endpoint è necessario aver inviato con successo i documenti del cliente.

Parametri

Parametro Obbligatorio Tipo Formato Descrizione
documentOfType Stringa Tipo di documento. Valori consentiti: identity_card, driving_license, passport
documentCode Stringa Numero del documento
documentCity Stringa Città in cui il documento è stato emesso
documentIssueDate Stringa YYYY-MM-DD Data di emissione del documento
documentExpirationDate Stringa YYYY-MM-DD Data di scadenza del documento
iban No Stringa Iban
politicallyExposed Booleano Specifica se l'utente è una Persona Politicamente Esposta (PPE)
usPerson Booleano Specifica se l'utente è un cittadino statunitense
marketing Booleano Specifica se l'utente gradisce ricevere informazioni su offerte commerciali e novità da parte di Soisy
paymentDayOfMonth No Intero Giorno del mese in cui verrà effettuato il pagamento della rata
profession No Stringa Professione dell'utente

Risposta

L'API restituisce un oggetto JSON contenente i valori appena immessi.

Codici HTTP di risposta

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

Risposta valida

{
    "documentOfType": "identity_card",
    "documentCode": "AR123456",
    "documentCity": "Milano",
    "documentIssueDate": "2010-04-23",
    "documentExpirationDate": "2020-04-22",
    "iban": "IT60X0542811101000000123456",
    "politicallyExposed": false,
    "usPerson": false,
    "marketing": true,
    "profession": "carpenter",
    "paymentDayOfMonth": 15,
    "redirectUrl": "http:\/\/shops.soisy.it\/SCOREP85R02C521Z\/randomstring",
}

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
documentOfType Questo valore non dovrebbe essere vuoto.
documentCode Questo valore non dovrebbe essere vuoto.
documentCity Questo valore non dovrebbe essere vuoto.
documentIssueDate Questo valore non è una data valida.
documentExpirationDate Questo valore non è una data valida.
iban Questo valore non è un IBAN (International Bank Account Number) valido.
politicallyExposed Questo valore non dovrebbe essere nullo.
usPerson Questo valore non dovrebbe essere nullo.
marketing Questo valore non dovrebbe essere nullo.

Errore 403

La richiesta inviata contiene delle credenziali non valide. Controlla lo shopId e l'header X-Auth-Token. Trovi maggiori info sulle credenziali nel paragrafo dell'autenticazione.

 {
     "error": "Access denied"
 }

Errore 500

Le risposte con questo codice HTTP indicano che si è verificato un errore di sistema.

{
    "errors": {
        "system": [
            "System error"
        ]
    }
}

Possibilità di redirect

In questa fase puoi decidere se continuare l'integrazione o reindirizzare l'utente alla nostra webapp. Reindirizza il richiedente su Soisy utilizzando il campo redirectUrl, che trovi nel payload di risposta.