Primitive

PreviousGestione evoluta commissioni NextFunzionalità deprecate

Last updated 14 days ago

Per la gestione degli errori fare riferimento a .

I campi contrassegnati con﹡sono obbligatori

Per i dettagli https://github.com/pagopa/pagopa-api/tree/SANP3.8.0

paVerifyPaymentNotice

POST

Request Body

Name

Type

Description

  <soapenv:Envelope>
    <soapenv:Header />
    <soapenv:Body>
      <nod:paVerifyPaymentNoticeReq>
        <idPA>77777777777</idPA>
        <idBrokerPA>77777777777</idBrokerPA>
        <idStation>77777777777_01</idStation>
        <qrCode>
          <fiscalCode>77777777777</fiscalCode>
          <noticeNumber>311111111112222222</noticeNumber>
        </qrCode>
      </nod:paVerifyPaymentNoticeReq>
    </soapenv:Body>
  </soapenv:Envelope>

<soapenv:Envelope>
  <soapenv:Header />
  <soapenv:Body>
    <paf:paVerifyPaymentNoticeRes>
      <outcome>OK</outcome>
      <paymentList>
        <paymentOptionDescription>
          <amount>30.00</amount>
          <options>EQ</options>
          <dueDate>2021-12-31</dueDate>
          <detailDescription>test</detailDescription>
          <allCCP>false</allCCP>
        </paymentOptionDescription>
      </paymentList>
      <paymentDescription>payment</paymentDescription>
      <fiscalCodePA>77777777777</fiscalCodePA>
      <companyName>company EC</companyName>
      <officeName>office EC</officeName>
    </paf:paVerifyPaymentNoticeRes>
  </soapenv:Body>
</soapenv:Envelope>

paGetPayment

paGetPayment versione 1

POST

Request Body

Name

Type

Description

<soapenv:Envelope>
    <soapenv:Body>
      <pafn:paGetPaymentReq>
        <idPA>77777777777</idPA>
        <idBrokerPA>77777777777</idBrokerPA>
        <idStation>77777777777_01</idStation>
        <qrCode>
          <fiscalCode>77777777777</fiscalCode>
          <noticeNumber>311111111112222222</noticeNumber>
        </qrCode>
        <amount>30.00</amount>
      </pafn:paGetPaymentReq>
    </soapenv:Body>
  </soapenv:Envelope>

<soapenv:Envelope>
  <soapenv:Header />
  <soapenv:Body>
    <paf:paGetPaymentRes>
      <outcome>OK</outcome>
      <data>
        <creditorReferenceId>11111111112222222</creditorReferenceId>
        <paymentAmount>30.00</paymentAmount>
        <dueDate>2021-12-31</dueDate>
        <retentionDate>2021-12-31T23:59:59</retentionDate>
        <lastPayment>0</lastPayment>
        <description>test</description>
        <companyName>company EC</companyName>
        <officeName>office EC</officeName>
        <debtor>
          <uniqueIdentifier>
            <entityUniqueIdentifierType>F</entityUniqueIdentifierType>
            <entityUniqueIdentifierValue>JHNDOE00A01F205N</entityUniqueIdentifierValue>
          </uniqueIdentifier>
          <fullName>John Doe</fullName>
          <streetName>street</streetName>
          <civicNumber>12</civicNumber>
          <postalCode>89020</postalCode>
          <city>city</city>
          <stateProvinceRegion>MI</stateProvinceRegion>
          <country>IT</country>
          <e-mail>john.doe@test.it</e-mail>
        </debtor>
        <transferList>
          <transfer>
            <idTransfer>1</idTransfer>
            <transferAmount>20.00</transferAmount>
            <fiscalCodePA>77777777777</fiscalCodePA>
            <IBAN>IT0000000000000000000000000</IBAN>
            <remittanceInformation>remittanceInformation1</remittanceInformation>
            <transferCategory>0101100IM</transferCategory>
          </transfer>
          <transfer>
            <idTransfer>2</idTransfer>
            <transferAmount>10.00</transferAmount>
            <fiscalCodePA>77777777778</fiscalCodePA>
            <IBAN>IT0000000000000000000000001</IBAN>
            <remittanceInformation>remittanceInformation2</remittanceInformation>
            <transferCategory>0201102IM</transferCategory>
          </transfer>
        </transferList>
        <metadata>
          <mapEntry>
            <key>keytest</key>
            <value>1</value>
          </mapEntry>
        </metadata>
      </data>
    </paf:paGetPaymentRes>
  </soapenv:Body>
</soapenv:Envelope>

paGetPayment versione 2

POST

In questa versione è possibile inserire i metadata in ogni singolo transfer, inoltre è possibile gestire il servizio @e.bollo.

Request Body

Name

Type

Description

<soapenv:Envelope>
    <soapenv:Body>
      <pafn:paGetPaymentReq>
        <idPA>77777777777</idPA>
        <idBrokerPA>77777777777</idBrokerPA>
        <idStation>77777777777_01</idStation>
        <qrCode>
          <fiscalCode>77777777777</fiscalCode>
          <noticeNumber>311111111112222222</noticeNumber>
        </qrCode>
        <amount>30.00</amount>
      </pafn:paGetPaymentReq>
    </soapenv:Body>
  </soapenv:Envelope>

<soapenv:Envelope>
  <soapenv:Header />
  <soapenv:Body>
    <paf:paGetPaymentRes>
      <outcome>OK</outcome>
      <data>
        <creditorReferenceId>11111111112222222</creditorReferenceId>
        <paymentAmount>30.00</paymentAmount>
        <dueDate>2021-12-31</dueDate>
        <retentionDate>2021-12-31T23:59:59</retentionDate>
        <lastPayment>0</lastPayment>
        <description>test</description>
        <companyName>company EC</companyName>
        <officeName>office EC</officeName>
        <debtor>
          <uniqueIdentifier>
            <entityUniqueIdentifierType>F</entityUniqueIdentifierType>
            <entityUniqueIdentifierValue>JHNDOE00A01F205N</entityUniqueIdentifierValue>
          </uniqueIdentifier>
          <fullName>John Doe</fullName>
          <streetName>street</streetName>
          <civicNumber>12</civicNumber>
          <postalCode>89020</postalCode>
          <city>city</city>
          <stateProvinceRegion>MI</stateProvinceRegion>
          <country>IT</country>
          <e-mail>john.doe@test.it</e-mail>
        </debtor>
        <transferList>
          <transfer>
            <idTransfer>1</idTransfer>
            <transferAmount>20.00</transferAmount>
            <fiscalCodePA>77777777777</fiscalCodePA>
            <companyName>company EC</companyName>
            <IBAN>IT0000000000000000000000000</IBAN>
            <remittanceInformation>remittanceInformation1</remittanceInformation>
            <transferCategory>0101100IM</transferCategory>
            <metadata>
              <mapEntry>
                <key>keytest</key>
                <value>1</value>
              </mapEntry>
            </metadata>
          </transfer>
          <transfer>
            <idTransfer>2</idTransfer>
            <transferAmount>10.00</transferAmount>
            <fiscalCodePA>77777777778</fiscalCodePA>
            <companyName>company EC</companyName>
            <IBAN>IT0000000000000000000000001</IBAN>
            <remittanceInformation>remittanceInformation2</remittanceInformation>
            <transferCategory>0201102IM</transferCategory>
          </transfer>
        </transferList>
        <metadata>
          <mapEntry>
            <key>keytest</key>
            <value>1</value>
          </mapEntry>
        </metadata>
      </data>
    </paf:paGetPaymentRes>
  </soapenv:Body>
</soapenv:Envelope>

outcome﹡: il risultato dell'operazione che può contenere i seguenti codici
- OK : operazione eseguita con successo
- KO : operazione terminata con errore
fault: tutti i dettagli dell'errore, da inserire obbligatoriamente in caso di outcome KO
data: tutti i dettagli del pagamento, da inserire obbligatoriamente in caso di outcome OK
- creditorReferenceId﹡: IUV Identificativo Univoco Versamento
- paymentAmount﹡: importo, deve essere uguale alle somme di TransferAmount presenti nella TransferList
- dueDate﹡: indica la data di scadenza del pagamento secondo il formato ISO 8601 [AAAA]-[MM]-[GG]
- retentionDate: timestamp che indica la fine del periodo di ritenzione delle informazioni sul pagamento da parte del Nodo
- lastPayment
- description﹡: testo libero per descrivere l'oggetto del pagamento
- companyName﹡: nome completo dell'EC
- officeName: nome completo dell'ufficio dell'EC
- debtor﹡: individua il debitore a cui si riferisce la posizione debitoria
  - uniqueIdentifier﹡
    entityUniqueIdentifierType﹡
    F : Persona fisica
    G : Persona giuridica
    entityUniqueIdentifierValue﹡: codice fiscale o partita IVA, nel caso non siano disponibili è possibile utilizzare 'ANONIMO'
  - fullName﹡: nome completo del debitore
  - streetName: indirizzo
  - civicNumber: numero civico
  - postalCode: CAP
  - city: citta'
  - stateProvinceRegion: regione
  - country: stato
  - e-mail
