Skip to main content

Richiesta di pagamento

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

Creazione richiesta di pagamento

Permette di creare una richiesta di pagamento

1
 
1
[POST] /paymentRequest

Nella request abbiamo:

    creditor: creditore della richiesta di pagamento debtor: debitore della richiesta di pagamento paymentReason: causale di pagamento totalAmount: ammontare totale della richiesta di pagamento availablePaymentPlans: piani di pagamento a disposizione
      type: tipologia di piano (singolo o multiplo) description: descrizione del piano di pagamento installments: rate che compongono il piano di pagamento
        description: descrizione della rata dueDate: scadenza della singola rata amount:  importo della rata availablePaymentMethods: metodi di pagamento a disposizione
          name: metodo di pagamento accettato constraints: minimali e massimali del singolo metodo di pagamento
            minimumAmount: importo minimo per il metodo di pagamento maximumAmount: importo massimo per il metodo di pagamento customizationOptions: opzioni di customizzazione
              logo: logo personalizzato theme: tema personalizzato ownerId: ownerId con identificativo TS Digital del creditore transmitterId: transmitterId con identificativo TS Digital  paymentDocuments: identificativi dei documenti che compongono la richiesta di pagamento dueDate: data di scadenza della richiesta di pagamento

              I constraints sono obbligatori se non vengono definiti nelle Preferenze

              Se un piano di pagamento è definito come SINGLE_INSTALLMENT​ deve contenere una sola rata. Contrariamente se viene definito un MULTIPLE_INSTALLMENTS deve contenere almeno due rate

              Tutte le valute dei vari importi devono coincidere

              Nella response l'API ritorna:

                id: identificativo univoco della richiesta di pagamento creata

                token: identificativo da utilizzare nelle altre chiamate API per fare riferimento alla richiesta di pagamento in oggetto

                url: link per visualizzare la richiesta di pagamento tramite UI Payment Container e successivamente effettuare dei pagamenti

                 

                Disabilitare richiesta di pagamento

                Permette di disabilitare una richiesta di pagamento precedentemente creata

                1
                 
                1
                [PATCH] /paymentRequest/{token}/disable

                Nella response l'API ritorna:

                  id: identificativo univoco della richiesta di pagamento disabilitata

                  token: identificativo token della richiesta di pagamento disabilitata

                  url: link disabilitato

                   

                  Visualizzare richiesta di pagamento

                  Permette di creare una richiesta di pagamento

                  1
                   
                  1
                  [GET] /public/paymentRequest/{token}

                  Nella response l'API ritorna:

                  • token:
                      token della richiesta di pagamento
                    creditor: creditore della richiesta di pagamento
                    debtor: debitore della richiesta di pagamento paymentReason: causale di pagamento totalAmount: ammontare totale della richiesta di pagamento availablePaymentPlans: piani di pagamento a disposizione
                      type: tipologia di piano (singolo o multiplo) description: descrizione del piano di pagamento installments: rate che compongono il piano di pagamento
                        description: descrizione della rata dueDate: scadenza della singola rata amount:  importo della rata availablePaymentMethods: metodi di pagamento a disposizione
                          name: metodo di pagamento accettato constraints: minimali e massimali del singolo metodo di pagamento
                            minimumAmount: importo minimo per il metodo di pagamento maximumAmount: importo massimo per il metodo di pagamento customizationOptions: opzioni di customizzazione
                              logo: logo personalizzato theme: tema personalizzato ownerId: ownerId con identificativo TS Digital del creditore transmitterId: transmitterId con identificativo TS Digital status: stato della richiesta di pagamento
                              paymentDocuments: identificativi dei documenti che compongono la richiesta di pagamento dueDate: data di scadenza della richiesta di pagamento


                              96
                               
                              1
                              {
                              2
                              22
                              26
                              44
                              59
                               
                              66
                              68
                                "status": "PAID",
                              69
                                "payments": [
                              70
                                  {
                              71
                                    "id": "string",
                              72
                                    "amount": {
                              73
                                      "currency": "string",
                              74
                                      "amount": "string"
                              75
                                    },
                              76
                                    "paymentMethodName": "TS_PAY_BANK_TRANSFER",
                              77
                                    "paymentPlanId": "string",
                              78
                                    "installmentIds": [
                              79
                                      "string"
                              80
                                    ],
                              81
                                    "status": "NOT_YET_PAID",
                              82
                                    "createdAt": "2021-08-23T12:59:46.621Z",
                              83
                                    "link": "string"
                              84
                                  }
                              85
                                ],
                              86
                                "createdAt": "2021-08-23T12:59:46.621Z",
                              87
                                "paymentDocuments": [
                              88
                                  {
                              89
                                    "type": "AGYO_INVOICE",
                              90
                                    "description": "string",
                              91
                                    "downloadUrl": "string",
                              92
                                    "previewUrl": "string"
                              93
                                  }
                              94
                                ],
                              95
                                "dueDate": "2021-08-23T12:59:46.621Z"
                              96
                              }

                               

                               

                              Back to top