# Richiesta di pagamento

#### **Creazione richiesta di pagamento** 

<span data-contrast="auto">Per creare una richiesta di pagamento deve essere invocata l’api </span>[**<span data-contrast="auto">\[POST\] /paymentRequest</span>**<span data-contrast="auto">. </span><span data-ccp-props="{"201341983":0,"335551550":6,"335551620":6,"335559739":160,"335559740":240}"> </span>](https://digital-docs.ts-paas.com/books/payment-container/page/richiesta-di-pagamento "API")

<span data-contrast="auto">Il beneficiario della richiesta deve:</span><span data-ccp-props="{"201341983":0,"335559739":160,"335559740":240}"> </span>

- <span data-contrast="auto">essere iscritto su TS Digital </span><span data-ccp-props="{"134233279":true,"201341983":0,"335559739":160,"335559740":240}"> </span>
- <span data-contrast="auto">coincidere con l’owner della richiesta</span><span data-ccp-props="{"134233279":true,"201341983":0,"335559739":160,"335559740":240}"> </span>
- <span data-contrast="auto">avere servizio banklink dispositivo attivo </span><span data-ccp-props="{"134233279":true,"201341983":0,"335551550":6,"335551620":6,"335559739":160,"335559740":240}"> </span>
- <span data-ccp-props="{"134233279":true,"201341983":0,"335551550":6,"335551620":6,"335559739":160,"335559740":240}"><span style="color: #ffcc00;">|</span> se viene scelta una modalità di pagamento TsPay, aver completato l'onboarding sulla piattaforma</span>

<div id="bkmrk-%C3%88-possibile-inserire">È possibile inserire in una richiesta di pagamento uno o più hubid di fatture che possono essere visualizzate e scaricate in formato pdf.</div><span data-contrast="auto">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. </span><span data-ccp-props="{"201341983":0,"335551550":6,"335551620":6,"335559739":160,"335559740":240}"> </span>

<span data-contrast="auto">È possibile inserire una data di scadenza alla richiesta di pagamento altrimenti verranno aggiunti 180 gg di default alla data dell’ultima rata. </span><span data-ccp-props="{"201341983":0,"335551550":6,"335551620":6,"335559739":160,"335559740":240}"> </span>

<span data-contrast="auto">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). </span><span data-contrast="auto">Inoltre, l’api restituisce anche il token da inserire nelle chiamate di visualizzazione o modifica richiesta. I</span><span data-contrast="auto">l 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.</span><span data-ccp-props="{"201341983":0,"335551550":6,"335551620":6,"335559739":160,"335559740":240}"> </span>

<p class="callout info">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](https://digital-docs.ts-paas.com/books/payment-container/page/informazioni-generali#bkmrk-urls-ui)</p>

<span data-contrast="auto">Una volta effettuato il pagamento su tspay, la richiesta verrà aggiornata con il pagamento saldato per l’intera richiesta o per una singola rata.</span><span data-ccp-props="{"201341983":0,"335551550":6,"335551620":6,"335559739":160,"335559740":240}"> </span>

<span data-contrast="auto">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.</span><span data-ccp-props="{"201341983":0,"335551550":6,"335551620":6,"335559739":160,"335559740":240}"> </span>

<span data-contrast="auto">Per visualizzare l’anteprima dei documenti (formato pdf) inseriti in una richiesta è possibile utilizzare l’api </span>[**<span data-contrast="auto">\[GET\] /paymentRequest/document/{documentId}/preview</span>**](https://digital-docs.ts-paas.com/books/payment-container/page/documenti "Documenti")<span data-contrast="auto">[.](https://digital-docs.ts-paas.com/books/payment-container/page/documenti "Documenti") </span><span data-ccp-props="{"201341983":0,"335551550":6,"335551620":6,"335559739":160,"335559740":240}"> </span>

<span data-contrast="auto">Per effettuare il download dei documenti è possibile tramite l’api </span>[**<span data-contrast="auto">\[GET\]/public/paymentRequest/{token}/documents/{documentId}/download</span>**<span data-contrast="auto">.</span><span data-ccp-props="{"201341983":0,"335559739":160,"335559740":240}"> </span>](https://digital-docs.ts-paas.com/books/payment-container/page/documenti "Documenti")

<div drawio-diagram="184"><img src="https://digital-docs.ts-paas.com/uploads/images/drawio/2022-03/qodwu0A8t5BS9I6Y-drawing-99-1646322571.png" alt=""/></div>

---

#### **<span data-contrast="auto">Disabilitare una richiesta di pagamento</span>**<span data-ccp-props="{"201341983":0,"335559739":160,"335559740":240}"> </span>

<span data-contrast="auto">Per disabilitare un link di una richiesta di pagamento bisogna invocare </span>**<span data-contrast="auto">l’api [\[PATCH\] /paymentRequest/{token}/disable](https://digital-docs.ts-paas.com/books/payment-container/page/richiesta-di-pagamento "Richiesta di pagamento")</span>**<span data-contrast="auto">. Inserire il token che viene restituito in fase di creazione della richiesta. </span><span data-ccp-props="{"201341983":0,"335559739":160,"335559740":240}"> </span>

<span data-contrast="auto">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.</span><span data-ccp-props="{"201341983":0,"335559739":160,"335559740":240}"> </span>

---

#### **<span data-contrast="auto">Visualizzare una richiesta di pagamento</span>**<span data-ccp-props="{"201341983":0,"335559739":160,"335559740":240}"> </span>

<span data-contrast="auto">Per visualizzare una richiesta di pagamento già creata è possibile tramite l’api </span>[**<span data-contrast="auto">\[GET\] /public/paymentRequest/{token}.</span>**<span data-ccp-props="{"201341983":0,"335559739":160,"335559740":240}"> </span>](https://digital-docs.ts-paas.com/books/payment-container/page/richiesta-di-pagamento "Richiesta di pagamento")

<span data-contrast="auto">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.</span><span data-ccp-props="{"201341983":0,"335559739":160,"335559740":240}"> </span>

---

#### **<span data-contrast="auto">Mapping stati Payment Container e </span><span data-contrast="auto">TsPay</span>**

Il mapping tra il servizio Payment Container e TsPay si può riassumere nel seguente schema:

**Richiesta singola** (TsPay *link2Pay*)

PAID -&gt; active

ON\_HOLD -&gt; pending

NOT\_PAID -&gt; error, failed

**Richiesta schedulata** (TsPay *link2Save*)

SCHEDULED -&gt; active (quando avverrà il pagamento alla data di scadenza sarà PAID)

​NOT\_YET\_PAID-&gt; pending

NOT\_PAID ​-&gt; error, failed

​