- transferList﹡: struttura che contiene i dettagli dei transfer, al momento possono essere inseriti fino a 5 transfer, deve essercene almeno 1
  - transfer﹡
    idTransfer﹡: indice della lista (da 1 a 5)
    transferAmount﹡: importo in euro
    fiscalCodePA﹡: codice fiscale dell'EC
    companyName﹡: nome completo dell'EC
    CHOICE*
    IBAN: IBAN sul quale sarà effettuato il riversamento
    richiestaMarcaDaBollo: i dati della richiesta della marca da bollo
    tipoBollo: tipologia del bollo
    hashDocumento: contiene l’impronta informatica (digest), nel formato base64, del documento informatico o della segnatura di protocollo cui è associata la marca da bollo digitale
    provinciaResidenza: sigla automobilistica della provincia di residenza del soggetto pagatore
    remittanceInformation﹡: motivo del pagamento
    transferCategory﹡: codice tassonomico, composto da Codice tipo Ente Creditore + Progressivo macro area + Codice tipologia servizio + Motivo Giuridico ( ex. 0101002IM )
    metadata: è un campo di archiviazione chiave/valore. I dati saranno inseriti nella receipt (paSendRT)
    mapEntry﹡
    key﹡
    value﹡
- metadata: è un campo di archiviazione chiave/valore. I dati saranno inseriti nella receipt (paSendRT)
  - mapEntry﹡
    key﹡
    value﹡

paSendRT

paSendRT versione 1

POST

Request Body

Name

Type

Description

  <soapenv:Envelope>
    <soapenv:Body>
      <pafn:paSendRTReq>
        <idPA>77777777777</idPA>
        <idBrokerPA>77777777777</idBrokerPA>
        <idStation>77777777777_01</idStation>
        <receipt>
          <receiptId>c110729d258c4ab1b765fe902aae41d6</receiptId>
          <noticeNumber>311111111112222222</noticeNumber>
          <fiscalCode>77777777777</fiscalCode>
          <outcome>OK</outcome>
          <creditorReferenceId>11111111112222222</creditorReferenceId>
          <paymentAmount>30.00</paymentAmount>
          <description>test</description>
          <companyName>company EC</companyName>
          <officeName>office EC</officeName>
          <debtor>
            <uniqueIdentifier>
              <entityUniqueIdentifierType>F</entityUniqueIdentifierType>
              <entityUniqueIdentifierValue>JHNDOE00A01F205N</entityUniqueIdentifierValue>
            </uniqueIdentifier>
            <fullName>John Doe</fullName>
            <streetName>street</streetName>
            <civicNumber>12</civicNumber>
            <postalCode>89020</postalCode>
            <city>city</city>
            <stateProvinceRegion>MI</stateProvinceRegion>
            <country>IT</country>
            <e-mail>john.doe@test.it</e-mail>
          </debtor>
          <transferList>
            <transfer>
              <idTransfer>1</idTransfer>
              <transferAmount>20.00</transferAmount>
              <fiscalCodePA>77777777777</fiscalCodePA>
              <IBAN>IT0000000000000000000000000</IBAN>
              <remittanceInformation>remittanceInformation1</remittanceInformation>
              <transferCategory>0101100IM</transferCategory>
            </transfer>
            <transfer>
              <idTransfer>2</idTransfer>
              <transferAmount>10.00</transferAmount>
              <fiscalCodePA>77777777778</fiscalCodePA>
              <IBAN>IT0000000000000000000000001</IBAN>
              <remittanceInformation>remittanceInformation2</remittanceInformation>
              <transferCategory>0201102IM</transferCategory>
            </transfer>
          </transferList>
          <idPSP>88888888888</idPSP>
          <pspFiscalCode>88888888888</pspFiscalCode>
          <pspPartitaIVA>88888888888</pspPartitaIVA>
          <PSPCompanyName>PSP name</PSPCompanyName>
          <idChannel>88888888888_01</idChannel>
          <channelDescription>app</channelDescription>
          <payer>
            <uniqueIdentifier>
              <entityUniqueIdentifierType>F</entityUniqueIdentifierType>
              <entityUniqueIdentifierValue>JHNDOE00A01F205N</entityUniqueIdentifierValue>
            </uniqueIdentifier>
            <fullName>John Doe</fullName>
            <streetName>street</streetName>
            <civicNumber>12</civicNumber>
            <postalCode>89020</postalCode>
            <city>city</city>
            <stateProvinceRegion>MI</stateProvinceRegion>
            <country>IT</country>
            <e-mail>john.doe@test.it</e-mail>
          </payer>
          <paymentMethod>creditCard</paymentMethod>
          <fee>2.00</fee>
          <paymentDateTime>2021-10-01T17:48:22</paymentDateTime>
          <applicationDate>2021-10-01</applicationDate>
          <transferDate>2021-10-02</transferDate>
          <metadata>
            <mapEntry>
              <key>keytest</key>
              <value>1</value>
            </mapEntry>
          </metadata>
          <standin>false</standin>
        </receipt>
      </pafn:paSendRTReq>
    </soapenv:Body>
  </soapenv:Envelope>

<soapenv:Envelope>
  <soapenv:Body>
    <paf:paSendRTRes>
      <outcome>OK</outcome>
    </paf:paSendRTRes>
  </soapenv:Body>
</soapenv:Envelope

paSendRT versione 2

POST

In questa versione possono essere inseriti i metadata in ogni singolo transfer della receipt, inoltre sono gestite le informazioni ricavate da Gestione evoluta commissionie il servizio @e.bollo.

Request Body

Name

Type

Description

  <soapenv:Envelope>
    <soapenv:Body>
      <pafn:paSendRTReq>
        <idPA>77777777777</idPA>
        <idBrokerPA>77777777777</idBrokerPA>
        <idStation>77777777777_01</idStation>
        <receipt>
          <receiptId>c110729d258c4ab1b765fe902aae41d6</receiptId>
          <noticeNumber>311111111112222222</noticeNumber>
          <fiscalCode>77777777777</fiscalCode>
          <outcome>OK</outcome>
          <creditorReferenceId>11111111112222222</creditorReferenceId>
          <paymentAmount>30.00</paymentAmount>
          <description>test</description>
          <companyName>company EC1</companyName>
          <officeName>office EC</officeName>
          <debtor>
            <uniqueIdentifier>
              <entityUniqueIdentifierType>F</entityUniqueIdentifierType>
              <entityUniqueIdentifierValue>JHNDOE00A01F205N</entityUniqueIdentifierValue>
            </uniqueIdentifier>
            <fullName>John Doe</fullName>
            <streetName>street</streetName>
            <civicNumber>12</civicNumber>
            <postalCode>89020</postalCode>
            <city>city</city>
            <stateProvinceRegion>MI</stateProvinceRegion>
            <country>IT</country>
            <e-mail>john.doe@test.it</e-mail>
          </debtor>
          <transferList>
            <transfer>
              <idTransfer>1</idTransfer>
              <transferAmount>20.00</transferAmount>
              <fiscalCodePA>77777777777</fiscalCodePA>
              <companyName>company EC1</companyName>
              <IBAN>IT0000000000000000000000000</IBAN>
              <remittanceInformation>remittanceInformation1</remittanceInformation>
              <transferCategory>0101100IM</transferCategory>
              <metadata>
                <mapEntry>
                  <key>keytest</key>
                  <value>1</value>
                </mapEntry>
              </metadata>            
            </transfer>
            <transfer>
              <idTransfer>2</idTransfer>
              <transferAmount>10.00</transferAmount>
              <fiscalCodePA>77777777778</fiscalCodePA>
              <companyName>company EC2</companyName>
              <IBAN>IT0000000000000000000000001</IBAN>
              <remittanceInformation>remittanceInformation2</remittanceInformation>
              <transferCategory>0201102IM</transferCategory>
            </transfer>
          </transferList>
          <idPSP>88888888888</idPSP>
          <pspFiscalCode>88888888888</pspFiscalCode>
          <pspPartitaIVA>88888888888</pspPartitaIVA>
          <PSPCompanyName>PSP name</PSPCompanyName>
          <idChannel>88888888888_01</idChannel>
          <channelDescription>app</channelDescription>
          <payer>
            <uniqueIdentifier>
              <entityUniqueIdentifierType>F</entityUniqueIdentifierType>
              <entityUniqueIdentifierValue>JHNDOE00A01F205N</entityUniqueIdentifierValue>
            </uniqueIdentifier>
            <fullName>John Doe</fullName>
            <streetName>street</streetName>
            <civicNumber>12</civicNumber>
            <postalCode>89020</postalCode>
            <city>city</city>
            <stateProvinceRegion>MI</stateProvinceRegion>
            <country>IT</country>
            <e-mail>john.doe@test.it</e-mail>
          </payer>
          <paymentMethod>creditCard</paymentMethod>
          <fee>2.00</fee>
          <primaryCiIncurredFee>0.50</primaryCiIncurredFee>
          <idBundle>1</idBundle>
          <idCiBundle>2</idCiBundle>
          <paymentDateTime>2021-10-01T17:48:22</paymentDateTime>
          <applicationDate>2021-10-01</applicationDate>
          <transferDate>2021-10-02</transferDate>
          <metadata>
            <mapEntry>
              <key>keytest</key>
              <value>1</value>
            </mapEntry>
          </metadata>
          <standin>false</standin>
        </receipt>
      </pafn:paSendRTReq>
    </soapenv:Body>
  </soapenv:Envelope>

