Primitive

PreviousGestione evoluta commissioni NextFunzionalità deprecate

Last updated 4 months ago

Per la gestione degli errori fare riferimento a .

I campi contrassegnati con﹡sono obbligatori

Per i dettagli

paVerifyPaymentNotice

POST

Request Body

Name

Type

Description

idPA*

String

codice fiscale della struttura che invia la richiesta di pagamento

idBrokerPA*

String

identificativo del soggetto che opera come intermediario per l'EC

idStation*

String

identificativo della stazione dell'EC nel sistema pagoPa

qrCode*

String

è composto da fiscalCode e noticeNumber

fiscalCode*

String

codice fiscale dell'EC

noticeNumber*

String

[auxDigit][segregationCode][IUVBase][IUVCheckDigit]

  <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

idPA*

String

Codice fiscale della struttura che invia la richiesta di pagamento.

dueDate

String

Data di scadenza del pagamento secondo il formato ISO 8601 [AAAA]-[MM]-[GG].

transferType

String

Valore ammesso: POSTAL.

paymentNote

String

Descrizione del pagamento. Valorizzato con idCart, nel caso il parametro venisse valorizzato nel

amount

String

Importo del pagamento in euro.

noticeNumber*

String

[auxDigit][segregationCode][IUVBase][IUVCheckDigit]

fiscalCode*

String

Codice fiscale dell'EC.

qrCode*

String

E' composto da fiscalCode e noticeNumber.

idStation*

String

Identificativo della stazione dell'EC nel sistema pagoPa.

idBrokerPA*

String

Identificativo del soggetto che opera come intermediario per l'EC.

<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

idPA*

String

Codice fiscale della struttura che invia la richiesta di pagamento.

idBrokerPA*

String

Identificativo del soggetto che opera come intermediario per l'EC.

idStation*

String

Identificativo della stazione dell'EC nel sistema pagoPa.

qrCode*

String

E' composto da fiscalCode e noticeNumber.

amount*

String

Importo del pagamento in euro

paymentNote

String

Descrizione del pagamento. Valorizzato con idCart, nel caso il parametro venisse valorizzato nel

transferType

String

Valori ammessi

POSTAL

PAGOPA

dueDate

String

data di scadenza del pagamento secondo il formato ISO 8601 [AAAA]-[MM]-[GG]

fiscalCode*

String

codice fiscale dell'EC

noticeNumber*

String

[auxDigit][segregationCode][IUVBase][IUVCheckDigit]

<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

idPA*

String

codice fiscale della struttura che invia la richiesta di pagamento

idBrokerPA*

String

identificativo del soggetto che opera come intermediario per l'EC

idStation*

String

identificativo della stazione dell'EC nel sistema pagoPa

receipt*

String

la ricevuta di pagamento

receiptId*

String

identificatore univoco della receipt contiene il paymentToken assegnato da pagoPa

noticeNumber*

String

[auxDigit][segregationCode][IUVBase][IUVCheckDigit]

fiscalCode*

String

codice fiscale dell'EC

outcome*

String

il risultato dell'operazione che può contenere i codici OK o KO

creditorReferenceId*

String

IUV Identificativo Univoco Versamento

paymentAmount*

String

importo espresso in euro

description*

String

companyName

String

nome completo dell'EC

officeName

String

debtor*

String

individua il debitore a cui si riferisce la posizione debitoria

uniqueIdentifier*

String

entityUniqueIdentifierType*

String

F : Persona fisica G : Persona giuridica

entityUniqueIdentifierValue*

String

codice fiscale o partita IVA

e-mail

String

country

String

stateProvinceRegion

String

city

String

postalCode

String

civicNumber

String

streetName

String

fullName*

String

nome completo del debitore

transferList*

String

struttura che contiene i dettagli dei transfer

transfer*

String

idTransfer*

String

indice della lista (da 1 a 5)

fiscalCodePA*

String

codice fiscale dell'EC

transferAmount*

String

importo

IBAN*

String

IBAN sul quale sarà effettuato il riversamento

remittanceInformation*

String

motivo del pagamento

transferCategory*

String

codice tassonomico, composto da Codice tipo Ente Creditore + Progressivo macro area + Codice tipologia servizio + Motivo Giuridico ( ex. 0101002IM )

idPSP*

String

identificativo del PSP

pspFiscalCode

String

pspPartitaIVA

String

PSPCompanyName*

String

idChannel*

String

channelDescription*

String

payer

String

individua il pagatore

uniqueIdentifier*

entityUniqueIdentifierType*

String

F : Persona fisica G : Persona giuridica

entityUniqueIdentifierValue*

String

codice fiscale o partita IVA

fullName*

String

nome completo del debitore

streetName

String

civicNumber

String

postalCode

String

city

String

stateProvinceRegion

String

country

String

e-mail

String

paymentMethod

String

fee

String

importo della commissione espresso in euro

paymentDateTime

String

data e ora del pagamento

applicationDate

String

data applicativa

transferDate

String

data del riversamento

metadata

String

mapEntry*

key*

String

value*

String

identificativo del PSP

standin

Boolean

true: pagamento avvenuto in Stand in

  <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

idPA*

String

codice fiscale della struttura che invia la richiesta di pagamento

idBrokerPA*

String

identificativo del soggetto che opera come intermediario per l'EC

idStation*

String

identificativo della stazione dell'EC nel sistema pagoPa

receipt*

String

la ricevuta di pagamento

