API - crea richiesta

Crea una richiesta di pagamento sulla piattaforma Soisy.

				
					Sandbox: https://api.sandbox.soisy.it/api/shops/{shopId}/requests
Produzione: https://api.soisy.it/api/shops/{shopId}/requests
				
			
				
					POST
				
			
Questa API richiede l’autenticazione tramite shopId e header X-Auth-Token. Per accedere a questo endpoint è necessario aver completato con successo la creazione di un ordine.
ParametroObbligatorioTipoFormatoDescrizione
amountInteroTotale da richiedere, in centesimi di €
instalmentsInteroNumero di rate, da 3 a 60
privacyBooleanoApprovazione dell’informativa privacy da parte dell’utente
marketingNoBooleanoApprovazione della policy marketing da parte dell’utente
fiscalCodeStringa16 caratteriCodice fiscale
jobDescriptionStringaTipologia di lavoro. Valori  consentiti: studentretiredunemployedinheritanceentrepreneurself_employed, seasonal_workerfreelance_professionalemployee_open_ended_contractemployee_fixed_term_contract.
actualJobEndingDateNo*StringaMM/YYYYData fine lavoro. Obbligatorio se jobDescription è employee_fixed_term_contract
vatIdNo*Stringa11 caratteriPartita IVA. Obbligatoria se jobDescription è entrepreneur
vatCountryNo*Stringa2 caratteri maiuscoliPaese partita IVA. Obbligatorio se jobDescription è entrepreneur
zeroInterestRateNoBooleanoAbilita il tasso zero. (#) Se omesso, verrà utilizzato l’impostazione del Canale di Vendita.
(*) Questo parametro può essere obbligatorio in certe situazioni. Vedi la colonna descrizione in corrispondenza della voce. (#) Il tasso zero è una opzione che ti consente di non far pagare interessi ai tuoi clienti. Trovi maggiori informazioni sulle nostre FAQ. Per l’attivazione di questa feature, contatta il nostro supporto dedicato ai partner a partner@soisy.it. L’API restituisce un oggetto JSON.
CodiceDescrizione
201Risorsa creata
400Errore di sintassi o di dominio
403Impossibile autenticare la richiesta
404Risorsa non trovata
500Errore di sistema
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:
ParametroTipoDescrizione
aprInteroTAEG, in centesimi di €
fiscalCodeStringaCodice fiscale
totalRepaymentInteroTotale da ripagare, in centesimi di €
instalmentAmountInterorata da pagare, in centesimi di €
zeroInterestRateBooleanoIndica se è attivo il tasso zero
additionalDataNeeded  BooleanoIndica se sono richieste ulteriori informazioni nelle chiamate di Richiesta approvazione e Invio documenti
L’oggetto JSON restituito in caso di errore varia a seconda del codice HTTP di risposta. 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:
ParametroMessaggio
amountQuesto valore dovrebbe essere compreso tra 5000 e 1500000
privacyQuesto valore dovrebbe essere uguale a “true”.
jobDescriptionQuesto valore non dovrebbe essere vuoto
actualJobEndingDate  Formato data non valido. Il corretto formato è il seguente: MM/YYYY
vatIdLa 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
fiscalCodeCodice fiscale non valido
instalmentsIl numero di rate deve essere compreso fra 3 e 60
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.
				
					{
     "errors": "Authentication Failed"
 }
				
			

La richiesta inviata non può essere completata. Maggiori informazioni sono contenuti nel messaggio d’errore.

				
					 {
     "errors": "messaggio"
 }
				
			

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

				
					{
    "errors": "System error"
}
				
			

Ciao!

Siamo on line dal lunedì al venerdì dalle 9.30 alle 12.30 e dalle 14.30 alle 17.30

Scrivici in questi orari, grazie!