<soapenv:Envelope>
  <soapenv:Body>
    <paf:paSendRTRes>
      <outcome>OK</outcome>
    </paf:paSendRTRes>
  </soapenv:Body>
</soapenv:Envelope>

verifyPaymentNotice

POST

Request Body

Name

Type

Description

  <soapenv:Envelope>
    <soapenv:Body>
      <nod:verifyPaymentNoticeReq>
        <idPSP>88888888888</idPSP>
        <idBrokerPSP>88888888888</idBrokerPSP>
        <idChannel>88888888888_01</idChannel>
        <password>**********</password>
        <qrCode>
          <fiscalCode>77777777777</fiscalCode>
          <noticeNumber>311111111112222222</noticeNumber>
        </qrCode>
      </nod:verifyPaymentNoticeReq>
    </soapenv:Body>
  </soapenv:Envelope>

<soapenv:Envelope>
  <soapenv:Body>
    <nfpsp:verifyPaymentNoticeRes>
      <outcome>OK</outcome>
      <paymentList>
        <paymentOptionDescription>
          <amount>30.00</amount>
          <options>EQ</options>
          <paymentNote>test</paymentNote>
        </paymentOptionDescription>
      </paymentList>
      <paymentDescription>payment</paymentDescription>
      <fiscalCodePA>77777777777</fiscalCodePA>
      <companyName>company EC</companyName>
      <officeName>office EC</officeName>
      <standin>false</standin>
    </nfpsp:verifyPaymentNoticeRes>
  </soapenv:Body>
</soapenv:Envelope>

verificaBollettino

POST

Request Body

Name

Type

Description

  <soapenv:Envelope>
    <soapenv:Body>
      <nod:verificaBollettinoReq>
        <idPSP>88888888888</idPSP>
        <idBrokerPSP>88888888888</idBrokerPSP>
        <idChannel>88888888888_01</idChannel>
        <password>**********</password>
        <ccPost>012345678912</ccPost>
        <noticeNumber>311111111112222222</noticeNumber>
      </nod:verificaBollettinoReq>
    </soapenv:Body>
  </soapenv:Envelope>

<soapenv:Envelope>
  <soapenv:Body>
    <nfpsp:verificaBollettinoRes>
      <outcome>OK</outcome>
      <paymentBollettinoList>
        <paymentOptionDescription>
          <amount>30.00</amount>
          <options>EQ</options>
          <dueDate>2021-12-31</dueDate>
          <paymentNote>test</paymentNote>
          <allCCP>true</allCCP>
        </paymentOptionDescription>
      </paymentBollettinoList>
      <paymentDescription>payment</paymentDescription>
      <fiscalCodePA>77777777777</fiscalCodePA>
      <noticeNumber>311111111112222222</noticeNumber>
      <companyName>company EC</companyName>
      <officeName>office EC</officeName>
      <standin>false</standin>
    </nfpsp:verificaBollettinoRes>
  </soapenv:Body>
</soapenv:Envelope>

activatePaymentNotice

activatePaymentNotice versione 1

POST

Request Body

Name

Type

Description

  <soapenv:Envelope>
    <soapenv:Body>
      <nod:activatePaymentNoticeReq>
        <idPSP>88888888888</idPSP>
        <idBrokerPSP>88888888888</idBrokerPSP>
        <idChannel>88888888888_01</idChannel>
        <password>**********</password>
        <idempotencyKey>70000000001_100149bdWB</idempotencyKey>
        <qrCode>
          <fiscalCode>77777777777</fiscalCode>
          <noticeNumber>311111111112222222</noticeNumber>
        </qrCode>
        <expirationTime>6000</expirationTime>
        <amount>30.00</amount>
      </nod:activatePaymentNoticeReq>
    </soapenv:Body>
  </soapenv:Envelope>

<soapenv:Envelope>
  <soapenv:Body>
    <nfpsp:activatePaymentNoticeRes>
      <outcome>OK</outcome>
      <totalAmount>30.00</totalAmount>
      <paymentDescription>test</paymentDescription>
      <fiscalCodePA>77777777777</fiscalCodePA>
      <companyName>company EC</companyName>
      <officeName>office EC</officeName>
      <paymentToken>c110729d258c4ab1b765fe902aae41d6</paymentToken>
      <transferList>
        <transfer>
          <idTransfer>1</idTransfer>
          <transferAmount>20.00</transferAmount>
          <fiscalCodePA>77777777777</fiscalCodePA>
          <IBAN>IT0000000000000000000000000</IBAN>
          <remittanceInformation>remittanceInformation1</remittanceInformation>
        </transfer>
        <transfer>
          <idTransfer>2</idTransfer>
          <transferAmount>10.00</transferAmount>
          <fiscalCodePA>77777777778</fiscalCodePA>
          <IBAN>IT0000000000000000000000001</IBAN>
          <remittanceInformation>remittanceInformation2</remittanceInformation>
        </transfer>
      </transferList>
      <creditorReferenceId>11111111112222222</creditorReferenceId>
      <standin>false</standin>
    </nfpsp:activatePaymentNoticeRes>
  </soapenv:Body>
</soapenv:Envelope>

activatePaymentNotice versione 2

POST

In questa versione è possibile far transitare i metadata per ogni payment e in ogni singolo transfer della response, inoltre sono gestite le informazioni ricavate da Gestione evoluta commissioni.

Request Body

Name

Type

Description

  <soapenv:Envelope>
    <soapenv:Body>
      <nod:activatePaymentNoticeReq>
        <idPSP>88888888888</idPSP>
        <idBrokerPSP>88888888888</idBrokerPSP>
        <idChannel>88888888888_01</idChannel>
        <password>**********</password>
        <idempotencyKey>70000000001_100149bdWB</idempotencyKey>
        <qrCode>
          <fiscalCode>77777777777</fiscalCode>
          <noticeNumber>311111111112222222</noticeNumber>
        </qrCode>
        <expirationTime>6000</expirationTime>
        <amount>30.00</amount>
      </nod:activatePaymentNoticeReq>
    </soapenv:Body>
  </soapenv:Envelope>