receiptId*

String

identificatore univoco della receipt contiene il paymentToken assegnato da pagoPa

noticeNumber*

String

[auxDigit][segregationCode][IUVBase][IUVCheckDigit]

fiscalCode*

String

codice fiscale dell'EC

outcome*

String

il risultato dell'operazione che può contenere i codici OK o KO

creditorReferenceId*

String

IUV Identificativo Univoco Versamento

paymentAmount*

String

importo espresso in euro

description*

String

companyName*

String

nome completo dell'EC

officeName

String

debtor*

String

individua il debitore a cui si riferisce la posizione debitoria

uniqueIdentifier*

String

entityUniqueIdentifierType*

String

F : Persona fisica

G : Persona giuridica

entityUniqueIdentifierValue*

String

codice fiscale o partita IVA

fullName*

String

nome completo del debitore

streetName

String

civicNumber

String

postalCode

String

city

String

stateProvinceRegion

String

country

String

e-mail

String

transferList*

String

struttura che contiene i dettagli dei transfer

transfer*

String

idTransfer*

String

indice della lista (da 1 a 5)

transferAmount*

String

importo

fiscalCodePA*

String

codice fiscale dell'EC

companyName

String

nome completo dell'EC

IBAN

String

IBAN sul quale sarà effettuato il riversamento

remittanceInformation*

String

motivo del pagamento

transferCategory*

String

codice tassonomico, composto da Codice tipo Ente Creditore + Progressivo macro area + Codice tipologia servizio + Motivo Giuridico ( ex. 0101002IM )

metadata

String

mapEntry

String

key

String

value*

String

idPSP*

String

identificativo del PSP

pspFiscalCode

String

pspPartitaIVA

String

PSPCompanyName*

String

idChannel*

String

channelDescription*

String

payer

String

individua il pagatore

uniqueIdentifier*

String

entityUniqueIdentifierType*

String

F : Persona fisica

G : Persona giuridica

entityUniqueIdentifierValue*

String

codice fiscale o partita IVA

fullName*

String

nome completo del debitore

streetName

String

civicNumber

String

postalCode

String

city

String

stateProvinceRegion

String

country

String

e-mail

String

paymentMethod

String

fee

String

importo della commissione espresso in euro

primaryCiIncurredFee

String

importo della commissione a carico dell'EC espresso in euro ricavato da

idBundle

String

identificativo del pacchetto di

idCiBundle

String

identificativo degli attributi aggiunti dall'EC al pacchetto di

paymentDateTime

String

data e ora del pagamento

applicationDate

String

data applicativa

transferDate

String

data del riversamento

metadata

String

mapEntry

String

key

String

value

String

CHOICE*

String

Choice tra IBAN e marcaDaBollo

tipoBollo

String

Tipologia del bollo

marcaDaBollo

String

I dati della marca da bollo digitale

MBDAttachment

String

Il documento XML che contiene la marca da bollo digitale, nel formato base64.

paymentNote

String

Descrizione del pagamento. Valorizzato con idCart, nel caso il parametro venisse valorizzato nel

standin

Boolean

true: pagamento avvenuto in Stand in

  <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

idPSP*

String

Identificativo del PSP, assegnato da PagoPA.

Il codice è generalmente rappresentato dal codice BIC (Bank Identifier Code) del PSP.

In assenza del codice BIC, o per gestire situazioni particolari, può essere utilizzato un altro codice, purché identifichi in modo univoco il PSP.

idBrokerPSP*

String

Identificativo dell'intermediario, assegnato da PagoPA.

Identificazione dell'intermediario/broker del PSP che fornisce l'accesso (canale) al PSP per l'erogazione del servizio.

Nota: l'intermediario/broker può coincidere con il PSP stesso.

idChannel*

String

Identificativo del canale, identifica una categoria di servizio di pagamento e attraverso la quale viene effettuata la transazione.

Un identificatore di canale appartiene a un solo intermediario/broker PSP e di conseguenza deve essere univoco rispetto al PSP.

qrCode*

String

è composto da fiscalCode e noticeNumber.

fiscalCode*

String

codice fiscale dell'EC.

noticeNumber*

String

[auxDigit][segregationCode][IUVBase][IUVCheckDigit]

password*

String

Password del canale, assegnata da PagoPA.

  <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

idPSP*

String

Identificativo del PSP, assegnato da PagoPA.

Il codice è generalmente rappresentato dal codice BIC (Bank Identifier Code) del PSP.

In assenza del codice BIC, o per gestire situazioni particolari, può essere utilizzato un altro codice, purché identifichi in modo univoco il PSP.

idBrokerPSP*

String

Identificativo dell'intermediario, assegnato da PagoPA.

Identificazione dell'intermediario/broker del PSP che fornisce l'accesso (canale) al PSP per l'erogazione del servizio.

Nota: l'intermediario/broker può coincidere con il PSP stesso.

idChannel*

String

Identificativo del canale, identifica una categoria di servizio di pagamento e attraverso la quale viene effettuata la transazione.

Un identificatore di canale appartiene a un solo intermediario/broker PSP e di conseguenza deve essere univoco rispetto al PSP.

ccPost*

String

conto corrente postale dell'EC.

noticeNumber*

String

[auxDigit][segregationCode][IUVBase][IUVCheckDigit]

password*

String

Password del canale, assegnata da PagoPA.

  <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

idPSP*

String

Identificativo del PSP, assegnato da PagoPA.

