Incasso

Fattura attiva

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

- link2pay

Endpoint attualmente in ambiente di TEST

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

Genera un link per ricevere un pagamento attraverso il servizio di TS Pay.

Il

[POST] parametro itemUuid corrisponde all'identificativo dell'azienda con per la quale si sta facendo la richiesta./{itemUuid}/link2pay

Nel corpo della richiesta,Nella request 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 Nella response l'API fornisce:

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

Esito pagamanto - link2pay

Da utilizzare per conoscere tutti i dettagli dell'addebito.

[GET] /{itemUuid}/charges/orders/{orderKey}

I parametri richiesti sono:

orderKey path variable - key dell'ordine, ritornato dalla chiamata alla creazione della richiesta di pagamento.