<soapenv:Envelope>
  <soapenv:Body>
    <nfpsp:activatePaymentNoticeRes>
      <outcome>OK</outcome>
      <totalAmount>30.00</totalAmount>
      <paymentDescription>test</paymentDescription>
      <fiscalCodePA>77777777777</fiscalCodePA>
      <companyName>company EC</companyName>
      <officeName>office EC</officeName>
      <paymentToken>c110729d258c4ab1b765fe902aae41d6</paymentToken>
      <transferList>
        <transfer>
          <idTransfer>1</idTransfer>
          <transferAmount>20.00</transferAmount>
          <fiscalCodePA>77777777777</fiscalCodePA>
          <companyName>Test EC</companyName>
          <IBAN>IT0000000000000000000000000</IBAN>
          <remittanceInformation>remittanceInformation1</remittanceInformation>
          <transferCategory>0101100IM</transferCategory>
          <metadata>
            <mapEntry>
              <key>keytest1</key>
              <value>1</value>
            </mapEntry>
          </metadata>        
        </transfer>
        <transfer>
          <idTransfer>2</idTransfer>
          <transferAmount>10.00</transferAmount>
          <fiscalCodePA>77777777778</fiscalCodePA>
          <companyName>Test EC 2</companyName>
          <IBAN>IT0000000000000000000000001</IBAN>
          <remittanceInformation>remittanceInformation2</remittanceInformation>
          <transferCategory>0201102IM</transferCategory>
        </transfer>
        <metadata>
          <mapEntry>
            <key>keytest2</key>
            <value>2</value>
          </mapEntry>
        </metadata> 
      </transferList>
      <creditorReferenceId>11111111112222222</creditorReferenceId>
      <suggestedUserFee>1.00</suggestedUserFee>
      <suggestedPaFee>0.50</suggestedPaFee>
      <suggestedIdBundle>1</suggestedIdBundle>
      <suggestedIdCiBundle>2</suggestedIdCiBundle>
      <standin>false</standin>
    </nfpsp:activatePaymentNoticeRes>
  </soapenv:Body>
</soapenv:Envelope>

outcome﹡: il risultato dell'operazione che può contenere i seguenti codici
- OK : operazione eseguita con successo
- KO : operazione terminata con errore
fault: tutti i dettagli dell'errore, dato valorizzato solo in caso di outcome KO
totalAmount: rappresenta la somma degli importi dei singoli transfer, dato valorizzato solo in caso di outcome OK
paymentDescription: testo libero per descrivere l'oggetto del pagamento, dato valorizzato solo in caso di outcome OK
fiscalCodePA: codice fiscale dell'EC, dato valorizzato solo in caso di outcome OK
companyName: nome completo dell'EC, dato valorizzato solo in caso di outcome OK
officeName: nome completo dell'ufficio dell'EC
paymentToken: viene generato dal sistema durante la fase di attivazione del pagamento, è l'identificatore di correlazione da abbinare all'attivazione e all'esito del pagamento, dato valorizzato solo in caso di outcome OK
transferList: struttura che contiene i dettagli dei transfer pagamento, al momento i transfer possono essere al massimo 5, dato valorizzato solo in caso di outcome OK
- transfer﹡
  - idTransfer﹡: valori ammessi da 1 a 5
  - transferAmount﹡: importo in euro
  - fiscalCodePA﹡: codice fiscale dell'Ente beneficiario
  - companyName: nome completo dell'EC, dato valorizzato solo in caso di outcome OK
  - IBAN﹡: IBAN sul quale verra riversato l'importo
  - remittanceInformation﹡: testo libero per descrivere l'oggetto del pagamento
  - transferCategory﹡: codice tassonomico, composto da Codice tipo Ente Creditore + Progressivo macro area + Codice tipologia servizio + Motivo Giuridico ( ex. 0101002IM )
  - metadata: è un campo di archiviazione chiave/valore.
    mapEntry﹡
    key﹡
    value﹡
creditorReferenceId: IUV Identificativo Univoco Versamento, dato valorizzato solo in caso di outcome OK
suggestedUserFee: importo della commissione espresso in euro ricavato da Gestione evoluta commissioni
suggestedPaFee: importo della commissione a carico dell'EC espresso in euro ricavato da Gestione evoluta commissioni
suggestedIdBundle: identificativo del pacchetto di Gestione evoluta commissioni
suggestedIdCiBundle: identificativo degli attributi aggiunti dall'EC al pacchetto di Gestione evoluta commissioni
standin: true in caso di pagamento avvenuto in Stand in

sendPaymentOutcome

sendPaymentOutcome versione 1

POST

Request Body

Name

Type

Description

  <soapenv:Envelope>
    <soapenv:Body>
        <nod:sendPaymentOutcomeReq>
          <idPSP>88888888888</idPSP>
          <idBrokerPSP>88888888888</idBrokerPSP>
          <idChannel>88888888888_01</idChannel>
          <password>**********</password>
          <idempotencyKey>70000000001_100149bdWB</idempotencyKey>
          <paymentToken>c110729d258c4ab1b765fe902aae41d6</paymentToken>
          <outcome>OK</outcome>
          <details>
              <paymentMethod>creditCard</paymentMethod>
              <paymentChannel>app</paymentChannel>
              <fee>2.00</fee>
              <payer>
                <uniqueIdentifier>
                    <entityUniqueIdentifierType>F</entityUniqueIdentifierType>
                    <entityUniqueIdentifierValue>JHNDOE00A01F205N</entityUniqueIdentifierValue>
                </uniqueIdentifier>
                <fullName>John Doe</fullName>
                <streetName>street</streetName>
                <civicNumber>12</civicNumber>
                <postalCode>89020</postalCode>
                <city>city</city>
                <stateProvinceRegion>MI</stateProvinceRegion>
                <country>IT</country>
                <e-mail>john.doe@test.it</e-mail>
              </payer>
              <applicationDate>2021-10-01</applicationDate>
              <transferDate>2021-10-02</transferDate>
          </details>
        </nod:sendPaymentOutcomeReq>
    </soapenv:Body>
  </soapenv:Envelope>

<soapenv:Envelope>
  <soapenv:Body>
    <nfpsp:sendPaymentOutcomeRes>
      <outcome>OK</outcome>
    </nfpsp:sendPaymentOutcomeRes>
  </soapenv:Body>
</soapenv:Envelope>

sendPaymentOutcome versione 2

POST

Utilizzata per il pagamento attivato presso il frontend dell'EC, rispetto alla versione 1 permette di inviare l'outcome di più payment tokens contemporaneamente, inoltre sono gestite le informazioni ricavate da Gestione evoluta commissionie il servizio @e.bollo.

Request Body

Name

Type

Description

  <soapenv:Envelope>
    <soapenv:Body>
        <nod:sendPaymentOutcomeReq>
          <idPSP>88888888888</idPSP>
          <idBrokerPSP>88888888888</idBrokerPSP>
          <idChannel>88888888888_01</idChannel>
          <password>**********</password>
          <idempotencyKey>70000000001_100149bdWB</idempotencyKey>
          <paymentTokens>
              <paymentToken>d221820d258c4ab1b765fe902aae6d14</paymentToken>
              <paymentToken>c110729d258c4ab1b765fe902aae41d6</paymentToken>
          </paymentTokens>
          <outcome>OK</outcome>
          <details>
              <paymentMethod>creditCard</paymentMethod>
              <paymentChannel>app</paymentChannel>
              <fee>2.00</fee>
              <primaryCiIncurredFee>0.50</primaryCiIncurredFee>
              <idBundle>1</idBundle>
              <idCiBundle>2</idCiBundle>
              <payer>
                <uniqueIdentifier>
                    <entityUniqueIdentifierType>F</entityUniqueIdentifierType>
                    <entityUniqueIdentifierValue>JHNDOE00A01F205N</entityUniqueIdentifierValue>
                </uniqueIdentifier>
                <fullName>John Doe</fullName>
                <streetName>street</streetName>
                <civicNumber>12</civicNumber>
                <postalCode>89020</postalCode>
                <city>city</city>
                <stateProvinceRegion>MI</stateProvinceRegion>
                <country>IT</country>
                <e-mail>john.doe@test.it</e-mail>
              </payer>
              <applicationDate>2021-10-01</applicationDate>
              <transferDate>2021-10-02</transferDate>
          </details>
        </nod:sendPaymentOutcomeReq>
    </soapenv:Body>
  </soapenv:Envelope>

<soapenv:Envelope>
  <soapenv:Body>
    <nfpsp:sendPaymentOutcomeRes>
      <outcome>OK</outcome>
    </nfpsp:sendPaymentOutcomeRes>
  </soapenv:Body>
</soapenv:Envelope>

pspNotifyPayment

pspNotifyPayment versione 1

POST

Request Body

Name

Type