Il codice è generalmente rappresentato dal codice BIC (Bank Identifier Code) del PSP.

In assenza del codice BIC, o per gestire situazioni particolari, può essere utilizzato un altro codice, purché identifichi in modo univoco il PSP.

idBrokerPSP*

String

Identificativo dell'intermediario, assegnato da PagoPA.

Identificazione dell'intermediario/broker del PSP che fornisce l'accesso (canale) al PSP per l'erogazione del servizio.

Nota: l'intermediario/broker può coincidere con il PSP stesso.

idChannel*

String

Identificativo del canale, identifica una categoria di servizio di pagamento e attraverso la quale viene effettuata la transazione.

Un identificatore di canale appartiene a un solo intermediario/broker PSP e di conseguenza deve essere univoco rispetto al PSP.

qrCode*

String

E' composto da fiscalCode e noticeNumber.

fiscalCode*

String

Codice fiscale dell'EC.

noticeNumber*

String

[auxDigit][segregationCode][IUVBase][IUVCheckDigit]

password*

String

Password del canale, assegnata da PagoPA.

idempotencyKey

Chiave di idempotenza

expirationTime

String

Tempo di scadenza del token ( ms ), max 30 minuti.

La durata del token di pagamento può essere impostata in 2 modi:

- Implicitamente dalla piattaforma pagoPA, se non è impostato nella richiesta di activatePaymentNotice (valore di default durata = 30 minuti)

- Esplicitamente dal PSP, se impostato in richiesta all'activatePaymentNotice

paymentNote

String

Testo libero per descrivere l'oggetto del pagamento

dueDate

String

data di scadenza del pagamento secondo il formato ISO 8601 [AAAA]-[MM]-[GG]

amount*

String

Importo in euro

  <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

idPSP*

String

Identificativo del PSP, assegnato da PagoPA.

Il codice è generalmente rappresentato dal codice BIC (Bank Identifier Code) del PSP.

In assenza del codice BIC, o per gestire situazioni particolari, può essere utilizzato un altro codice, purché identifichi in modo univoco il PSP.

idBrokerPSP*

String

Identificativo dell'intermediario, assegnato da PagoPA.

Identificazione dell'intermediario/broker del PSP che fornisce l'accesso (canale) al PSP per l'erogazione del servizio.

Nota: l'intermediario/broker può coincidere con il PSP stesso.

idChannel*

String

Identificativo del canale, identifica una categoria di servizio di pagamento e attraverso la quale viene effettuata la transazione.

Un identificatore di canale appartiene a un solo intermediario/broker PSP e di conseguenza deve essere univoco rispetto al PSP.

qrCode*

String

E' composto da fiscalCode e noticeNumber.

fiscalCode*

String

Codice fiscale dell'EC.

noticeNumber*

String

[auxDigit][segregationCode][IUVBase][IUVCheckDigit]

password*

String

Password del canale, assegnata da PagoPA.

idempotencyKey

Chiave di idempotenza

expirationTime

String

Tempo di scadenza del token ( ms ), max 30 minuti.

La durata del token di pagamento può essere impostata in 2 modi:

- Implicitamente dalla piattaforma pagoPA, se non è impostato nella richiesta di activatePaymentNotice (valore di default durata = 30 minuti)

- Esplicitamente dal PSP, se impostato in richiesta all'activatePaymentNotice

paymentNote

String

Testo libero per descrivere l'oggetto del pagamento

dueDate

String

data di scadenza del pagamento secondo il formato ISO 8601 [AAAA]-[MM]-[GG]

amount*

String

Importo in euro

allCCP

String

ad uso interno per i servizi PagoPA

String

paymentMethod

String

metodo di pagamento

touchPoint

String

touchpoint utilizzato per il pagamento (es. POS fisico, ATM, ..)

  <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

idPSP*

String

identificativo del PSP, assegnato da PagoPA.

Il codice è generalmente rappresentato dal codice BIC (Bank Identifier Code) del PSP.

In assenza del codice BIC, o per gestire situazioni particolari, può essere utilizzato un altro codice, purché identifichi in modo univoco il PSP.

details

String

Dettagli del risultato dell'operazione, da inserire obbligatoriamente in caso di outcome OK

outcome*

String

Il risultato dell'operazione che può contenere i seguenti codici

OK : operazione eseguita con successo

KO : operazione terminata con errore

paymentToken*

String

Viene generato dal sistema durante la fase di attivazione del pagamento, è l'identificatore di correlazione da abbinare all'attivazione e all'esito del pagamento.

password*

String

Password del canale, assegnata da PagoPA.

idChannel*

String

identificativo del canale, identifica una categoria di servizio di pagamento e attraverso la quale viene effettuata la transazione.

Un identificatore di canale appartiene a un solo intermediario/broker PSP e di conseguenza deve essere univoco rispetto al PSP.

idBrokerPSP*

String

identificativo dell'intermediario, assegnato da PagoPA.

Identificazione dell'intermediario/broker del PSP che fornisce l'accesso (canale) al PSP per l'erogazione del servizio.

Nota: l'intermediario/broker può coincidere con il PSP stesso.

payer

String

individua il pagatore

fee*

String

importo della commissione pagata in euro

paymentChannel

String

canale di pagamento

enum: "frontOffice" "atm" "onLine" "app" "other"

paymentMethod*

String

metodo di pagamento

enum: "cash" "creditCard" "bancomat" "other"

transferDate*

String

data del riversamento verso l'EC

