Richiesta di pagamento

Creazione richiesta di pagamento

Per creare una richiesta di pagamento deve essere invocata l’api [POST] /paymentRequest.

Il beneficiario della richiesta deve:

essere iscritto su TS Digital
coincidere con l’owner della richiesta
avere servizio banklink dispositivo attivo
| se viene scelta una modalità di pagamento TsPay, aver completato l'onboarding sulla piattaforma

È possibile inserire in una richiesta di pagamento uno o più hubid di fatture che possono essere visualizzate e scaricate in formato pdf.

In fase di creazione della richiesta, il beneficiario può scegliere una o più soluzioni di pagamento tra cui “paga totale” o “paga a rate”. La request deve avere definiti i metodi di pagamento che sono iban e/o carta. Ciascun metodo può avere dei constraints ovvero delle condizioni per cui il metodo può essere attivo.

È possibile inserire una data di scadenza alla richiesta di pagamento altrimenti verranno aggiunti 180 gg di default alla data dell’ultima rata.

L’api restituisce un link per poter accedere alla richiesta, seguire l’iter e procedere al pagamento su un gateway di pagamento esterno (ad oggi TS Pay è l'unica integrazione). Inoltre, l’api restituisce anche il token da inserire nelle chiamate di visualizzazione o modifica richiesta. Il link della richiesta di pagamento viene inviato per e-mail al debitore se impostata la relativa mail. Il testo della mail è possibile personalizzarlo attraverso le preferenze.

Il link alla UI Payment Container è sempre ottenibile tramite il token restituito ed è così composto: https://url_ui_payment_container/{token}. URLs per i vari ambienti li potete trovare qui

Una volta effettuato il pagamento su tspay, la richiesta verrà aggiornata con il pagamento saldato per l’intera richiesta o per una singola rata.

Il debitore può comunicare di aver effettuato il pagamento tramite altre modalità diverse da tspay, selezionando in richiesta “pagamento già effettuato”, in questo caso la richiesta verrà aggiornata in “pagata” quando il creditore confermerà l’avvenuto pagamento.

Per visualizzare l’anteprima dei documenti (formato pdf) inseriti in una richiesta è possibile utilizzare l’api [GET] /paymentRequest/document/{documentId}/preview.

Per effettuare il download dei documenti è possibile tramite l’api [GET]/public/paymentRequest/{token}/documents/{documentId}/download.

Disabilitare una richiesta di pagamento

Per disabilitare un link di una richiesta di pagamento bisogna invocare l’api [PATCH] /paymentRequest/{token}/disable. Inserire il token che viene restituito in fase di creazione della richiesta.

Accedendo al link disabilitato non è possibile effettuare nessuna operazione. Se il debitore procede al pagamento durante la disabilitazione del link, la richiesta è ritenuta pagata. Quindi accedendo al nuovo link non potrà effettuare il pagamento già effettuato.

Visualizzare una richiesta di pagamento

Per visualizzare una richiesta di pagamento già creata è possibile tramite l’api [GET] /public/paymentRequest/{token}.

L’api restituisce tutte le informazioni inserite nella richiesta, compresa la ragione sociale e il logo dell’azienda creditrice. Inoltre, è possibile visualizzare lo stato dei pagamenti (paid/notpaid) delle singole rate.