Description

    <soapenv:Envelope>
      <soapenv:Body>
          <pspfn:pspNotifyPaymentReq>
            <idPSP>88888888888</idPSP>
            <idBrokerPSP>88888888888</idBrokerPSP>
            <idChannel>88888888888_01</idChannel>
            <paymentDescription>test</paymentDescription>
            <fiscalCodePA>77777777777</fiscalCodePA>
            <companyName>company EC</companyName>
            <officeName>office EC</officeName>                        
            <paymentToken>ac6536ab9967401fb6cfa98bef88ccf0</paymentToken>
            <creditorReferenceId>11111111112222222</creditorReferenceId>
            <debtAmount>30.00</debtAmount>
            <transferList>
                <transfer>
                  <idTransfer>1</idTransfer>
                  <transferAmount>20.00</transferAmount>
                  <fiscalCodePA>77777777777</fiscalCodePA>
                  <IBAN>IT0000000000000000000000000</IBAN>
                  <remittanceInformation>info remittance</remittanceInformation>
                </transfer>
                <transfer>
                  <idTransfer>2</idTransfer>
                  <transferAmount>10.00</transferAmount>
                  <fiscalCodePA>77777777778</fiscalCodePA>
                  <IBAN>IT0000000000000000000000001</IBAN>
                  <remittanceInformation>info remittance</remittanceInformation>
                </transfer>
            </transferList>
            
            <!-- dati specifici del canale di pagamento -->
            
            <standin>false</standin>
          </pspfn:pspNotifyPaymentReq>
      </soapenv:Body>
    </soapenv:Envelope>

<soapenv:Envelope>
  <soapenv:Body>
      <psp:pspNotifyPaymentRes>
        <outcome>OK</outcome>
      </psp:pspNotifyPaymentRes>
  </soapenv:Body>
</soapenv:Envelope>

Carta di credito (dismissione 30/04/2023)

<creditCardPayment>
    <rrn>11223344</rrn>
    <outcomePaymentGateway>00</outcomePaymentGateway>
    <totalAmount>31.00</totalAmount>
    <fee>1.00</fee>
    <timestampOperation>2021-07-09T17:06:03</timestampOperation>
    <authorizationCode>123456</authorizationCode>
</creditCardPayment>

Paypal

<paypalPayment> 
    <transactionId>11223344</transactionId>
    <pspTransactionId>00</pspTransactionId>
    <totalAmount>31.00</totalAmount>
    <fee>1.00</fee>
    <timestampOperation>2021-07-09T17:06:03</timestampOperation>
</paypalPayment>

Bancomat Pay

<bancomatpayPayment> 
    <transactionId>11223344</transactionId>
    <outcomePaymentGateway>00</outcomePaymentGateway>
    <totalAmount>31.00</totalAmount>
    <fee>1.00</fee>
    <timestampOperation>2021-07-09T17:06:03</timestampOperation>
    <authorizationCode>123456</authorizationCode>
    <paymentGateway></paymentGateway>
</bancomatpayPayment>

Altri canali di pagamento

<additionalPaymentInformations>
    <metadata>
        <mapEntry>
            <key>keytest</key>
            <value>1</value>
        </mapEntry>
    </metadata>
</additionalPaymentInformations>

pspNotifyPayment versione 2

POST

Utilizzata per il pagamento attivato presso il frontend dell'EC, rispetto alla precedente versione della pspNotifyPayment permette di inviare al PSP una lista di payment, inoltre, le informazioni specifiche del pagamento utilizzato sono inserite nella sezione additionalPaymentInformations che contiene una lista di metadata. E' possibile, inoltre, inserire i metadata per ogni payment e in ogni singolo transfer e gestire il servizio @e.bollo.

Request Body

Name

Type

Description

      <soapenv:Body>
          <pspfn:pspNotifyPaymentV2>
            <idPSP>CIPBITMM</idPSP>
            <idBrokerPSP>13212880150</idBrokerPSP>
            <idChannel>13212880150_02</idChannel>
            <transactionId>99910087308786</transactionId>
            <totalAmount>31.00</totalAmount>
            <fee>1.00</fee>
            <timestampOperation>2033-04-23T18:25:43Z</timestampOperation>
            <paymentList>
              <payment>
                <paymentDescription>test</paymentDescription>
                <fiscalCodePA>77777777777</fiscalCodePA>
                <companyName>company EC</companyName>
                <officeName>office EC</officeName>                        
                <paymentToken>ac6536ab9967401fb6cfa98bef88ccf0</paymentToken>
                <creditorReferenceId>11111111112222222</creditorReferenceId>
                <debtAmount>30.00</debtAmount>
                <transferList>
                  <transfer>
                    <idTransfer>1</idTransfer>
                    <transferAmount>20.00</transferAmount>
                    <fiscalCodePA>77777777777</fiscalCodePA>
                    <companyName>company EC1</companyName>
                    <IBAN>IT0000000000000000000000000</IBAN>
                    <remittanceInformation>info remittance</remittanceInformation>
                    <metadata>
                      <mapEntry>
                        <key>yyyy</key>
                        <value>abcde</value>
                      </mapEntry> 
                    </metadata>
                  </transfer>
                  <transfer>
                    <idTransfer>2</idTransfer>
                    <transferAmount>10.00</transferAmount>
                    <fiscalCodePA>77777777778</fiscalCodePA>
                    <companyName>company EC2</companyName>
                    <IBAN>IT0000000000000000000000001</IBAN>
                    <remittanceInformation>info remittance</remittanceInformation>
                  </transfer>
                </transferList> 
                <metadata>
                  <mapEntry>
                    <key>zzzz</key>
                    <value>g2f3</value>
                  </mapEntry> 
                </metadata>
              </payment>
            </paymentList>                       
            <additionalPaymentInformations>
              <mapEntry>
                <key>xxxx</key>
                <value>1234546</value>
              </mapEntry> 
            </additionalPaymentInformations>
            <standin>false</standin>
          </pspfn:pspNotifyPaymentV2>
      </soapenv:Body>
    </soapenv:Envelope>

<soapenv:Envelope>
  <soapenv:Body>
      <psp:pspNotifyPaymentV2Res>
        <outcome>OK</outcome>
      </psp:pspNotifyPaymentV2Res>
  </soapenv:Body>
</soapenv:Envelope>

demandPaymentNotice

POST

Request Body

Name

Type

Description

<soap:Envelope>
  <soap:Body>
    <ns3:demandPaymentNoticeReq>
      <idPSP>88888888888</idPSP>
      <idBrokerPSP>88888888888</idBrokerPSP>
      <idChannel>88888888888_01</idChannel>
      <password>**********</password>
      <idSoggettoServizio>00003</idServizio>
      <datiSpecificiServizio>Dati del servizio base64 encoded</datiSpecificiServizio>
    </ns3:demandPaymentNoticeReq>
  </soap:Body>
</soap:Envelope>

<soapenv:Envelope>
  <soapenv:Body>
    <ppt:demandPaymentNoticeRes>
      <outcome>OK</outcome>
      <qrCode>
        <fiscalCode>77777777778</fiscalCode>
        <noticeNumber>311111111112222222</noticeNumber>
      </qrCode>
      <paymentList>
        <paymentOptionDescription>
          <amount>30.00</amount>
          <options>EQ</options>
          <paymentNote>test</paymentNote>
        </paymentOptionDescription>
      </paymentList>
      <paymentDescription>payment</paymentDescription>
      <fiscalCodePA>77777777777</fiscalCodePA>
      <companyName>company EC</companyName>
      <officeName>office EC</officeName>
    </ppt:demandPaymentNoticeRes>
  </soapenv:Body>
</soapenv:Envelope>

paDemandPaymentNotice

POST

Request Body

Name

Type

Description

<soapenv:Envelope>
  <soapenv:Body>
    <ppt:paDemandPaymentNoticeReq>
      <idPA>77777777777</idPA>
      <idBrokerPA>77777777777</idBrokerPA>
      <idStation>77777777777_01</idStation>
      <idServizio>00002</idServizio>
      <idSoggettoServizio>00003</idSoggettoServizio>       
      <datiSpecificiServizio>Dati del servizio base64 encoded</datiSpecificiServizio>
    </ppt:paDemandPaymentNoticeReq>
  </soapenv:Body>
</soapenv:Envelope>

  <soapenv:Body>
    <ns5:paDemandPaymentNoticeRes">
      <outcome>OK</outcome>
      <qrCode>
        <fiscalCode>77777777778</fiscalCode>
        <noticeNumber>311111111112222222</noticeNumber>
      </qrCode>
      <paymentList>
        <paymentOptionDescription>
          <amount>30.00</amount>
          <options>EQ</options>
          <paymentNote>test</paymentNote>
        </paymentOptionDescription>
      </paymentList>
      <paymentDescription>payment</paymentDescription>
      <fiscalCodePA>77777777777</fiscalCodePA>
      <companyName>company EC</companyName>
      <officeName>office EC</officeName>
    </ns5:paDemandPaymentNoticeRes>
  </soapenv:Body>
