Descrizione Flussi
Descrizione dei vari flussi operativi
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
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.
Mapping stati Payment Container e TsPay
Il mapping tra il servizio Payment Container e TsPay si può riassumere nel seguente schema:
Richiesta singola (TsPay link2Pay)
PAID -> active
ON_HOLD -> pending
NOT_PAID -> error, failed
Richiesta schedulata (TsPay link2Save)
SCHEDULED -> active (quando avverrà il pagamento alla data di scadenza sarà PAID)
NOT_YET_PAID-> pending
NOT_PAID -> error, failed
Pagamenti
Sostituzione link di pagamento
Per sostituire un link di pagamento già creato è possibile tramite l’api [PATCH] /public/paymentRequest/{token}/payment/{id}. Permette di generare un nuovo link di pagamento inserendo la modalità e la soluzione di pagamento a cui fare riferimento ma senza modificarne le condizioni.
Pagamento manuale di una richiesta
Per effettuare il pagamento manuale di una richiesta è possibile tramite l’api [POST] /paymentRequest/{token}/manualPayment. Permette di effettuare il pagamento manuale di una o più rate o dell’intera richiesta.
In questo caso, dopo aver proceduto al pagamento, accedendo di nuovo al link della richiesta, risulterà il pagamento come già saldato e sarà possibile selezionare solo le rate non pagate.
Preferenze
Creazione Preferenza
E’ possibile creare una preferenza da applicare alle richieste di pagamento tramite l’api [POST] /preferences/{companyId}.
Nel campo “company id” bisogna inserire lo uuid dell’azienda creditrice/owner della richiesta.
È possibile creare una preferenza su una specifica azienda inserendo:
- i giorni di scadenza che verranno aggiunti alla data di scadenza dell’ultima rata. Se nella richiesta di pagamento è stata inserita una data di scadenza, la preferenza non verrà applicata;
- il nome ed il cognome con i quali inviare la mail ai debitori che poi verranno riportati all'interno dell'intestazione "Inviato per conto di Nome Cognome" con la quale verrà spedita la mail da Payment Container;
- testo personalizzato dall’email con max 400 caratteri; Si possono inserire alcuni placeholder per avere dei valori dinamici e sono i seguenti:
@creditor_description@ > nome/ragione sociale creditore
@creditor_fiscal_code@ > codice fiscale creditore
@creditor_vat_number@ > partita iva creditore
@link@ > link di pagamento
@amount@ > importo totale della Payment Request
@reason@ > causale della Payment Request - metodo di pagamento con i constraints, i quali verranno applicati solo se non sono presenti nella richiesta.
Modifica Preferenza
La modifica di una preferenza precedentemente creata, è possibile tramite l’api [PATCH] /preferences/{companyId}.
Visualizzazione Preferenza
La visualizzazione, di una preferenza creata su una specifica azienda, è possibile invocando l’api [GET] /preferences/{companyId}.
Company Overview
Per verificare la presenza di fatture ricevute, inviate e scartate per una o più aziende a partire da un dato timestamp è possibile invocare api (https://b2bread-api-test.agyo.io/api/v2/items/overview). La stessa API vi permette di fare la stessa cosa anche con Payment Container. È stato aggiunto un nuovo campo specifico lastTimestampPayment
Successivamente al pagamento di una richiesta di pagamento, richiamando l’api [GET]/paymentRequest?ownerId={ownerId}×tamp=1630387427000 è possibile visualizzare le richieste che si sono modificate rispetto a un dato timestamp.