Tabella dei contenuti

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]

1  <soapenv:Envelope>
2    <soapenv:Header />
3    <soapenv:Body>
4      <nod:paVerifyPaymentNoticeReq>
5        <idPA>77777777777</idPA>
6        <idBrokerPA>77777777777</idBrokerPA>
7        <idStation>77777777777_01</idStation>
8        <qrCode>
9          <fiscalCode>77777777777</fiscalCode>
10          <noticeNumber>311111111112222222</noticeNumber>
11        </qrCode>
12      </nod:paVerifyPaymentNoticeReq>
13    </soapenv:Body>
14  </soapenv:Envelope>
15

1<soapenv:Envelope>
2  <soapenv:Header />
3  <soapenv:Body>
4    <paf:paVerifyPaymentNoticeRes>
5      <outcome>OK</outcome>
6      <paymentList>
7        <paymentOptionDescription>
8          <amount>30.00</amount>
9          <options>EQ</options>
10          <dueDate>2021-12-31</dueDate>
11          <detailDescription>test</detailDescription>
12          <allCCP>false</allCCP>
13        </paymentOptionDescription>
14      </paymentList>
15      <paymentDescription>payment</paymentDescription>
16      <fiscalCodePA>77777777777</fiscalCodePA>
17      <companyName>company EC</companyName>
18      <officeName>office EC</officeName>
19    </paf:paVerifyPaymentNoticeRes>
20  </soapenv:Body>
21</soapenv:Envelope>
22

paGetPayment

paGetPayment versione 1

POST

Request Body

Name	Type	Description
idPA{% mark style="color:red;" %}*{% /mark %}	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{% mark style="color:red;" %}*{% /mark %}	String	[auxDigit][segregationCode][IUVBase][IUVCheckDigit]
fiscalCode{% mark style="color:red;" %}*{% /mark %}	String	Codice fiscale dell'EC.
qrCode{% mark style="color:red;" %}*{% /mark %}	String	E' composto da fiscalCode e noticeNumber.
idStation{% mark style="color:red;" %}*{% /mark %}	String	Identificativo della stazione dell'EC nel sistema pagoPa.
idBrokerPA{% mark style="color:red;" %}*{% /mark %}	String	Identificativo del soggetto che opera come intermediario per l'EC.

1<soapenv:Envelope>
2    <soapenv:Body>
3      <pafn:paGetPaymentReq>
4        <idPA>77777777777</idPA>
5        <idBrokerPA>77777777777</idBrokerPA>
6        <idStation>77777777777_01</idStation>
7        <qrCode>
8          <fiscalCode>77777777777</fiscalCode>
9          <noticeNumber>311111111112222222</noticeNumber>
10        </qrCode>
11        <amount>30.00</amount>
12      </pafn:paGetPaymentReq>
13    </soapenv:Body>
14  </soapenv:Envelope>    
15

1<soapenv:Envelope>
2  <soapenv:Header />
3  <soapenv:Body>
4    <paf:paGetPaymentRes>
5      <outcome>OK</outcome>
6      <data>
7        <creditorReferenceId>11111111112222222</creditorReferenceId>
8        <paymentAmount>30.00</paymentAmount>
9        <dueDate>2021-12-31</dueDate>
10        <retentionDate>2021-12-31T23:59:59</retentionDate>
11        <lastPayment>0</lastPayment>
12        <description>test</description>
13        <companyName>company EC</companyName>
14        <officeName>office EC</officeName>
15        <debtor>
16          <uniqueIdentifier>
17            <entityUniqueIdentifierType>F</entityUniqueIdentifierType>
18            <entityUniqueIdentifierValue>JHNDOE00A01F205N</entityUniqueIdentifierValue>
19          </uniqueIdentifier>
20          <fullName>John Doe</fullName>
21          <streetName>street</streetName>
22          <civicNumber>12</civicNumber>
23          <postalCode>89020</postalCode>
24          <city>city</city>
25          <stateProvinceRegion>MI</stateProvinceRegion>
26          <country>IT</country>
27          <e-mail>john.doe@test.it</e-mail>
28        </debtor>
29        <transferList>
30          <transfer>
31            <idTransfer>1</idTransfer>
32            <transferAmount>20.00</transferAmount>
33            <fiscalCodePA>77777777777</fiscalCodePA>
34            <IBAN>IT0000000000000000000000000</IBAN>
35            <remittanceInformation>remittanceInformation1</remittanceInformation>
36            <transferCategory>0101100IM</transferCategory>
37          </transfer>
38          <transfer>
39            <idTransfer>2</idTransfer>
40            <transferAmount>10.00</transferAmount>
41            <fiscalCodePA>77777777778</fiscalCodePA>
42            <IBAN>IT0000000000000000000000001</IBAN>
43            <remittanceInformation>remittanceInformation2</remittanceInformation>
44            <transferCategory>0201102IM</transferCategory>
45          </transfer>
46        </transferList>
47        <metadata>
48          <mapEntry>
49            <key>keytest</key>
50            <value>1</value>
51          </mapEntry>
52        </metadata>
53      </data>
54    </paf:paGetPaymentRes>
55  </soapenv:Body>
56</soapenv:Envelope>
57

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]