applicationDate*

String

data applicativa del pagamento

e-mail

String

country

String

stateProvinceRegion

String

city

String

postalCode

String

civicNumber

String

streetName

String

fullName*

String

nome completo del pagatore

uniqueIdentifier*

String

entityUniqueIdentifierValue*

String

codice fiscale o partita IVA, nel caso non siano disponibili è possibile utilizzare 'ANONIMO'

entityUniqueIdentifierType*

String

F : Persona fisica

G : Persona giuridica

idempotencyKey

String

Chiave di idempotenza.

  <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

idPSP*

String

Identificativo del PSP, assegnato da PagoPA.

Il codice è generalmente rappresentato dal codice BIC (Bank Identifier Code) del PSP.

In assenza del codice BIC, o per gestire situazioni particolari, può essere utilizzato un altro codice, purché identifichi in modo univoco il PSP.

details

String

dettagli del risultato dell'operazione, da inserire obbligatoriamente in caso di outcome OK

outcome*

String

il risultato dell'operazione che può contenere i seguenti codici

OK : operazione eseguita con successo

KO : operazione terminata con errore

paymentToken*

String

viene generato dal sistema durante la fase di attivazione del pagamento, è l'identificatore di correlazione da abbinare all'attivazione e all'esito del pagamento

password*

String

Password del canale, assegnata da PagoPA.

idChannel*

String

Identificativo del canale, identifica una categoria di servizio di pagamento e attraverso la quale viene effettuata la transazione.

Un identificatore di canale appartiene a un solo intermediario/broker PSP e di conseguenza deve essere univoco rispetto al PSP.

idBrokerPSP*

String

Identificativo dell'intermediario, assegnato da PagoPA.

Identificazione dell'intermediario/broker del PSP che fornisce l'accesso (canale) al PSP per l'erogazione del servizio.

Nota: l'intermediario/broker può coincidere con il PSP stesso.

payer

String

individua il pagatore

fee*

String

importo della commissione pagata in euro

paymentChannel

String

canale di pagamento

enum: "frontOffice" "atm" "onLine" "app" "other"

paymentMethod*

String

metodo di pagamento

enum: "cash" "creditCard" "bancomat" "other"

transferDate*

String

data del riversamento verso l'EC

applicationDate*

String

data applicativa del pagamento

e-mail

String

country

String

stateProvinceRegion

String

city

String

postalCode

String

civicNumber

String

streetName

String

fullName*

String

nome completo del pagatore

uniqueIdentifier*

String

entityUniqueIdentifierValue*

String

codice fiscale o partita IVA, nel caso non siano disponibili è possibile utilizzare 'ANONIMO'

entityUniqueIdentifierType*

String

F : Persona fisica

G : Persona giuridica

paymentTokens*

String

sequence che contiene tutti i tokens

idempotencyKey

String

Chiave di idempotenza

idCiBundle

String

identificativo degli attributi aggiunti dall'EC al pacchetto di

idBundle

String

identificativo del pacchetto di

primaryCiIncurredFee

String

importo della commissione a carico dell'EC espresso in euro ricavato da

marcheDaBollo

String

La lista delle marche da bollo digitali gestite nella transazione di pagamento

paymentToken

String

Il paymentToken con cui è arrivata la richiesta di marca da bollo digitale

idTransfer

String

L'identificativo del transfer che contiene il dato richiestaMarcaDaBollo

MBDAttachment

String

Il documento XML che contiene la marca da bollo digitale, nel formato base64

marcaDaBollo

String

I dati di ogni singola marca da bollo digitale

  <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

fiscalCodePA*

String

Codice fiscale dell'EC.

paymentToken*

String

Viene generato dal sistema durante la fase di attivazione del pagamento, è l'identificatore di correlazione da abbinare all'attivazione e all'esito del pagamento.

idPSP*

String

Identificativo del PSP, assegnato da PagoPA.

Il codice è generalmente rappresentato dal codice BIC (Bank Identifier Code) del PSP.

In assenza del codice BIC, o per gestire situazioni particolari, può essere utilizzato un altro codice, purché identifichi in modo univoco il PSP.

idChannel*

String

Identificativo del canale, identifica una categoria di servizio di pagamento e attraverso la quale viene effettuata la transazione.

Un identificatore di canale appartiene a un solo intermediario/broker PSP e di conseguenza deve essere univoco rispetto al PSP.

creditorReferenceId*

String

IUV Identificativo Univoco Versamento.

companyName*

String

Nome completo dell'EC.

officeName

String

Nome completo dell'ufficio dell'EC.

idBrokerPSP*

String

Identificativo dell'intermediario, assegnato da PagoPA.

Identificazione dell'intermediario/broker del PSP che fornisce l'accesso (canale) al PSP per l'erogazione del servizio.

Nota: l'intermediario/broker può coincidere con il PSP stesso.

debtAmount*

String

Rappresenta la somma degli importi dei singoli transfer.

paymentDescription*

String

Testo libero per descrivere l'oggetto del pagamento.

remittanceInformation*

String

Motivo del pagamento.

IBAN*

String

IBAN sul quale sarà effettuato il riversamento

fiscalCodePA*

String

Codice fiscale dell'EC.

transferAmount*

String

Importo

idTransfer*

String

Indice della lista (da 1 a 5).

transfer*

String

transferList*

String

Struttura che contiene i dettagli dei transfer pagamento, al momento i transfer possono essere al massimo 5.

