API SOAP

Per la gestione degli errori fare riferimento a Gestione degli errori.

I campi contrassegnati con﹡sono obbligatori

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

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

Se presente, rappresenta la data di scadenza del pagamento secondo il formato ISO 8601 [AAAA]-[MM]-[GG].

Per maggiori informazioni, consulta le Best Practice.

transferType

String

Valore ammesso: POSTAL.

paymentNote

String

Descrizione del pagamento. Valorizzato con idCart, nel caso il parametro venisse valorizzato nel Pagamento presso frontend dell'EC

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>[email protected]</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>

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 Gestione degli errori
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﹡: 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
    fiscalCodePA﹡: codice fiscale dell'EC
    IBAN﹡: IBAN sul quale sarà effettuato il riversamento
    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 ad uso esclusivo dell'EC. I dati saranno inseriti nella receipt (paSendRT)
  - mapEntry﹡
    key﹡
    value﹡

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 Pagamento presso frontend dell'EC

transferType

String

Valori ammessi

POSTAL

PAGOPA

dueDate

String

Se presente, rappresenta la data di scadenza del pagamento secondo il formato ISO 8601 [AAAA]-[MM]-[GG].

Per maggiori informazioni, consulta le Best Practice.

fiscalCode*

String

codice fiscale dell'EC

noticeNumber*

String

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

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

<soapenv:Envelope>
  <soapenv:Header />
  <soapenv:Body>
    <paf:paGetPaymentV2Response>
      <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>[email protected]</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:paGetPaymentV2Response>
  </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 Gestione degli errori
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>[email protected]</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>[email protected]</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>

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 Gestione evoluta commissioni

idBundle

String

identificativo del pacchetto di Gestione evoluta commissioni

idCiBundle

String

identificativo degli attributi aggiunti dall'EC al pacchetto di Gestione evoluta commissioni

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 Pagamento presso frontend dell'EC

standin

Boolean

true: pagamento avvenuto in Stand in

  <soapenv:Envelope>
    <soapenv:Body>
      <pafn:paSendRTV2Request>
        <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>[email protected]</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>[email protected]</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:paSendRTV2Request>
    </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>

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>

PreviousEnte Creditore NextAPI REST

Last updated 11 days ago

hashtagpaVerifyPaymentNotice

hashtagRequest Body

hashtagpaGetPayment

hashtagpaGetPayment versione 1

hashtagRequest Body

hashtagpaGetPayment versione 2

hashtagRequest Body

hashtagpaSendRT

hashtagpaSendRT versione 1

hashtagRequest Body

hashtagpaSendRT versione 2

hashtagRequest Body

hashtagpaDemandPaymentNotice

hashtagRequest Body

hashtagnodoChiediElencoFlussiRendicontazione

hashtagRequest Body

hashtagnodoChiediFlussoRendicontazione

hashtagRequest Body

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

paDemandPaymentNotice

Request Body

nodoChiediElencoFlussiRendicontazione

Request Body

nodoChiediFlussoRendicontazione

Request Body