1<soapenv:Envelope>
2    <soapenv:Body>
3      <pafn:paGetPaymentV2Request>
4        <idPA>77777777777</idPA>
5        <idBrokerPA>77777777777</idBrokerPA>
6        <idStation>77777777777_01</idStation>
7        <qrCode>
8          <fiscalCode>77777777777</fiscalCode>
9          <noticeNumber>311111111112222222</noticeNumber>
10        </qrCode>
11        <amount>30.00</amount>
12      </pafn:paGetPaymentV2Request>
13    </soapenv:Body>
14  </soapenv:Envelope>         
15

1<soapenv:Envelope>
2  <soapenv:Header />
3  <soapenv:Body>
4    <paf:paGetPaymentV2Response>
5      <outcome>OK</outcome>
6      <data>
7        <creditorReferenceId>11111111112222222</creditorReferenceId>
8        <paymentAmount>30.00</paymentAmount>
9        <dueDate>2021-12-31</dueDate>
10        <retentionDate>2021-12-31T23:59:59</retentionDate>
11        <lastPayment>0</lastPayment>
12        <description>test</description>
13        <companyName>company EC</companyName>
14        <officeName>office EC</officeName>
15        <debtor>
16          <uniqueIdentifier>
17            <entityUniqueIdentifierType>F</entityUniqueIdentifierType>
18            <entityUniqueIdentifierValue>JHNDOE00A01F205N</entityUniqueIdentifierValue>
19          </uniqueIdentifier>
20          <fullName>John Doe</fullName>
21          <streetName>street</streetName>
22          <civicNumber>12</civicNumber>
23          <postalCode>89020</postalCode>
24          <city>city</city>
25          <stateProvinceRegion>MI</stateProvinceRegion>
26          <country>IT</country>
27          <e-mail>john.doe@test.it</e-mail>
28        </debtor>
29        <transferList>
30          <transfer>
31            <idTransfer>1</idTransfer>
32            <transferAmount>20.00</transferAmount>
33            <fiscalCodePA>77777777777</fiscalCodePA>
34            <companyName>company EC</companyName>
35            <IBAN>IT0000000000000000000000000</IBAN>
36            <remittanceInformation>remittanceInformation1</remittanceInformation>
37            <transferCategory>0101100IM</transferCategory>
38            <metadata>
39              <mapEntry>
40                <key>keytest</key>
41                <value>1</value>
42              </mapEntry>
43            </metadata>
44          </transfer>
45          <transfer>
46            <idTransfer>2</idTransfer>
47            <transferAmount>10.00</transferAmount>
48            <fiscalCodePA>77777777778</fiscalCodePA>
49            <companyName>company EC</companyName>
50            <IBAN>IT0000000000000000000000001</IBAN>
51            <remittanceInformation>remittanceInformation2</remittanceInformation>
52            <transferCategory>0201102IM</transferCategory>
53          </transfer>
54        </transferList>
55        <metadata>
56          <mapEntry>
57            <key>keytest</key>
58            <value>1</value>
59          </mapEntry>
60        </metadata>
61      </data>
62    </paf:paGetPaymentV2Response>
63  </soapenv:Body>
64</soapenv:Envelope>
65

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{% mark style="color:red;" %}*{% /mark %}	String	codice fiscale della struttura che invia la richiesta di pagamento
idBrokerPA{% mark style="color:red;" %}*{% /mark %}	String	identificativo del soggetto che opera come intermediario per l'EC
idStation{% mark style="color:red;" %}*{% /mark %}	String	identificativo della stazione dell'EC nel sistema pagoPa
receipt{% mark style="color:red;" %}*{% /mark %}	String	la ricevuta di pagamento
receiptId{% mark style="color:red;" %}*{% /mark %}	String	identificatore univoco della receipt contiene il paymentToken assegnato da pagoPa
noticeNumber{% mark style="color:red;" %}*{% /mark %}	String	[auxDigit][segregationCode][IUVBase][IUVCheckDigit]
fiscalCode{% mark style="color:red;" %}*{% /mark %}	String	codice fiscale dell'EC
outcome{% mark style="color:red;" %}*{% /mark %}	String	il risultato dell'operazione che può contenere i codici OK o KO
creditorReferenceId{% mark style="color:red;" %}*{% /mark %}	String	IUV Identificativo Univoco Versamento
paymentAmount{% mark style="color:red;" %}*{% /mark %}	String	importo espresso in euro
description{% mark style="color:red;" %}*{% /mark %}	String
companyName	String	nome completo dell'EC
officeName	String
debtor{% mark style="color:red;" %}*{% /mark %}	String	individua il debitore a cui si riferisce la posizione debitoria
uniqueIdentifier{% mark style="color:red;" %}*{% /mark %}	String
entityUniqueIdentifierType{% mark style="color:red;" %}*{% /mark %}	String	F : Persona fisica G : Persona giuridica
entityUniqueIdentifierValue{% mark style="color:red;" %}*{% /mark %}	String	codice fiscale o partita IVA
e-mail	String
country	String
stateProvinceRegion	String
city	String
postalCode	String
civicNumber	String
streetName	String
fullName{% mark style="color:red;" %}*{% /mark %}	String	nome completo del debitore
transferList{% mark style="color:red;" %}*{% /mark %}	String	struttura che contiene i dettagli dei transfer
transfer{% mark style="color:red;" %}*{% /mark %}	String
idTransfer{% mark style="color:red;" %}*{% /mark %}	String	indice della lista (da 1 a 5)
fiscalCodePA{% mark style="color:red;" %}*{% /mark %}	String	codice fiscale dell'EC
transferAmount{% mark style="color:red;" %}*{% /mark %}	String	importo
IBAN{% mark style="color:red;" %}*{% /mark %}	String	IBAN sul quale sarà effettuato il riversamento
remittanceInformation{% mark style="color:red;" %}*{% /mark %}	String	motivo del pagamento
transferCategory{% mark style="color:red;" %}*{% /mark %}	String	codice tassonomico, composto da Codice tipo Ente Creditore + Progressivo macro area + Codice tipologia servizio + Motivo Giuridico ( ex. 0101002IM )
idPSP{% mark style="color:red;" %}*{% /mark %}	String	identificativo del PSP
pspFiscalCode	String
pspPartitaIVA	String
PSPCompanyName{% mark style="color:red;" %}*{% /mark %}	String
idChannel{% mark style="color:red;" %}*{% /mark %}	String
channelDescription{% mark style="color:red;" %}*{% /mark %}	String
payer	String	individua il pagatore
uniqueIdentifier{% mark style="color:red;" %}*{% /mark %}
entityUniqueIdentifierType{% mark style="color:red;" %}*{% /mark %}	String	F : Persona fisica G : Persona giuridica
entityUniqueIdentifierValue{% mark style="color:red;" %}*{% /mark %}	String	codice fiscale o partita IVA
fullName{% mark style="color:red;" %}*{% /mark %}	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{% mark style="color:red;" %}*{% /mark %}
key{% mark style="color:red;" %}*{% /mark %}	String
value{% mark style="color:red;" %}*{% /mark %}	String	identificativo del PSP
standin	Boolean	true: pagamento avvenuto in Stand in

