Skip to main content

Descrizione

 

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  

È 

È possibile inserire in una richiesta di pagamento uno o più documentihubid di fatture che possono essere visualizzatiessere e scaricati 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 tspay. 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. Il testo della mail è possibile personalizzarlo attraverso le preferenze. 

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.  

 

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. 

 

 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 

 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; 
  • metodo di pagamento con i constraints, i quali verranno applicati solo se non sono presenti nella richiesta. 

 Per modificare una preferenza precedentemente creata è possibile tramite l’api [PATCH] /preferences/{companyId}.  

 Per visualizzare una preferenza creata su una specifica azienda invocare l’api [GET] /preferences/{companyId}.  

 

Lista delle richieste modificate  

 Per visualizzare la lista delle richieste che si sono modificate per un determinato owner e rispetto a un timestamp invocare l’api [GET]/paymentRequest?ownerId={ownerId}&timestamp=1630387427000. 

 

Back to top