</soapenv:Envelope>

nodoInviaFlussoRendicontazione

POST

Request Body

Name

Type

Description

<soap:Envelope>
    <soap:Body>
        <ns5:nodoInviaFlussoRendicontazione>
            <identificativoPSP>88888888888</identificativoPSP>
            <identificativoIntermediarioPSP>88888888888</identificativoIntermediarioPSP>
            <identificativoCanale>88888888888_01</identificativoCanale>
            <password>**********</password>
            <identificativoDominio>77777777777</identificativoDominio>
            <identificativoFlusso>2021-11-2188888888888-AABB648200001295</identificativoFlusso>
            <dataOraFlusso>2021-11-22T00:37:32</dataOraFlusso>
            <xmlRendicontazione>Flusso di riversamento base64 encoded</xmlRendicontazione>
        </ns5:nodoInviaFlussoRendicontazione>
    </soap:Body>
</soap:Envelope>

<soapenv:Envelope>
    <soapenv:Body>
        <ppt:nodoInviaFlussoRendicontazioneRisposta>
            <esito>OK</esito>
        </ppt:nodoInviaFlussoRendicontazioneRisposta>
    </soapenv:Body>
</soapenv:Envelope>

nodoChiediElencoFlussiRendicontazione

POST

Request Body

Name

Type

Description

<soap:Envelope>
    <soap:Body>
        <ns5:nodoChiediElencoFlussiRendicontazione>
            <identificativoIntermediarioPA>77777777777</identificativoIntermediarioPA>
            <identificativoStazioneIntermediarioPA>77777777777_01</identificativoStazioneIntermediarioPA>
            <password>**********</password>
            <identificativoDominio>77777777777</identificativoDominio>
            <identificativoPSP>88888888888</identificativoPSP>
        </ns5:nodoChiediElencoFlussiRendicontazione>
    </soap:Body>
</soap:Envelope>

<soapenv:Envelope>
    <soapenv:Body>
        <nodoChiediElencoFlussiRendicontazioneResponse>
            <esito>OK</esito>
            <elencoFlussiRendicontazione>
                <totRestituiti>1</totRestituiti>
                <idRendicontazione>
                    <identificativoFlusso>2021-11-2188888888888-AABB648200001295</identificativoFlusso>
                    <dataOraFlusso>2021-11-22T00:37:32</dataOraFlusso>
                </idRendicontazione>
            </elencoFlussiRendicontazione>
        </nodoChiediElencoFlussiRendicontazioneResponse>
    </soapenv:Body>
</soapenv:Envelope>

nodoChiediFlussoRendicontazione

POST

Request Body

Name

Type

Description

<soap:Envelope>
    <soap:Body>
        <nodoChiediElencoFlussiRendicontazione>
            <identificativoIntermediarioPA>77777777777</identificativoIntermediarioPA>
            <identificativoStazioneIntermediarioPA>77777777777_01</identificativoStazioneIntermediarioPA>
            <password>**********</password>
            <identificativoDominio>77777777777</identificativoDominio>
            <identificativoPSP>88888888888</identificativoPSP>
            <identificativoFlusso>2021-11-2188888888888-AABB648200001295</identificativoFlusso>
        </nodoChiediElencoFlussiRendicontazione>
    </soap:Body>
</soap:Envelope>

<soapenv:Envelope>
    <soapenv:Body>
        <nodoChiediFlussoRendicontazioneResponse>
            <esito>OK</esito>
            <xmlRendicontazione>Flusso di riversamento base64 encoded</xmlRendicontazione>
        </nodoChiediFlussoRendicontazioneResponse>
    </soapenv:Body>
</soapenv:Envelope>

nodoChiediCatalogoServizi

nodoChiediCatalogoServizi versione 2

POST

Request Body

Name

Type

Description

<soap:Envelope>
    <soap:Body>
        <ns5:nodoChiediCatalogoServizi>
            <identificativoPSP>88888888888</identificativoPSP>
            <identificativoIntermediarioPSP>88888888888</identificativoIntermediarioPSP>
            <identificativoCanale>88888888888_01</identificativoCanale>
            <password>**********</password>
            <identificativoDominio>77777777777</identificativoDominio>
            <categoria>Donazioni</categoria>
            <commissione>N</commissione>
        </ns5:nodoChiediCatalogoServizi>
    </soap:Body>
</soap:Envelope>

<soapenv:Envelope>
    <soapenv:Body>
        <nodoChiediCatalogoServizi>
            <esito>OK</esito>
            <xmlCatalogoServizi>Catalogo dei servizi base64 encoded</xmlCatalogoServizi>
        </nodoChiediCatalogoServizi>
    </soapenv:Body>
</soapenv:Envelope>

nodoChiediTemplateInformativaPSP

POST

Request Body

Name

Type

Description

<soap:Envelope>
    <soap:Body>
        <ns5:nodoChiediTemplateInformativaPSP>
            <identificativoPSP>88888888888</identificativoPSP>
            <identificativoIntermediarioPSP>88888888888</identificativoIntermediarioPSP>
            <identificativoCanale>88888888888_01</identificativoCanale>
            <password>**********</password>
        </ns5:nodoChiediTemplateInformativaPSP>
    </soap:Body>
</soap:Envelope>

<soapenv:Envelope>
    <soapenv:Body>
        <nodoChiediTemplateInformativaPSP>
            <esito>OK</esito>
            <xmlTemplateInformativa>Template informativa base64 encoded</xmlTemplateInformativa>
        </nodoChiediTemplateInformativaPSP>
    </soapenv:Body>
</soapenv:Envelope>

EC Checkout API

Nuove API - Gestione Flussi di Rendicontazione

Per gli EC:

Per i PSP:

getOrganizationReceipt

Recupero della ricevuta mediante il codice IUR

Recupero della ricevuta mediante i codici IUV

paCreatePosition

const response = await fetch('/paCreatePosition', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "paFiscalCode": "12345678910",
      "entityType": "G",
      "entityFiscalCode": "12345678910",
      "entityFullName": "Full Name",
      "iuv": "00000000000000000",
      "amount": 100,
      "description": "ACA Debt Position description",
      "expirationDate": "2024-11-23T08:07:08.083Z"
    }),
});
const data = await response.json();

{
  "paFiscalCode": "text",
  "companyName": "text",
  "entityType": "text",
  "entityFiscalCode": "text",
  "entityFullName": "text",
  "iuv": "text",
  "nav": "text",
  "description": "text",
  "expirationDate": "text",
  "iban": "text",
  "postalIban": "text",
  "switchToExpired": false,
  "status": "text"
}

const response = await fetch('https://api.uat.platform.pagopa.it/bizevents/service/v1/organizations/{organizationfiscalcode}/receipts/{iur}/paymentoptions/{iuv}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "receiptId": "text",
  "noticeNumber": "text",
  "fiscalCode": "text",
  "outcome": "text",
  "creditorReferenceId": "text",
  "paymentAmount": 0,
  "description": "text",
  "companyName": "text",
  "officeName": "text",
  "debtor": {
    "entityUniqueIdentifierType": "F",
    "entityUniqueIdentifierValue": "text",
    "fullName": "text",
    "streetName": "text",
    "civicNumber": "text",
    "postalCode": "text",
    "city": "text",
    "stateProvinceRegion": "text",
    "country": "text",
    "email": "text"
  },
  "transferList": [
    {
      "transferAmount": 0,
      "fiscalCodePA": "text",
      "iban": "text",
      "mbdAttachment": "text",
      "remittanceInformation": "text",
      "transferCategory": "text",
      "metadata": [
        {
          "key": "text",
          "value": "text"
        }
      ]
    }
  ],
  "idPSP": "text",
  "pspFiscalCode": "text",
  "pspPartitaIVA": "text",
  "pspCompanyName": "text",
  "idChannel": "text",
  "channelDescription": "text",
  "payer": {
    "entityUniqueIdentifierType": "F",
    "entityUniqueIdentifierValue": "text",
    "fullName": "text",
    "streetName": "text",
    "civicNumber": "text",
    "postalCode": "text",
    "city": "text",
    "stateProvinceRegion": "text",
    "country": "text",
    "email": "text"
  },
  "paymentMethod": "text",
  "fee": 0,
  "primaryCiIncurredFee": 0,
  "idBundle": "text",
  "idCiBundle": "text",
  "paymentDateTime": "2024-11-23",
  "applicationDate": "2024-11-23",
  "transferDate": "2024-11-23",
  "metadata": [
    {
      "key": "text",
      "value": "text"
    }
  ]
}