1  <soapenv:Envelope>
2    <soapenv:Body>
3      <pafn:paSendRTReq>
4        <idPA>77777777777</idPA>
5        <idBrokerPA>77777777777</idBrokerPA>
6        <idStation>77777777777_01</idStation>
7        <receipt>
8          <receiptId>c110729d258c4ab1b765fe902aae41d6</receiptId>
9          <noticeNumber>311111111112222222</noticeNumber>
10          <fiscalCode>77777777777</fiscalCode>
11          <outcome>OK</outcome>
12          <creditorReferenceId>11111111112222222</creditorReferenceId>
13          <paymentAmount>30.00</paymentAmount>
14          <description>test</description>
15          <companyName>company EC</companyName>
16          <officeName>office EC</officeName>
17          <debtor>
18            <uniqueIdentifier>
19              <entityUniqueIdentifierType>F</entityUniqueIdentifierType>
20              <entityUniqueIdentifierValue>JHNDOE00A01F205N</entityUniqueIdentifierValue>
21            </uniqueIdentifier>
22            <fullName>John Doe</fullName>
23            <streetName>street</streetName>
24            <civicNumber>12</civicNumber>
25            <postalCode>89020</postalCode>
26            <city>city</city>
27            <stateProvinceRegion>MI</stateProvinceRegion>
28            <country>IT</country>
29            <e-mail>john.doe@test.it</e-mail>
30          </debtor>
31          <transferList>
32            <transfer>
33              <idTransfer>1</idTransfer>
34              <transferAmount>20.00</transferAmount>
35              <fiscalCodePA>77777777777</fiscalCodePA>
36              <IBAN>IT0000000000000000000000000</IBAN>
37              <remittanceInformation>remittanceInformation1</remittanceInformation>
38              <transferCategory>0101100IM</transferCategory>
39            </transfer>
40            <transfer>
41              <idTransfer>2</idTransfer>
42              <transferAmount>10.00</transferAmount>
43              <fiscalCodePA>77777777778</fiscalCodePA>
44              <IBAN>IT0000000000000000000000001</IBAN>
45              <remittanceInformation>remittanceInformation2</remittanceInformation>
46              <transferCategory>0201102IM</transferCategory>
47            </transfer>
48          </transferList>
49          <idPSP>88888888888</idPSP>
50          <pspFiscalCode>88888888888</pspFiscalCode>
51          <pspPartitaIVA>88888888888</pspPartitaIVA>
52          <PSPCompanyName>PSP name</PSPCompanyName>
53          <idChannel>88888888888_01</idChannel>
54          <channelDescription>app</channelDescription>
55          <payer>
56            <uniqueIdentifier>
57              <entityUniqueIdentifierType>F</entityUniqueIdentifierType>
58              <entityUniqueIdentifierValue>JHNDOE00A01F205N</entityUniqueIdentifierValue>
59            </uniqueIdentifier>
60            <fullName>John Doe</fullName>
61            <streetName>street</streetName>
62            <civicNumber>12</civicNumber>
63            <postalCode>89020</postalCode>
64            <city>city</city>
65            <stateProvinceRegion>MI</stateProvinceRegion>
66            <country>IT</country>
67            <e-mail>john.doe@test.it</e-mail>
68          </payer>
69          <paymentMethod>creditCard</paymentMethod>
70          <fee>2.00</fee>
71          <paymentDateTime>2021-10-01T17:48:22</paymentDateTime>
72          <applicationDate>2021-10-01</applicationDate>
73          <transferDate>2021-10-02</transferDate>
74          <metadata>
75            <mapEntry>
76              <key>keytest</key>
77              <value>1</value>
78            </mapEntry>
79          </metadata>
80          <standin>false</standin>
81        </receipt>
82      </pafn:paSendRTReq>
83    </soapenv:Body>
84  </soapenv:Envelope>
85

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

