API callback
API callback
Una richiesta di pagamento su Soisy può assumere diversi stati.
Oltre a ricevere gli aggiornamenti di stato via email, puoi ricevere le notifiche di aggiornamento come chiamate POST utilizzando il parametro callbackUrl nella chiamata di creazione di un ordine. Questo parametro dovrà contenere l’URL valido di una risorsa su un tuo server.
Il contenuto è inviato in formato application/x-www-form-urlencoded.
Attenzione! Assicurati che il tuo sistema o il tuo e-commerce sia in grado di accettare le chiamate con questo formato. E-commerce come Magento 2 non accettano il formato application/x-www-form-urlencoded ed è necessario agire diversamente. Se hai bisogno di supporto contattaci a: supporto@soisy.it
Il contenuto della chiamata è il seguente:
{
"eventId": {eventId},
"eventMessage": {eventMessage},
"eventDate": {date},
"orderToken": {token},
"orderReference": {orderReference}
}
Il campo {token} ti darà il riferimento Soisy identificativo del pagamento, mentre {orderReference} è il tuo codice di rifermento interno, che ci hai inviato nella chiamata API.{eventId} e {eventMessage} potranno conterere, a seconda dello stato, i seguenti valori:
| Stato | Descrizione (per ambiente) |
|---|---|
| Richiesta approvata eventId: LoanWasApprovedeventMessage: loan approved | Produzione: Il richiedente ha superato la pre-approvazione automatica dei nostri sistemi nel funnel Soisy e sta proseguendo con l’immissione dei propri dati. Sandbox: Come in produzione. |
| Richiesta completata eventId: RequestCompletedeventMessage: waiting for verification | Produzione: Il richiedente ha completato il processo di richiesta e ora sta attendendo le verifiche in capo ai nostri operatori. Sandbox: Come in produzione. |
| In attesa di finanziamento eventId: LoanWasVerifiedeventMessage: waiting for disbursement | Produzione: La richiesta di pagamento rateale è stata approvata da un operatore. Il pagamento verrà finanziato. Sandbox: Generata manualmente dallo sviluppatore o dal supporto clienti Soisy. |
| Finanziato eventId: LoanWasDisbursedeventMessage: payment received | Produzione: La richiesta di pagamento rateale viene finanziata definitivamente in un processo che viene eseguito la notte successiva all’evento Sandbox: Generata manualmente dallo sviluppatore o dal supporto clienti Soisy. |
| Annullato eventId: UserWasRejectedeventMessage: payment failed | Produzione: La richiesta di pre-approvazione del pagamento rateale è stata rifiutata dai nostri sistemi automatici. Sandbox: Come in produzione. |
| Annullato eventId: UserWasRejectedeventMessage: documents check KO | Produzione: Soisy, dopo le opportune verifiche, ha rifiutato i dati o i documenti relativi al cliente. Sandbox: Generata manualmente dallo sviluppatore o dal supporto clienti Soisy. |
La sola callback
LoanWasDisbursed conterrà un ulteriore campo nel payload, amount, che comunicherà il totale definitivo di quell’ordine (che potrebbe cambiare in fase di richiesta concordato con ambedue le parti: e-commerce e cliente) espresso in centesimi di euro. Il payload in questo caso sarà il seguente:
{
"eventId": {eventId},
"eventMessage": {eventMessage},
"eventDate": {date},
"amount": {amount}
"orderToken": {token},
"orderReference": {orderReference}
}
Testing
Qui si trova il paragrafo che spiega nel dettaglio come effettuare test autonomi sull’endpoint di callback.
Qualora si dovesse contattare il supporto clienti Soisy per richiedere la generazione di un evento in modalità sandbox, assicurarsi di comunicare al supporto il token di ordine identificativo per la richiesta di pagamento interessata.
N.B: Il supporto clienti Soisy potrebbe prioritizzare ticket più urgenti delle richieste di generazione callback. Si consiglia quindi sempre di generarsi autonomamente le callback e di contattare il supporto clienti in caso di roadblock tecnico.