dati specifici del canale di pagamento

String

Struttura dati specifica del canale di pagamento utilizzato.

standin

Boolean

true se pagamento eseguito in standin

    <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

fiscalCodePA*

String

Codice fiscale dell'EC.

paymentToken*

String

Viene generato dal sistema durante la fase di attivazione del pagamento, è l'identificatore di correlazione da abbinare all'attivazione e all'esito del pagamento.

idPSP*

String

Identificativo del PSP, assegnato da PagoPA.

Il codice è generalmente rappresentato dal codice BIC (Bank Identifier Code) del PSP.

In assenza del codice BIC, o per gestire situazioni particolari, può essere utilizzato un altro codice, purché identifichi in modo univoco il PSP.

idChannel*

String

Identificativo del canale, identifica una categoria di servizio di pagamento e attraverso la quale viene effettuata la transazione.

Un identificatore di canale appartiene a un solo intermediario/broker PSP e di conseguenza deve essere univoco rispetto al PSP.

creditorReferenceId*

String

IUV Identificativo Univoco Versamento.

companyName*

String

Nome completo dell'EC.

officeName

String

Nome completo dell'ufficio dell'EC.

idBrokerPSP*

String

Identificativo dell'intermediario, assegnato da PagoPA.

Identificazione dell'intermediario/broker del PSP che fornisce l'accesso (canale) al PSP per l'erogazione del servizio.

Nota: l'intermediario/broker può coincidere con il PSP stesso.

debtAmount*

String

Rappresenta la somma degli importi dei singoli transfer.

paymentDescription*

String

Testo libero per descrivere l'oggetto del pagamento.

remittanceInformation*

String

Motivo del pagamento.

IBAN

String

IBAN sul quale sarà effettuato il riversamento

fiscalCodePA*

String

Codice fiscale dell'EC.

transferAmount*

String

Importo

idTransfer*

String

Indice della lista (da 1 a 5).

transfer*

String

transferList*

String

Struttura che contiene i dettagli dei transfer pagamento, al momento i transfer possono essere al massimo 5.

payment*

String

paymentList*

String

Lista dei pagamenti.

additionalPaymentInformations

String

Struttura che contiene i dati specifici del canale di pagamento utilizzato.

mapEntry*

String

key*

String

value*

String

CHOICE*

String

Choice tra IBAN e richiestaMarcaDaBollo

provinciaResidenza

String

Sigla automobilistica della provincia di residenza del soggetto pagatore

hashDocumento

String

Impronta informatica (digest), nel formato base64, del documento informatico o della segnatura di protocollo cui è associata la marca da bollo digitale

tipoBollo

String

Tipologia del bollo

richiestaMarcaDaBollo

String

I dati della richiesta della marca da bollo

transactionId*

String

Identificativo dell'operazione di pagamento.

fee*

String

Importo della commissione.

totalAmount*

String

Rappresenta la somma pagata dall'utente, comprensiva di commissione.

timestampOperation*

String

Timestamp dell'operazione di pagamento.

IdCiBundle

String

identificativo degli attributi aggiunti dall'EC al pacchetto associato a

IdBundle

String

identificativo del pacchetto associato a

primaryCiIncurredFee

String

importo della commissione a carico dell'EC espresso in euro associato a

standin

Boolean

true se pagamento eseguito in standin

companyName

String

codice fiscale dell'EC

      <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

idPSP*

String

Identificativo del PSP, assegnato da PagoPA.

Il codice è generalmente rappresentato dal codice BIC (Bank Identifier Code) del PSP.

In assenza del codice BIC, o per gestire situazioni particolari, può essere utilizzato un altro codice, purché identifichi in modo univoco il PSP.

datiSpecificiServizio*

String

Sono censiti nel Catalogo dei Servizi, che è il repository che contiene l’elenco dei servizi generalizzati attivati dagli EC, inviati in formato base64. La struttura da inserire è definita dallo schema XSD il cui nome è riportato nell'elemento xsdRiferimento del Catalogo dei Servizi ed è consultabile tramite .

idSoggettoServizio*

String

Identificativo dell'associazione tra servizio e EC per cui si vuole attivare il pagamento. Corrisponde al tag elencoSoggettiEroganti.soggettoErogante.idSoggettoServizio del Catalogo dei Servizi.

password*

String

Password del canale, assegnata da PagoPA.

idChannel*

String

Identificativo del canale, identifica una categoria di servizio di pagamento e attraverso la quale viene effettuata la transazione.

Un identificatore di canale appartiene a un solo intermediario/broker PSP e di conseguenza deve essere univoco rispetto al PSP.

idBrokerPSP*

String

Identificativo dell'intermediario, assegnato da PagoPA.

Identificazione dell'intermediario/broker del PSP che fornisce l'accesso (canale) al PSP per l'erogazione del servizio.

Nota: l'intermediario/broker può coincidere con il PSP stesso.

<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

idPA*

String

Codice fiscale della struttura che invia la richiesta di pagamento.

datiSpecificiServizio*

String

Sono censiti nel Catalogo dei Servizi, che è il repository che contiene l’elenco dei servizi generalizzati attivati dagli EC, inviati in formato base64.

idServizio*

String

Identificativo del servizio per cui si vuole attivare il pagamento.

idStation*

String

Identificativo della stazione dell'EC nel sistema pagoPa.

idBrokerPA*

String

Identificativo del soggetto che opera come intermediario per l'EC.

idSoggettoServizio*