1  <soapenv:Envelope>
2    <soapenv:Body>
3      <pafn:paSendRTV2Request>
4        <idPA>77777777777</idPA>
5        <idBrokerPA>77777777777</idBrokerPA>
6        <idStation>77777777777_01</idStation>
7        <receipt>
8          <receiptId>c110729d258c4ab1b765fe902aae41d6</receiptId>
9          <noticeNumber>311111111112222222</noticeNumber>
10          <fiscalCode>77777777777</fiscalCode>
11          <outcome>OK</outcome>
12          <creditorReferenceId>11111111112222222</creditorReferenceId>
13          <paymentAmount>30.00</paymentAmount>
14          <description>test</description>
15          <companyName>company EC1</companyName>
16          <officeName>office EC</officeName>
17          <debtor>
18            <uniqueIdentifier>
19              <entityUniqueIdentifierType>F</entityUniqueIdentifierType>
20              <entityUniqueIdentifierValue>JHNDOE00A01F205N</entityUniqueIdentifierValue>
21            </uniqueIdentifier>
22            <fullName>John Doe</fullName>
23            <streetName>street</streetName>
24            <civicNumber>12</civicNumber>
25            <postalCode>89020</postalCode>
26            <city>city</city>
27            <stateProvinceRegion>MI</stateProvinceRegion>
28            <country>IT</country>
29            <e-mail>john.doe@test.it</e-mail>
30          </debtor>
31          <transferList>
32            <transfer>
33              <idTransfer>1</idTransfer>
34              <transferAmount>20.00</transferAmount>
35              <fiscalCodePA>77777777777</fiscalCodePA>
36              <companyName>company EC1</companyName>
37              <IBAN>IT0000000000000000000000000</IBAN>
38              <remittanceInformation>remittanceInformation1</remittanceInformation>
39              <transferCategory>0101100IM</transferCategory>
40              <metadata>
41                <mapEntry>
42                  <key>keytest</key>
43                  <value>1</value>
44                </mapEntry>
45              </metadata>            
46            </transfer>
47            <transfer>
48              <idTransfer>2</idTransfer>
49              <transferAmount>10.00</transferAmount>
50              <fiscalCodePA>77777777778</fiscalCodePA>
51              <companyName>company EC2</companyName>
52              <IBAN>IT0000000000000000000000001</IBAN>
53              <remittanceInformation>remittanceInformation2</remittanceInformation>
54              <transferCategory>0201102IM</transferCategory>
55            </transfer>
56          </transferList>
57          <idPSP>88888888888</idPSP>
58          <pspFiscalCode>88888888888</pspFiscalCode>
59          <pspPartitaIVA>88888888888</pspPartitaIVA>
60          <PSPCompanyName>PSP name</PSPCompanyName>
61          <idChannel>88888888888_01</idChannel>
62          <channelDescription>app</channelDescription>
63          <payer>
64            <uniqueIdentifier>
65              <entityUniqueIdentifierType>F</entityUniqueIdentifierType>
66              <entityUniqueIdentifierValue>JHNDOE00A01F205N</entityUniqueIdentifierValue>
67            </uniqueIdentifier>
68            <fullName>John Doe</fullName>
69            <streetName>street</streetName>
70            <civicNumber>12</civicNumber>
71            <postalCode>89020</postalCode>
72            <city>city</city>
73            <stateProvinceRegion>MI</stateProvinceRegion>
74            <country>IT</country>
75            <e-mail>john.doe@test.it</e-mail>
76          </payer>
77          <paymentMethod>creditCard</paymentMethod>
78          <fee>2.00</fee>
79          <primaryCiIncurredFee>0.50</primaryCiIncurredFee>
80          <idBundle>1</idBundle>
81          <idCiBundle>2</idCiBundle>
82          <paymentDateTime>2021-10-01T17:48:22</paymentDateTime>
83          <applicationDate>2021-10-01</applicationDate>
84          <transferDate>2021-10-02</transferDate>
85          <metadata>
86            <mapEntry>
87              <key>keytest</key>
88              <value>1</value>
89            </mapEntry>
90          </metadata>
91          <standin>false</standin>
92        </receipt>
93      </pafn:paSendRTV2Request>
94    </soapenv:Body>
95  </soapenv:Envelope>
96

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.

