Skip to main content

Incasso

Descrizione

Consente di ricevere un pagamento attraverso il servizio di TS Pay; chiamando l'endpoint link2pay si riceverà un url al quale sarà possibile fare un pagamento.

  • Richiesta pagamento

Endpoint attualmente in ambiente di TEST

[POST] /api/v1/{itemUuid}/link2pay

Il parametro itemUuid corrisponde all'identificativo dell'azienda con per la quale si sta facendo la richiesta.

Nel corpo della richiesta, in particolare abbiamo:

  • template: contenente il testo ed eventualmente il logo da visualizzare nella pagina del pagamento generata e raggiungibile al link restituito in risposta
  • callbackUrl: si tratta di un URL che l'applicativo mette a disposizione di TS Pay per ottenere le notifiche dello stato del pagamento
  • sourceTypes: che può essere carta di credito, SDD o entrambi (default)
  • amount: l'importo da pagare espresso come numero intero in cui le ultime due cifre compongono la parte decimale (ad es. 1450 è da considerare come 14,50)
  • externalRef: un riferimento univoco al pagatore, da utilizzare in seguito come elemento di ricerca
  • metadata: elementi di tracciabilità, da utilizzare per la riconciliazione

Il template contiene le parti visualizzate all'interno della pagina di pagamento, ovvero:

Campo Contenuto Esempio
title Ragione sociale merchant TeamSystem S.p.A.
desc Motivazione pagamento Fattura di vendita
paymentRef Estremi della fattura Numero 125/00 del 15/06/2020
logo

Un link all'immagine da visualizzare come logo

  

In risposta l'API fornisce:

  • orderKey: identificativo dell'ordine
  • url: link da utilizzare per eseguire l'operazione
Back to top