Questa API ti consente di creare un ordine sulla nostra piattaforma.
Questo consente di comunicare alla nostra piattaforma, con una semplice chiamata POST, i dati relativi all’ordine fatto dal cliente sul tuo e-commerce, ad esempio il totale dell’ordine, il nome e il cognome del cliente, più altre opzioni avanzate. Tale chiamata restituirà un token identificativo del pagamento e un link di redirect.
Sandbox: https://api.sandbox.soisy.it/api/shops/{shopId}/orders
Produzione: https://api.soisy.it/api/shops/{shopId}/orders
POST
Questa API richiede l’autenticazione tramite shopId
e header X-Auth-Token
.
Parametro | Richiesto | Tipo | Formato | Descrizione |
---|---|---|---|---|
No | Stringa | Un indirizzo email valido | ||
firstname | No | Stringa | Nome dell’utente | |
lastname | No | Stringa | Cognome dell’utente | |
amount | Si | Intero | Totale dell’ordine, in centesimi di € | |
instalments | No | Intero | Il numero di rate, compreso fra 3 e 36. Se il parametro viene omesso, il richiedente potrà scegliere il numero di rate una volta atterrato sulla nostra webapp. Se il parametro viene valorizzato, invece, il numero di rate sarà fisso e non modificabile dal richiedente. | |
fiscalCode | No | Stringa | 16 caratteri | Codice fiscale |
mobilePhone | No | Stringa | Numero di cellulare, senza prefisso internazionale | |
city | No | Stringa | Città (Comune di residenza o di domicilio) | |
province | No | Stringa | 2 caratteri maiuscoli | Provincia. Esempio: MI |
address | No | Stringa | Via. Esempio Via Roma , senza virgole né numero civico | |
civicNumber | No | Stringa | Numero civico | |
postalCode | No | Stringa | 5 cifre | CAP. Esempio: 20100 |
zeroInterestRate | No | Booleano | Abilita il tasso zero.(*) Se omesso, verrà utilizzata l’impostazione di default del tuo negozio. | |
successUrl | No | Stringa | URL | URL sul tuo sito, verso il quale reindirizzare l’utente in caso di pagamento andato a buon fine |
errorUrl | No | Stringa | URL | URL sul tuo sito, verso il quale reindirizzare l’utente in caso di errore, rifiuto del pagamento o abbandono dell’utente |
callbackUrl | No | Stringa | URL | URL di un tuo server per le chiamate di callback automatizzate. |
orderReference | No | String | Codice di riferimento dell’ordine dell’ecommerce o altro riferimento |
(*) Il tasso zero è una opzione che ti consente di non far pagare interessi ai tuoi clienti. Trovi maggiori informazioni sulle nostre FAQ. Per più info in merito a questa feature, contatta il nostro supporto dedicato ai partner a partner@soisy.it.
L’API restituisce un oggetto JSON.
Codice | Descrizione |
---|---|
200 | Richiesta completata con successo |
403 | Impossibile autenticare la richiesta |
404 | Risorsa non trovata |
500 | Errore di sistema |
L’oggetto JSON restituito in caso di successo contiene il token associato all’ordine e un link utilizzabile per il redirect dell’utente alla nostra webapp.
{
"token":
"redirectUrl":
}
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 alcuni errori possibili:
Parametro | Messaggio |
---|---|
Questo valore non è un indirizzo email valido. | |
amount | Questo valore dovrebbe essere compreso tra 5000 e 1500000 |
fiscalCode | Codice fiscale non valido |
address | La combinazione di address, city, province, civicNumber e postalCode per ‘{address}’ non è valida. Esempio valido: via Dei Plauti 2, 10100 Milano (MI) |
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"
}
Le risposte con questo codice HTTP indicano che si è verificato un errore di sistema.
{
"errors": {errorMessage}
}
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.
Copyright 2023 SOISY S.p.A. - Sede Legale: Piazzale Libia, 1 - 20135 Milano
Indirizzo di posta elettronica certificata: postmaster@pec.soisy.eu - sito internet: www.soisy.it
Capitale sociale euro 391.620 i.v.
Codice Fiscale, Partita IVA e Numero di Iscrizione nel Registro delle Imprese di Milano-Monza-Brianza-Lodi: 08946260968
Istituto di Pagamento sottoposto al controllo ed alla vigilanza di Banca d’Italia e iscritto all’Albo IP ex art. 114 septies TUB: numero di iscrizione albo 78 e codice meccanografico 36060
Società appartenente al Gruppo Bancario Mediobanca iscritto all’Albo dei Gruppi Bancari
Socio unico: Compass Banca S.p.A.
Direzione e coordinamento: Mediobanca S.p.A.
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!