1<soapenv:Envelope>
2  <soapenv:Body>
3    <ppt:paDemandPaymentNoticeReq>
4      <idPA>77777777777</idPA>
5      <idBrokerPA>77777777777</idBrokerPA>
6      <idStation>77777777777_01</idStation>
7      <idServizio>00002</idServizio>
8      <idSoggettoServizio>00003</idSoggettoServizio>       
9      <datiSpecificiServizio>Dati del servizio base64 encoded</datiSpecificiServizio>
10    </ppt:paDemandPaymentNoticeReq>
11  </soapenv:Body>
12</soapenv:Envelope>
13

1  <soapenv:Body>
2    <ns5:paDemandPaymentNoticeRes">
3      <outcome>OK</outcome>
4      <qrCode>
5        <fiscalCode>77777777778</fiscalCode>
6        <noticeNumber>311111111112222222</noticeNumber>
7      </qrCode>
8      <paymentList>
9        <paymentOptionDescription>
10          <amount>30.00</amount>
11          <options>EQ</options>
12          <paymentNote>test</paymentNote>
13        </paymentOptionDescription>
14      </paymentList>
15      <paymentDescription>payment</paymentDescription>
16      <fiscalCodePA>77777777777</fiscalCodePA>
17      <companyName>company EC</companyName>
18      <officeName>office EC</officeName>
19    </ns5:paDemandPaymentNoticeRes>
20  </soapenv:Body>
21</soapenv:Envelope>
22

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.

