Skip to main content

Incasso

Fattura attiva

Descrizione

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

Richiesta link per effetture un pagamento

[POST] /{itemId}/link2pay

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
    • title titolo, generalmente usato per indicare la ragione sociale del merchant (es: "TeamSystem S.p.A.")
    desc motivazione del pagamento (es: "Fattura di vendita") paymentRef estremi della fattura (es: "Numero 123 del 15/06/2020") logo link all'immagine da visualizzare come logo callbackUrl siurl trattacui di un URL chereindirizzare l'applicativoutente metteuna avolta disposizionecompletata dil'operazione. TS Pay per ottenere le notifiche dello stato del pagamentofacoltativo sourceTypes chesorgenti puòdi esserepagamento accettate: carta di credito, SDD o entrambi (default) maxPaymentsNumber numero massimo di pagamenti consentiti (0=illimitato) 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

    IlNella response l'API fornisce:

      orderKey identificativo dell'ordine url link da utilizzare per eseguire l'operazione 
      [POST] /{itemId}/link2save

      Nella request in particolare abbiamo:

        template contienecontenente leil partitesto visualizzateed all'internoeventualmente dellail logo da visualizzare nella pagina didel pagamento,pagamento ovvero:generata
        e raggiungibile al Campolink Contenutorestituito Esempioin risposta
        • title
        Ragionetitolo, generalmente usato per indicare la ragione sociale del merchant (es: "TeamSystem S.p.A.") desc motivazione desc Motivazionedel pagamento (es: "Fattura di venditavendita") paymentRef paymentRef Estremiestremi della fattura (es: "Numero 125/00123 del 15/06/20202020") logo

        Un link all'immagine da visualizzare come logo

          callbackUrl url cui reindirizzare l'utente una volta completata l'operazione. facoltativo sourceTypes sorgenti di pagamento accettate: carta di credito, SDD o entrambi (default) maxSourceNumber numero massimo di sorgenti memorizzabili (0=illimitato, default=1) maxAmount l'importo massimo per gli addebiti, inteso come cumulativo, espresso come numero intero in cui le ultime due cifre compongono la parte decimale (ad es. 1450 è da considerare come 14,50) contextId il contesto a cui la memorizzazione della sorgente si applica, quindi nel caso specifico la fattura externalRef un riferimento univoco al pagatore, da utilizzare in seguito come elemento di ricerca metadata elementi di tracciabilità, da utilizzare per la riconciliazione

        Nella response l'API fornisce:

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

        Esito pagamanto

        Da utilizzare per conoscere tutti i dettagli dell'addebito.

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

        I parametri richiesti sono:

        Back to top