Skip to main content

Pagamento

Il path parameter token è l'identificativo univoco risultante dalla creazione di una Payment Request

Creazione link di pagamento

Permette di creare un link di pagamento facendo riferimento ad una payment request precedentemente configurata

[POST] /public/paymentRequest/{token}/pay

Nella request abbiamo:

  • paymentMethodName: metodo di pagamento da utilizzare
  • paymentPlanId: identificativo del piano di pagamento da pagare
  • installmentIds: identificativi delle rate del piano di pagamento da pagare
  • langLocale: lingua da utilizzare
  • scheduled: booleano per indicare se il pagamento dovrà essere immediato o schedulato (default: false)

Nella response l'API ritorna:

  • id: identificativo univoco del pagamento creato
  • link: link di pagamento verso la piattaforma di riferimento

 

Permette di modificare le configurazioni di un link di pagamento precedentemente configurato e non ancora pagato

[PATCH] /public/paymentRequest/{token}/payment

Nella request abbiamo:

  • paymentMethodName: metodo di pagamento da utilizzare
  • paymentPlanId: identificativo del piano di pagamento da pagare
  • installmentIds: identificativi delle rate del piano di pagamento da pagare
  • langLocale: lingua da utilizzare

Nella response l'API ritorna:

  • id: identificativo univoco del pagamento creato
  • link: link di pagamento verso la piattaforma di riferimento

 

Richiesta pagamento manuale

Permette di segnalare un pagamento come effettuato anche senza passare attraverso un iter di pagamento di Payment Container

[POST] /paymentRequest/{token}/manualPayment ?

Nella request abbiamo:

  • paymentMethodName: metodo di pagamento utilizzato per pagare
  • paymentPlanId: identificativo del piano di pagamento pagato
  • installmentIds: identificativi delle rate del piano di pagamento pagato

Nella response l'API ritorna:

  • id: identificativo univoco del pagamento creato
  • amount: ammontare del pagamento effettuato
  • paymentMethodName: metodo di pagamento utilizzato
  • paymentPlanId: identificativo del piano di pagamento pagato
  • installmentIds: identificativi delle rate del piano di pagamento pagato
  • status: stato per il pagamento effettuato 
  • createdAt: data di creazione del pagamento