1<soap:Envelope>
2    <soap:Body>
3        <ns5:nodoChiediElencoFlussiRendicontazione>
4            <identificativoIntermediarioPA>77777777777</identificativoIntermediarioPA>
5            <identificativoStazioneIntermediarioPA>77777777777_01</identificativoStazioneIntermediarioPA>
6            <password>**********</password>
7            <identificativoDominio>77777777777</identificativoDominio>
8            <identificativoPSP>88888888888</identificativoPSP>
9        </ns5:nodoChiediElencoFlussiRendicontazione>
10    </soap:Body>
11</soap:Envelope>
12

1<soapenv:Envelope>
2    <soapenv:Body>
3        <nodoChiediElencoFlussiRendicontazioneResponse>
4            <esito>OK</esito>
5            <elencoFlussiRendicontazione>
6                <totRestituiti>1</totRestituiti>
7                <idRendicontazione>
8                    <identificativoFlusso>2021-11-2188888888888-AABB648200001295</identificativoFlusso>
9                    <dataOraFlusso>2021-11-22T00:37:32</dataOraFlusso>
10                </idRendicontazione>
11            </elencoFlussiRendicontazione>
12        </nodoChiediElencoFlussiRendicontazioneResponse>
13    </soapenv:Body>
14</soapenv:Envelope>
15

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.

1<soap:Envelope>
2    <soap:Body>
3        <nodoChiediElencoFlussiRendicontazione>
4            <identificativoIntermediarioPA>77777777777</identificativoIntermediarioPA>
5            <identificativoStazioneIntermediarioPA>77777777777_01</identificativoStazioneIntermediarioPA>
6            <password>**********</password>
7            <identificativoDominio>77777777777</identificativoDominio>
8            <identificativoPSP>88888888888</identificativoPSP>
9            <identificativoFlusso>2021-11-2188888888888-AABB648200001295</identificativoFlusso>
10        </nodoChiediElencoFlussiRendicontazione>
11    </soap:Body>
12</soap:Envelope>
13

1<soapenv:Envelope>
2    <soapenv:Body>
3        <nodoChiediFlussoRendicontazioneResponse>
4            <esito>OK</esito>
5            <xmlRendicontazione>Flusso di riversamento base64 encoded</xmlRendicontazione>
6        </nodoChiediFlussoRendicontazioneResponse>
7    </soapenv:Body>
8</soapenv:Envelope>
9

In questa pagina

paVerifyPaymentNotice

paGetPayment

paGetPayment versione 1

paGetPayment versione 2

paSendRT

paSendRT versione 1

paSendRT versione 2

paDemandPaymentNotice

nodoChiediElencoFlussiRendicontazione

nodoChiediFlussoRendicontazione

Serve aiuto?

Apri un ticket utilizzando l’apposita funzione all’interno della tua Area Riservata

Dicci cosa ne pensi

Per chiarimenti sulle specifiche d’implementazione, come SACI e SANP, puoi aprire una segnalazione su GitHub