const response = await fetch('https://api.uat.platform.pagopa.it/bizevents/service/v1/organizations/{organizationfiscalcode}/receipts/{iur}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "receiptId": "text",
  "noticeNumber": "text",
  "fiscalCode": "text",
  "outcome": "text",
  "creditorReferenceId": "text",
  "paymentAmount": 0,
  "description": "text",
  "companyName": "text",
  "officeName": "text",
  "debtor": {
    "entityUniqueIdentifierType": "F",
    "entityUniqueIdentifierValue": "text",
    "fullName": "text",
    "streetName": "text",
    "civicNumber": "text",
    "postalCode": "text",
    "city": "text",
    "stateProvinceRegion": "text",
    "country": "text",
    "email": "text"
  },
  "transferList": [
    {
      "transferAmount": 0,
      "fiscalCodePA": "text",
      "iban": "text",
      "mbdAttachment": "text",
      "remittanceInformation": "text",
      "transferCategory": "text",
      "metadata": [
        {
          "key": "text",
          "value": "text"
        }
      ]
    }
  ],
  "idPSP": "text",
  "pspFiscalCode": "text",
  "pspPartitaIVA": "text",
  "pspCompanyName": "text",
  "idChannel": "text",
  "channelDescription": "text",
  "payer": {
    "entityUniqueIdentifierType": "F",
    "entityUniqueIdentifierValue": "text",
    "fullName": "text",
    "streetName": "text",
    "civicNumber": "text",
    "postalCode": "text",
    "city": "text",
    "stateProvinceRegion": "text",
    "country": "text",
    "email": "text"
  },
  "paymentMethod": "text",
  "fee": 0,
  "primaryCiIncurredFee": 0,
  "idBundle": "text",
  "idCiBundle": "text",
  "paymentDateTime": "2024-11-23",
  "applicationDate": "2024-11-23",
  "transferDate": "2024-11-23",
  "metadata": [
    {
      "key": "text",
      "value": "text"
    }
  ]
}

{
  "name": "pagopa-fdr",
  "version": "1.2.3",
  "environment": "dev",
  "description": "FDR - Flussi di rendicontazione",
  "errorCodes": [
    {
      "code": "FDR-0500",
      "description": "An unexpected error has occurred. Please contact support.",
      "statusCode": 500
    }
  ]
}

const response = await fetch('https://api.uat.platform.pagopa.it/fdr-psp/service/v1/psps/{pspId}/fdrs/{fdr}/payments/del', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "indexList": [
        0
      ]
    }),
});
const data = await response.json();

const response = await fetch('https://api.uat.platform.pagopa.it/fdr-psp/service/v1/psps/{pspId}/fdrs/{fdr}/publish', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

const response = await fetch('https://api.uat.platform.pagopa.it/fdr-psp/service/v1/psps/{pspId}/published/fdrs/{fdr}/revisions/{revision}/organizations/{organizationId}/payments', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "metadata": {
    "pageSize": 25,
    "pageNumber": 1,
    "totPage": 3
  },
  "count": 100,
  "data": [
    {
      "index": 1,
      "iuv": "abcdefg",
      "iur": "abcdefg",
      "idTransfer": 1,
      "pay": 0.01,
      "payStatus": "EXECUTED",
      "payDate": "2023-02-03T12:00:30.9Z"
    }
  ]
}

{
  "metadata": {
    "pageSize": 25,
    "pageNumber": 1,
    "totPage": 3
  },
  "count": 100,
  "data": [
    {
      "fdr": "AAABBB",
      "organizationId": "1",
      "revision": 1,
      "created": "2023-04-03T12:00:30.9Z"
    }
  ]
}

{
  "metadata": {
    "pageSize": 25,
    "pageNumber": 1,
    "totPage": 3
  },
  "count": 100,
  "data": [
    {
      "fdr": "AAABBB",
      "organizationId": "1",
      "revision": 1,
      "published": "2023-04-03T12:00:30.9Z"
    }
  ]
}

const response = await fetch('https://api.uat.platform.pagopa.it/fdr-psp/service/v1/psps/{pspId}/created/fdrs/{fdr}/organizations/{organizationId}/payments', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "metadata": {
    "pageSize": 25,
    "pageNumber": 1,
    "totPage": 3
  },
  "count": 100,
  "data": [
    {
      "index": 1,
      "iuv": "abcdefg",
      "iur": "abcdefg",
      "idTransfer": 1,
      "pay": 0.01,
      "payStatus": "EXECUTED",
      "payDate": "2023-02-03T12:00:30.9Z"
    }
  ]
}

const response = await fetch('https://api.uat.platform.pagopa.it/fdr-psp/service/v1/psps/{pspId}/fdrs/{fdr}/payments/add', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "payments": [
        {
          "index": 1,
          "iuv": "abcdefg",
          "iur": "abcdefg",
          "idTransfer": 1,
          "pay": 0.01,
          "payStatus": "EXECUTED",
          "payDate": "2023-02-03T12:00:30.9000000+00:00"
        }
      ]
    }),
});
const data = await response.json();

const response = await fetch('https://api.uat.platform.pagopa.it/fdr-psp/service/v1/psps/{pspId}/created/fdrs/{fdr}/organizations/{organizationId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "status": "CREATED",
  "revision": 4,
  "created": "2023-04-03T12:00:30.9Z",
  "updated": "2023-04-03T12:00:30.9Z",
  "fdr": "2016-08-16pspTest-1178",
  "fdrDate": "2023-04-05T09:21:37.81Z",
  "regulation": "SEPA - Bonifico xzy",
  "regulationDate": "2023-04-03T12:00:30.9Z",
  "bicCodePouringBank": "UNCRITMMXXX",
  "sender": {
    "type": "LEGAL_PERSON",
    "id": "SELBIT2B",
    "pspId": "60000000001",
    "pspName": "Bank",
    "pspBrokerId": "70000000001",
    "channelId": "80000000001"
  },
  "receiver": {
    "id": "APPBIT2B",
    "organizationId": "20000000001",
    "organizationName": "Comune di xyz"
  },
  "computedTotPayments": 100,
  "computedSumPayments": 100.9,
  "totPayments": 100,
  "sumPayments": 100.9
}

const response = await fetch('https://api.uat.platform.pagopa.it/fdr-psp/service/v1/psps/{pspId}/published/fdrs/{fdr}/revisions/{revision}/organizations/{organizationId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "status": "CREATED",
  "revision": 4,
  "created": "2023-04-03T12:00:30.9Z",
  "updated": "2023-04-03T12:00:30.9Z",
  "fdr": "2016-08-16pspTest-1178",
  "fdrDate": "2023-04-05T09:21:37.81Z",
  "regulation": "SEPA - Bonifico xzy",
  "regulationDate": "2023-04-03T12:00:30.9Z",
  "bicCodePouringBank": "UNCRITMMXXX",
  "sender": {
    "type": "LEGAL_PERSON",
    "id": "SELBIT2B",
    "pspId": "60000000001",
    "pspName": "Bank",
    "pspBrokerId": "70000000001",
    "channelId": "80000000001"
  },
  "receiver": {
    "id": "APPBIT2B",
    "organizationId": "20000000001",
    "organizationName": "Comune di xyz"
  },
  "published": "2023-04-03T12:00:30.9Z",
  "computedTotPayments": 100,
  "computedSumPayments": 100.9,
  "totPayments": 100,
  "sumPayments": 100.9
}

const response = await fetch('https://api.uat.platform.pagopa.it/fdr-psp/service/v1/psps/{pspId}/fdrs/{fdr}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "fdr": "2016-08-16pspTest-1178",
      "fdrDate": "2023-04-05T09:21:37.8100000+00:00",
      "sender": {
        "type": "LEGAL_PERSON",
        "id": "SELBIT2B",
        "pspId": "60000000001",
        "pspName": "Bank",
        "pspBrokerId": "70000000001",
        "channelId": "80000000001",
        "password": "1234567890"
      },
      "receiver": {
        "id": "APPBIT2B",
        "organizationId": "20000000001",
        "organizationName": "Comune di xyz"
      },
      "regulation": "SEPA - Bonifico xzy",
      "regulationDate": "2023-04-03T12:00:30.9000000+00:00",
      "bicCodePouringBank": "UNCRITMMXXX",
      "totPayments": 1,
      "sumPayments": 0.01
    }),
});
const data = await response.json();