String

Identificativo dell'associazione tra servizio e EC per cui si vuole attivare il pagamento. Corrisponde al tag elencoSoggettiEroganti.soggettoErogante.idSoggettoServizio del Catalogo dei Servizi.

<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

identificativoPSP*

String

Identificativo del PSP, assegnato da PagoPA.

Il codice è generalmente rappresentato dal codice BIC (Bank Identifier Code) del PSP.

In assenza del codice BIC, o per gestire situazioni particolari, può essere utilizzato un altro codice, purché identifichi in modo univoco il PSP.

xmlRendicontazione*

String

Contenuto del Flusso di riversamento in formato base64.

dataOraFlusso*

String

Data e ora del Flusso di Rendicontazione.

identificativoFlusso*

String

Identificativo del Flusso di Rendicontazione.

identificativoDominio*

String

Codice fiscale dell'EC.

password*

String

Password del canale, assegnata da PagoPA.

identificativoCanale*

String

Identificativo del canale, identifica una categoria di servizio di pagamento e attraverso la quale viene effettuata la transazione.

Un identificatore di canale appartiene a un solo intermediario/broker PSP e di conseguenza deve essere univoco rispetto al PSP.

identificativoIntermediarioPSP*

String

Identificativo dell'intermediario, assegnato da PagoPA.

Identificazione dell'intermediario/broker del PSP che fornisce l'accesso (canale) al PSP per l'erogazione del servizio.

Nota: l'intermediario/broker può coincidere con il PSP stesso.

<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

identificativoIntermediarioPA*

String

Identificativo del soggetto che opera come intermediario per l'EC.

identificativoPSP

String

Identificativo del PSP, assegnato da PagoPA.

Il codice è generalmente rappresentato dal codice BIC (Bank Identifier Code) del PSP.

In assenza del codice BIC, o per gestire situazioni particolari, può essere utilizzato un altro codice, purché identifichi in modo univoco il PSP.

identificativoDominio

String

Codice fiscale dell'EC.

password*

String

Password della stazione, assegnata da PagoPA.

identificativoStazioneIntermediarioPA*

String

Identificativo della stazione dell'EC nel sistema pagoPa.

<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

identificativoIntermediarioPA*

String

Identificativo del soggetto che opera come intermediario per l'EC.

identificativoFlusso*

String

Identificativo del Flusso di Rendicontazione.

identificativoPSP

String

Identificativo del PSP, assegnato da PagoPA.

Il codice è generalmente rappresentato dal codice BIC (Bank Identifier Code) del PSP.

In assenza del codice BIC, o per gestire situazioni particolari, può essere utilizzato un altro codice, purché identifichi in modo univoco il PSP.

identificativoDominio

String

Codice fiscale dell'EC.

password*

String

Password della stazione, assegnata da PagoPA.

identificativoStazioneIntermediarioPA*

String

Identificativo della stazione dell'EC nel sistema pagoPa.

<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

identificativoPSP*

String

Identificativo del PSP, assegnato da PagoPA.

Il codice è generalmente rappresentato dal codice BIC (Bank Identifier Code) del PSP.

In assenza del codice BIC, o per gestire situazioni particolari, può essere utilizzato un altro codice, purché identifichi in modo univoco il PSP.

identificativoDominio

String

Codice fiscale dell'EC.

password*

String

Password del canale, assegnata da PagoPA.

identificativoCanale*

String

Identificativo del canale, identifica una categoria di servizio di pagamento e attraverso la quale viene effettuata la transazione.

Un identificatore di canale appartiene a un solo intermediario/broker PSP e di conseguenza deve essere univoco rispetto al PSP.

identificativoIntermediarioPSP*

String

Identificativo dell'intermediario, assegnato da PagoPA.

Identificazione dell'intermediario/broker del PSP che fornisce l'accesso (canale) al PSP per l'erogazione del servizio.

Nota: l'intermediario/broker può coincidere con il PSP stesso.

categoria

String

Filtro in base alla categoria dei servizi.

commissione

String

Filtro in base al consiglio di applicare o meno le commissioni inserite dall'EC che ha creato il servizio.

<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

identificativoPSP*

String

Identificativo del PSP, assegnato da PagoPA.

Il codice è generalmente rappresentato dal codice BIC (Bank Identifier Code) del PSP.

In assenza del codice BIC, o per gestire situazioni particolari, può essere utilizzato un altro codice, purché identifichi in modo univoco il PSP.

identificativoIntermediarioPSP*

String

Identificativo dell'intermediario, assegnato da PagoPA.

Identificazione dell'intermediario/broker del PSP che fornisce l'accesso (canale) al PSP per l'erogazione del servizio.

Nota: l'intermediario/broker può coincidere con il PSP stesso.

identificativoCanale*

String

Identificativo del canale, identifica una categoria di servizio di pagamento e attraverso la quale viene effettuata la transazione.

Un identificatore di canale appartiene a un solo intermediario/broker PSP e di conseguenza deve essere univoco rispetto al PSP.

password*

String

Password del canale, assegnata da PagoPA.

<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

{
  "status": "CREATED",
  "revision": 4,
  "created": "2023-04-03T12:00:30.9000000+00:00",
  "updated": "2023-04-03T12:00:30.9000000+00:00",
  "fdr": "2016-08-16pspTest-1178",
  "fdrDate": "2023-04-05T09:21:37.8100000+00:00",
  "regulation": "SEPA - Bonifico xzy",
  "regulationDate": "2023-04-03T12:00:30.9000000+00:00",
  "bicCodePouringBank": "UNCRITMMXXX",
  "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"
  },
  "published": "2023-04-03T12:00:30.9000000+00:00",
  "computedTotPayments": 100,
  "computedSumPayments": 100.9,
  "totPayments": 100,
  "sumPayments": 100.9
}