Get info of FDR

GEThttps://api.uat.platform.pagopa.it/fdr-org/service/v1/info

Response

Success

Body

namestring

Example: "pagopa-fdr"

versionstring

Example: "1.2.3"

environmentstring

Example: "dev"

descriptionstring

Example: "FDR - Flussi di rendicontazione"

errorCodesarray of ErrorCode (object)

Request

const response = await fetch('https://api.uat.platform.pagopa.it/fdr-org/service/v1/info', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "name": "pagopa-fdr",
  "version": "1.2.3",
  "environment": "dev",
  "description": "FDR - Flussi di rendicontazione",
  "errorCodes": [
    {
      "code": "FDR-0500",
      "description": "An unexpected error has occurred. Please contact support.",
      "statusCode": 500
    }
  ]
}

Get all fdr published

GEThttps://api.uat.platform.pagopa.it/fdr-org/service/v1/organizations/{organizationId}/fdrs

Path parameters

organizationId*string

Pattern: ^(.{1,35})$

Query parameters

Response

Success

Body

metadataMetadata (object)

countinteger (int64)

Example: 100

dataarray of Fdr (object)

Request

const response = await fetch('https://api.uat.platform.pagopa.it/fdr-org/service/v1/organizations/{organizationId}/fdrs', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "metadata": {
    "pageSize": 25,
    "pageNumber": 1,
    "totPage": 3
  },
  "count": 100,
  "data": [
    {
      "fdr": "AAABBB",
      "pspId": "1",
      "revision": 1,
      "published": "2023-04-03T12:00:30.9Z"
    }
  ]
}

Get payments of fdr

GEThttps://api.uat.platform.pagopa.it/fdr-org/service/v1/organizations/{organizationId}/fdrs/{fdr}/revisions/{revision}/psps/{pspId}/payments

Path parameters

fdr*string

organizationId*string

pspId*string

revision*integer (int64)

Format - int64.

Query parameters

Response

Success

Body

metadataMetadata (object)

countinteger (int64)

Example: 100

dataarray of Payment (object)

Request

const response = await fetch('https://api.uat.platform.pagopa.it/fdr-org/service/v1/organizations/{organizationId}/fdrs/{fdr}/revisions/{revision}/psps/{pspId}/payments', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "metadata": {
    "pageSize": 25,
    "pageNumber": 1,
    "totPage": 3
  },
  "count": 100,
  "data": [
    {
      "index": 1,
      "iuv": "abcdefg",
      "iur": "abcdefg",
      "idTransfer": 1,
      "pay": 0.01,
      "payStatus": "EXECUTED",
      "payDate": "2023-02-03T12:00:30.9Z"
    }
  ]
}

Get fdr

GEThttps://api.uat.platform.pagopa.it/fdr-org/service/v1/organizations/{organizationId}/fdrs/{fdr}/revisions/{revision}/psps/{pspId}

Path parameters

fdr*string

organizationId*string

pspId*string

revision*integer (int64)

Format - int64.

Response

Success

Body

statusstring

Example: "CREATED"

revisioninteger (int64)

Example: 4

createdstring

Example: "2023-04-03T12:00:30.9Z"

updatedstring

Example: "2023-04-03T12:00:30.9Z"

fdrstring

Example: "2016-08-16pspTest-1178"

fdrDatestring

Example: "2023-04-05T09:21:37.81Z"

regulationstring

Example: "SEPA - Bonifico xzy"

regulationDatestring

Example: "2023-04-03T12:00:30.9Z"

bicCodePouringBankstring

Example: "UNCRITMMXXX"

senderSender (object)

receiverReceiver (object)

publishedstring

Example: "2023-04-03T12:00:30.9Z"

computedTotPaymentsinteger (int64)

Example: 100

computedSumPaymentsnumber (double)

Example: 100.9

totPaymentsinteger (int64)

Example: 100

sumPaymentsnumber (double)

Example: 100.9

Request

const response = await fetch('https://api.uat.platform.pagopa.it/fdr-org/service/v1/organizations/{organizationId}/fdrs/{fdr}/revisions/{revision}/psps/{pspId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "status": "CREATED",
  "revision": 4,
  "created": "2023-04-03T12:00:30.9Z",
  "updated": "2023-04-03T12:00:30.9Z",
  "fdr": "2016-08-16pspTest-1178",
  "fdrDate": "2023-04-05T09:21:37.81Z",
  "regulation": "SEPA - Bonifico xzy",
  "regulationDate": "2023-04-03T12:00:30.9Z",
  "bicCodePouringBank": "UNCRITMMXXX",
  "sender": {
    "type": "LEGAL_PERSON",
    "id": "SELBIT2B",
    "pspId": "60000000001",
    "pspName": "Bank",
    "pspBrokerId": "70000000001",
    "channelId": "80000000001"
  },
  "receiver": {
    "id": "APPBIT2B",
    "organizationId": "20000000001",
    "organizationName": "Comune di xyz"
  },
  "published": "2023-04-03T12:00:30.9Z",
  "computedTotPayments": 100,
  "computedSumPayments": 100.9,
  "totPayments": 100,
  "sumPayments": 100.9
}

Create a cart

Create a cart of payment notices checking each payment notice by mean of checkPosition

POST/carts

Body

New Cart related to payment requests

emailNoticestring (email)

Email to which send the payment receipt

Example: "my_email@mail.it"

paymentNotices*array of PaymentNotice (object)

List of payment notices in the cart

returnUrls*object

Structure containing all the returning URL's to which user will be redirect after payment process has been completed

idCartstring

the id of the cart from the ec

Example: "id_cart"

allCCPboolean

flag for internal purpose

Example: false

Response

Redirect

Headers

Request

const response = await fetch('/carts', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "paymentNotices": [
        {
          "noticeNumber": "302012387654312384",
          "fiscalCode": "77777777777",
          "amount": 10000,
          "companyName": "companyName",
          "description": "<p>description</p>",
          "__$markdownParsed": true
        },
        {
          "noticeNumber": "302012387654312385",
          "fiscalCode": "77777777777",
          "amount": 5000,
          "companyName": "companyName",
          "description": "<p>description</p>",
          "__$markdownParsed": true
        }
      ],
      "returnUrls": {
        "returnOkUrl": "https://www.comune.di.prova.it/pagopa/success.html",
        "returnCancelUrl": "https://www.comune.di.prova.it/pagopa/cancel.html",
        "returnErrorUrl": "https://www.comune.di.prova.it/pagopa/error.html"
      }
    }),
});
const data = await response.json();

Response

{
  "type": "https://example.com/problem/constraint-violation",
  "title": "text",
  "status": 200,
  "detail": "There was an error processing the request",
  "instance": "https://example.com"
}

paVerifyPaymentNotice

Request Body

paGetPayment

paGetPayment versione 1

Request Body

paGetPayment versione 2

Request Body

paSendRT

paSendRT versione 1

Request Body

paSendRT versione 2

Request Body

verifyPaymentNotice

Request Body

verificaBollettino

Request Body

activatePaymentNotice

activatePaymentNotice versione 1

Request Body

activatePaymentNotice versione 2

Request Body

sendPaymentOutcome

sendPaymentOutcome versione 1

Request Body

sendPaymentOutcome versione 2

Request Body

pspNotifyPayment

pspNotifyPayment versione 1

Request Body

pspNotifyPayment versione 2

Request Body

demandPaymentNotice

Request Body

paDemandPaymentNotice

Request Body

nodoInviaFlussoRendicontazione

Request Body

nodoChiediElencoFlussiRendicontazione

Request Body

nodoChiediFlussoRendicontazione

Request Body

nodoChiediCatalogoServizi

nodoChiediCatalogoServizi versione 2

Request Body

nodoChiediTemplateInformativaPSP

Request Body

EC Checkout API

Nuove API - Gestione Flussi di Rendicontazione

getOrganizationReceipt

paCreatePosition

Create a new debt position

The organization get the receipt for the creditor institution using IUV and IUR.

The organization get the receipt for the creditor institution using IUR.

Get info of FDR

Delete fdr

Delete payments to fdr

Publish fdr

Get payments of fdr Published

Get all fdr created

Get all fdr published

Get created payments of fdr

Add payments to fdr

Get created fdr

Get fdr Published

Create fdr

Get info of FDR

Get all fdr published

Get payments of fdr

Get fdr

Create a cart