GET /fdr-org/service/v1/organizations/{organizationId}/fdrs/{fdr}/revisions/{revision}/psps/{pspId}/payments HTTP/1.1
Host: api.uat.platform.pagopa.it
Ocp-Apim-Subscription-Key: YOUR_API_KEY
Accept: */*

{
  "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.9000000+00:00"
    }
  ]
}

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

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

Create a new debt position

post

Create a new debt position.

Query parameters

segregationCodesstringOptional

Segregation codes for which broker is authorized

Body

Request body for creating a new transaction

paFiscalCodestring · min: 11 · max: 11RequiredExample: 12345678910

entityTypestring · enumRequiredExample: GPossible values:

entityFiscalCodestring · min: 2RequiredExample: 12345678910

entityFullNamestring · min: 1 · max: 255RequiredExample: Full Name

iuvstring · min: 1 · max: 255RequiredExample: 00000000000000000

navstring · min: 1 · max: 255Optional

notice number, if not specified it will created using the following pattern: 3 + iuv

Example: 30000000000000000

amountinteger · max: 99999999999Required

Amount for payments, in eurocents

Example: 100

descriptionstring · min: 1 · max: 255RequiredExample: ACA Debt Position description

expirationDatestring · date-timeRequired

ibanstring · min: 27 · max: 27OptionalExample: IT0000000000000000000000000

postalIbanstring · min: 27 · max: 27OptionalExample: IT60X0542811101000000123456

switchToExpiredbooleanOptionalDefault: falseExample: true

payStandInbooleanOptionalDefault: trueExample: true

Responses

200

New debt position successfully created or updated

application/json

400

Formally invalid input

application/json

404

Entity not found

application/json

409

Conflict into requested action

application/json

422

Can not perform the requested action on debit position

application/json

500

Internal server error

application/json

502

Bad gateway

application/json

post

POST /paCreatePosition HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 385

{
  "paFiscalCode": "12345678910",
  "entityType": "G",
  "entityFiscalCode": "12345678910",
  "entityFullName": "Full Name",
  "iuv": "00000000000000000",
  "nav": "30000000000000000",
  "amount": 100,
  "description": "ACA Debt Position description",
  "expirationDate": "2025-05-29T12:51:01.689Z",
  "iban": "IT0000000000000000000000000",
  "postalIban": "IT60X0542811101000000123456",
  "switchToExpired": true,
  "payStandIn": true
}

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

{
  "receiptId": "text",
  "noticeNumber": "text",
  "fiscalCode": "text",
  "outcome": "text",
  "creditorReferenceId": "text",
  "paymentAmount": 1,
  "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": [
    {
      "idTransfer": 1,
      "transferAmount": 1,
      "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": 1,
  "primaryCiIncurredFee": 1,
  "idBundle": "text",
  "idCiBundle": "text",
  "paymentDateTime": "2025-05-29",
  "applicationDate": "2025-05-29",
  "transferDate": "2025-05-29",
  "metadata": [
    {
      "key": "text",
      "value": "text"
    }
  ]
}

{
  "receiptId": "text",
  "noticeNumber": "text",
  "fiscalCode": "text",
  "outcome": "text",
  "creditorReferenceId": "text",
  "paymentAmount": 1,
  "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": [
    {
      "idTransfer": 1,
      "transferAmount": 1,
      "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": 1,
  "primaryCiIncurredFee": 1,
  "idBundle": "text",
  "idCiBundle": "text",
  "paymentDateTime": "2025-05-29",
  "applicationDate": "2025-05-29",
  "transferDate": "2025-05-29",
  "metadata": [
    {
      "key": "text",
      "value": "text"
    }
  ]
}

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

Add payments to fdr

put

Add payments to fdr

Authorizations

Path parameters

fdrstringRequired

pspIdstringRequired

Body

Responses

200

Success

application/json

400

Default app exception for status 400

application/json

404

Default app exception for status 404

application/json

500

Internal Server Error

application/json

put

PUT /fdr-psp/service/v1/psps/{pspId}/fdrs/{fdr}/payments/add HTTP/1.1
Host: api.uat.platform.pagopa.it
Ocp-Apim-Subscription-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 153

{
  "payments": [
    {
      "index": 1,
      "iuv": "abcdefg",
      "iur": "abcdefg",
      "idTransfer": 1,
      "pay": 0.01,
      "payStatus": "EXECUTED",
      "payDate": "2023-02-03T12:00:30.9000000+00:00"
    }
  ]
}

{
  "message": "Success"
}

{
  "status": "CREATED",
  "revision": 4,
  "created": "2023-04-03T12:00:30.9000000+00:00",
  "updated": "2023-04-03T12:00:30.9000000+00:00",
  "fdr": "2016-08-16pspTest-1178",
  "fdrDate": "2023-04-05T09:21:37.8100000+00:00",
  "regulation": "SEPA - Bonifico xzy",
  "regulationDate": "2023-04-03T12:00:30.9000000+00:00",
  "bicCodePouringBank": "UNCRITMMXXX",
  "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"
  },
  "computedTotPayments": 100,
  "computedSumPayments": 100.9,
  "totPayments": 100,
  "sumPayments": 100.9
}

GET /fdr-psp/service/v1/psps/{pspId}/published/fdrs/{fdr}/revisions/{revision}/organizations/{organizationId}/payments HTTP/1.1
Host: api.uat.platform.pagopa.it
Ocp-Apim-Subscription-Key: YOUR_API_KEY
Accept: */*

{
  "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.9000000+00:00"
    }
  ]
}

Create fdr

post

Create fdr

Authorizations

Path parameters

fdrstringRequiredPattern: [a-zA-Z0-9\-_]{1,35}

pspIdstringRequired

Body

fdrstringRequired

[XML NodoInviaFlussoRendicontazione]=[identificativoFlusso]

Example: 2016-08-16pspTest-1178Pattern: [a-zA-Z0-9\-_]{1,35}

fdrDateall ofRequired

[XML NodoInviaFlussoRendicontazione]=[dataOraFlusso]

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

string · date-timeOptionalExample: 2022-03-10T04:15:50.0000000+00:00

regulationstringRequired

[XML FlussoRiversamento]=[identificativoUnivocoRegolamento]

Example: SEPA - Bonifico xzyPattern: ^(.{1,35})$

regulationDateall ofRequired

[XML FlussoRiversamento]=[dataRegolamento]

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

string · date-timeOptionalExample: 2022-03-10T04:15:50.0000000+00:00

bicCodePouringBankstringOptional

[XML FlussoRiversamento]=[codiceBicBancaDiRiversamento]

Example: UNCRITMMXXXPattern: ^(.{1,35})$

totPaymentsinteger · int64 · min: 1Required

[XML FlussoRiversamento]=[numeroTotalePagamenti]

Example: 1

sumPaymentsnumber · doubleRequired

[XML FlussoRiversamento]=[importoTotalePagamenti]

Example: 0.01Pattern: ^\d{1,2147483647}([.]\d{1,2})?$

Responses

201

Created

application/json

400

Default app exception for status 400

application/json

404

Default app exception for status 404

application/json

500

Internal Server Error

application/json

post

POST /fdr-psp/service/v1/psps/{pspId}/fdrs/{fdr} HTTP/1.1
Host: api.uat.platform.pagopa.it
Ocp-Apim-Subscription-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 497

{
  "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
}

{
  "message": "Success"
}

GET /fdr-psp/service/v1/psps/{pspId}/published/fdrs/{fdr}/revisions/{revision}/organizations/{organizationId} HTTP/1.1
Host: api.uat.platform.pagopa.it
Ocp-Apim-Subscription-Key: YOUR_API_KEY
Accept: */*

{
  "status": "CREATED",
  "revision": 4,
  "created": "2023-04-03T12:00:30.9000000+00:00",
  "updated": "2023-04-03T12:00:30.9000000+00:00",
  "fdr": "2016-08-16pspTest-1178",
  "fdrDate": "2023-04-05T09:21:37.8100000+00:00",
  "regulation": "SEPA - Bonifico xzy",
  "regulationDate": "2023-04-03T12:00:30.9000000+00:00",
  "bicCodePouringBank": "UNCRITMMXXX",
  "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"
  },
  "published": "2023-04-03T12:00:30.9000000+00:00",
  "computedTotPayments": 100,
  "computedSumPayments": 100.9,
  "totPayments": 100,
  "sumPayments": 100.9
}

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

Delete payments to fdr

put

Delete payments to fdr

Authorizations

Path parameters

fdrstringRequired

pspIdstringRequired

Body

indexListinteger · int64[] · min: 1 · max: 1000Required

Responses

200

Success

application/json

400

Default app exception for status 400

application/json

404

Default app exception for status 404

application/json

500

Internal Server Error

application/json

put

PUT /fdr-psp/service/v1/psps/{pspId}/fdrs/{fdr}/payments/del HTTP/1.1
Host: api.uat.platform.pagopa.it
Ocp-Apim-Subscription-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "indexList": [
    0
  ]
}

{
  "message": "Success"
}

{
  "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.9000000+00:00"
    }
  ]
}

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

Create a cart

post

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

Body

Cart request body

emailNoticestring · emailOptional

Email to which send the payment receipt

Example: my_email@mail.it

idCartstringOptional

the id of the cart from the ec

Example: id_cart

allCCPbooleanOptional

flag for internal purpose

Example: false

Responses

302

Redirect

400

Formally invalid input

application/json

422

More than one payment notice present into request

application/json

post

POST /carts HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 578

{
  "emailNotice": "my_email@mail.it",
  "paymentNotices": [
    {
      "noticeNumber": "302012387654312384",
      "fiscalCode": "77777777777",
      "amount": 10000,
      "companyName": "companyName",
      "description": "description"
    },
    {
      "noticeNumber": "302012387654312385",
      "fiscalCode": "77777777777",
      "amount": 5000,
      "companyName": "companyName",
      "description": "description"
    }
  ],
  "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"
  },
  "idCart": "id_cart",
  "allCCP": false
}

No content

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

Get fdr

Get payments of fdr

Get all fdr published

Get info of FDR

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

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

Get info of FDR

Publish fdr

Get created fdr

Get payments of fdr Published

Delete fdr

Get fdr Published

Get all fdr created

Get created payments of fdr

Get all fdr published

Create a new debt position

Add payments to fdr

Create fdr

Delete payments to fdr

Create a cart