Tabella dei contenuti

Primitive

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.1.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*	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.
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.

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

paGetPayment versione 2

POST

In questa versione è possibile inserire i metadata in ogni singolo transfer.

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
transferType	String	valore ammesso: POSTAL
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]

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            <metadata>
38              <mapEntry>
39                <key>keytest</key>
40                <value>1</value>
41              </mapEntry>
42            </metadata>
43          </transfer>
44          <transfer>
45            <idTransfer>2</idTransfer>
46            <transferAmount>10.00</transferAmount>
47            <fiscalCodePA>77777777778</fiscalCodePA>
48            <IBAN>IT0000000000000000000000001</IBAN>
49            <remittanceInformation>remittanceInformation2</remittanceInformation>
50            <transferCategory>0201102IM</transferCategory>
51          </transfer>
52        </transferList>
53        <metadata>
54          <mapEntry>
55            <key>keytest</key>
56            <value>1</value>
57          </mapEntry>
58        </metadata>
59      </data>
60    </paf:paGetPaymentRes>
61  </soapenv:Body>
62</soapenv:Envelope>
63

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
  - 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
    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.
    mapEntry﹡
    key﹡
    value﹡
- metadata: è un campo di archiviazione chiave/valore ad uso esclusivo dell'EC. 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
receiptId*	String	identificatore univoco della receipt contiene il paymentToken assegnato da pagoPa
outcome*	String	il risultato dell'operazione che può contenere i codici OK o KO
receipt*	String	la ricevuta di pagamento
idStation*	String	identificativo della stazione dell'EC nel sistema pagoPa
idBrokerPA*	String	identificativo del soggetto che opera come intermediario per l'EC
entityUniqueIdentifierType*	String	F : Persona fisica G : Persona giuridica
uniqueIdentifier*	String
debtor*	String	individua il debitore a cui si riferisce la posizione debitoria
officeName	String
companyName*	String	nome completo dell'EC
description*	String
paymentAmount*	String	importo espresso in euro
creditorReferenceId*	String	IUV Identificativo Univoco Versamento
fiscalCode*	String	codice fiscale dell'EC
noticeNumber*	String	[auxDigit][segregationCode][IUVBase][IUVCheckDigit]
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
transferCategory*	String	codice tassonomico, composto da Codice tipo Ente Creditore + Progressivo macro area + Codice tipologia servizio + Motivo Giuridico ( ex. 0101002IM )
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
channelDescription*	String
idChannel*	String
PSPCompanyName*	String
pspPartitaIVA	String
pspFiscalCode	String
idPSP*	String	identificativo del PSP
key*	String
mapEntry*	String
metadata	String
transferDate	String	data del riversamento
applicationDate	String	data applicativa
paymentDateTime	String	data e ora del pagamento
fee	String	importo della commissione espresso in euro
paymentMethod	String
e-mail	String
country	String
stateProvinceRegion	String
city	String
postalCode	String
civicNumber	String
streetName	String
fullName*	String	nome completo del debitore
entityUniqueIdentifierValue*	String	codice fiscale o partita IVA
entityUniqueIdentifierType*	String	F : Persona fisica G : Persona giuridica
uniqueIdentifier*	String
payer	String	individua il pagatore
value*	String

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        </receipt>
81      </pafn:paSendRTReq>
82    </soapenv:Body>
83  </soapenv:Envelope>
84

paSendRT versione 2

POST

In questa versione possono essere inseriti i metadata in ogni singolo transfer della receipt.

Request Body

Name	Type	Description
idPA*	String	codice fiscale della struttura che invia la richiesta di pagamento
receiptId*	String	identificatore univoco della receipt contiene il paymentToken assegnato da pagoPa
outcome*	String	il risultato dell'operazione che può contenere i codici OK o KO
receipt*	String	la ricevuta di pagamento
idStation*	String	identificativo della stazione dell'EC nel sistema pagoPa
idBrokerPA*	String	identificativo del soggetto che opera come intermediario per l'EC
entityUniqueIdentifierType*	String	F : Persona fisica G : Persona giuridica
uniqueIdentifier*	String
debtor*	String	individua il debitore a cui si riferisce la posizione debitoria
officeName	String
companyName*	String	nome completo dell'EC
description*	String
paymentAmount*	String	importo espresso in euro
creditorReferenceId*	String	IUV Identificativo Univoco Versamento
fiscalCode*	String	codice fiscale dell'EC
noticeNumber*	String	[auxDigit][segregationCode][IUVBase][IUVCheckDigit]
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
transferCategory*	String	codice tassonomico, composto da Codice tipo Ente Creditore + Progressivo macro area + Codice tipologia servizio + Motivo Giuridico ( ex. 0101002IM )
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
channelDescription*	String
idChannel*	String
PSPCompanyName*	String
pspPartitaIVA	String
pspFiscalCode	String
idPSP*	String	identificativo del PSP
key*	String
mapEntry*	String
metadata	String
transferDate	String	data del riversamento
applicationDate	String	data applicativa
paymentDateTime	String	data e ora del pagamento
fee	String	importo della commissione espresso in euro
paymentMethod	String
e-mail	String
country	String
stateProvinceRegion	String
city	String
postalCode	String
civicNumber	String
streetName	String
fullName*	String	nome completo del debitore
entityUniqueIdentifierValue*	String	codice fiscale o partita IVA
entityUniqueIdentifierType*	String	F : Persona fisica G : Persona giuridica
uniqueIdentifier*	String
payer	String	individua il pagatore
value*	String
value	String
key	String
mapEntry	String
metadata	String

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              <metadata>
40                <mapEntry>
41                  <key>keytest</key>
42                  <value>1</value>
43                </mapEntry>
44              </metadata>            
45            </transfer>
46            <transfer>
47              <idTransfer>2</idTransfer>
48              <transferAmount>10.00</transferAmount>
49              <fiscalCodePA>77777777778</fiscalCodePA>
50              <IBAN>IT0000000000000000000000001</IBAN>
51              <remittanceInformation>remittanceInformation2</remittanceInformation>
52              <transferCategory>0201102IM</transferCategory>
53            </transfer>
54          </transferList>
55          <idPSP>88888888888</idPSP>
56          <pspFiscalCode>88888888888</pspFiscalCode>
57          <pspPartitaIVA>88888888888</pspPartitaIVA>
58          <PSPCompanyName>PSP name</PSPCompanyName>
59          <idChannel>88888888888_01</idChannel>
60          <channelDescription>app</channelDescription>
61          <payer>
62            <uniqueIdentifier>
63              <entityUniqueIdentifierType>F</entityUniqueIdentifierType>
64              <entityUniqueIdentifierValue>JHNDOE00A01F205N</entityUniqueIdentifierValue>
65            </uniqueIdentifier>
66            <fullName>John Doe</fullName>
67            <streetName>street</streetName>
68            <civicNumber>12</civicNumber>
69            <postalCode>89020</postalCode>
70            <city>city</city>
71            <stateProvinceRegion>MI</stateProvinceRegion>
72            <country>IT</country>
73            <e-mail>john.doe@test.it</e-mail>
74          </payer>
75          <paymentMethod>creditCard</paymentMethod>
76          <fee>2.00</fee>
77          <paymentDateTime>2021-10-01T17:48:22</paymentDateTime>
78          <applicationDate>2021-10-01</applicationDate>
79          <transferDate>2021-10-02</transferDate>
80          <metadata>
81            <mapEntry>
82              <key>keytest</key>
83              <value>1</value>
84            </mapEntry>
85          </metadata>
86        </receipt>
87      </pafn:paSendRTReq>
88    </soapenv:Body>
89  </soapenv:Envelope>
90

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.

1  <soapenv:Envelope>
2    <soapenv:Body>
3      <nod:verifyPaymentNoticeReq>
4        <idPSP>88888888888</idPSP>
5        <idBrokerPSP>88888888888</idBrokerPSP>
6        <idChannel>88888888888_01</idChannel>
7        <password>**********</password>
8        <qrCode>
9          <fiscalCode>77777777777</fiscalCode>
10          <noticeNumber>311111111112222222</noticeNumber>
11        </qrCode>
12      </nod:verifyPaymentNoticeReq>
13    </soapenv:Body>
14  </soapenv:Envelope>
15

1<soapenv:Envelope>
2  <soapenv:Body>
3    <nfpsp:verifyPaymentNoticeRes>
4      <outcome>OK</outcome>
5      <paymentList>
6        <paymentOptionDescription>
7          <amount>30.00</amount>
8          <options>EQ</options>
9          <paymentNote>test</paymentNote>
10        </paymentOptionDescription>
11      </paymentList>
12      <paymentDescription>payment</paymentDescription>
13      <fiscalCodePA>77777777777</fiscalCodePA>
14      <companyName>company EC</companyName>
15      <officeName>office EC</officeName>
16    </nfpsp:verifyPaymentNoticeRes>
17  </soapenv:Body>
18</soapenv:Envelope> 
19

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.

1  <soapenv:Envelope>
2    <soapenv:Body>
3      <nod:verificaBollettinoReq>
4        <idPSP>88888888888</idPSP>
5        <idBrokerPSP>88888888888</idBrokerPSP>
6        <idChannel>88888888888_01</idChannel>
7        <password>**********</password>
8        <ccPost>012345678912</ccPost>
9        <noticeNumber>311111111112222222</noticeNumber>
10      </nod:verificaBollettinoReq>
11    </soapenv:Body>
12  </soapenv:Envelope>
13

1<soapenv:Envelope>
2  <soapenv:Body>
3    <nfpsp:verificaBollettinoRes>
4      <outcome>OK</outcome>
5      <paymentBollettinoList>
6        <paymentOptionDescription>
7          <amount>30.00</amount>
8          <options>EQ</options>
9          <dueDate>2021-12-31</dueDate>
10          <paymentNote>test</paymentNote>
11          <allCCP>true</allCCP>
12        </paymentOptionDescription>
13      </paymentBollettinoList>
14      <paymentDescription>payment</paymentDescription>
15      <fiscalCodePA>77777777777</fiscalCodePA>
16      <noticeNumber>311111111112222222</noticeNumber>
17      <companyName>company EC</companyName>
18      <officeName>office EC</officeName>
19    </nfpsp:verificaBollettinoRes>
20  </soapenv:Body>
21</soapenv:Envelope>
22

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

1  <soapenv:Envelope>
2    <soapenv:Body>
3      <nod:activatePaymentNoticeReq>
4        <idPSP>88888888888</idPSP>
5        <idBrokerPSP>88888888888</idBrokerPSP>
6        <idChannel>88888888888_01</idChannel>
7        <password>**********</password>
8        <idempotencyKey>70000000001_100149bdWB</idempotencyKey>
9        <qrCode>
10          <fiscalCode>77777777777</fiscalCode>
11          <noticeNumber>311111111112222222</noticeNumber>
12        </qrCode>
13        <expirationTime>6000</expirationTime>
14        <amount>30.00</amount>
15      </nod:activatePaymentNoticeReq>
16    </soapenv:Body>
17  </soapenv:Envelope>
18

1<soapenv:Envelope>
2  <soapenv:Body>
3    <nfpsp:activatePaymentNoticeRes>
4      <outcome>OK</outcome>
5      <totalAmount>30.00</totalAmount>
6      <paymentDescription>test</paymentDescription>
7      <fiscalCodePA>77777777777</fiscalCodePA>
8      <companyName>company EC</companyName>
9      <officeName>office EC</officeName>
10      <paymentToken>c110729d258c4ab1b765fe902aae41d6</paymentToken>
11      <transferList>
12        <transfer>
13          <idTransfer>1</idTransfer>
14          <transferAmount>20.00</transferAmount>
15          <fiscalCodePA>77777777777</fiscalCodePA>
16          <IBAN>IT0000000000000000000000000</IBAN>
17          <remittanceInformation>remittanceInformation1</remittanceInformation>
18        </transfer>
19        <transfer>
20          <idTransfer>2</idTransfer>
21          <transferAmount>10.00</transferAmount>
22          <fiscalCodePA>77777777778</fiscalCodePA>
23          <IBAN>IT0000000000000000000000001</IBAN>
24          <remittanceInformation>remittanceInformation2</remittanceInformation>
25        </transfer>
26      </transferList>
27      <creditorReferenceId>11111111112222222</creditorReferenceId>
28    </nfpsp:activatePaymentNoticeRes>
29  </soapenv:Body>
30</soapenv:Envelope>
31

activatePaymentNotice versione 2

POST

In questa versione è possibile far transitare i metadata per ogni payment e in ogni singolo transfer della response.

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

1  <soapenv:Envelope>
2    <soapenv:Body>
3      <nod:activatePaymentNoticeReq>
4        <idPSP>88888888888</idPSP>
5        <idBrokerPSP>88888888888</idBrokerPSP>
6        <idChannel>88888888888_01</idChannel>
7        <password>**********</password>
8        <idempotencyKey>70000000001_100149bdWB</idempotencyKey>
9        <qrCode>
10          <fiscalCode>77777777777</fiscalCode>
11          <noticeNumber>311111111112222222</noticeNumber>
12        </qrCode>
13        <expirationTime>6000</expirationTime>
14        <amount>30.00</amount>
15      </nod:activatePaymentNoticeReq>
16    </soapenv:Body>
17  </soapenv:Envelope>
18

1<soapenv:Envelope>
2  <soapenv:Body>
3    <nfpsp:activatePaymentNoticeRes>
4      <outcome>OK</outcome>
5      <totalAmount>30.00</totalAmount>
6      <paymentDescription>test</paymentDescription>
7      <fiscalCodePA>77777777777</fiscalCodePA>
8      <companyName>company EC</companyName>
9      <officeName>office EC</officeName>
10      <paymentToken>c110729d258c4ab1b765fe902aae41d6</paymentToken>
11      <transferList>
12        <transfer>
13          <idTransfer>1</idTransfer>
14          <transferAmount>20.00</transferAmount>
15          <fiscalCodePA>77777777777</fiscalCodePA>
16          <IBAN>IT0000000000000000000000000</IBAN>
17          <remittanceInformation>remittanceInformation1</remittanceInformation>
18          <metadata>
19            <mapEntry>
20              <key>keytest1</key>
21              <value>1</value>
22            </mapEntry>
23          </metadata>        
24        </transfer>
25        <transfer>
26          <idTransfer>2</idTransfer>
27          <transferAmount>10.00</transferAmount>
28          <fiscalCodePA>77777777778</fiscalCodePA>
29          <IBAN>IT0000000000000000000000001</IBAN>
30          <remittanceInformation>remittanceInformation2</remittanceInformation>
31        </transfer>
32        <metadata>
33          <mapEntry>
34            <key>keytest2</key>
35            <value>2</value>
36          </mapEntry>
37        </metadata> 
38      </transferList>
39      <creditorReferenceId>11111111112222222</creditorReferenceId>
40    </nfpsp:activatePaymentNoticeRes>
41  </soapenv:Body>
42</soapenv:Envelope>
43

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
entityUniqueIdentifierType*	String	F : Persona fisica G : Persona giuridica
idempotencyKey	String	Chiave di idempotenza.

1  <soapenv:Envelope>
2    <soapenv:Body>
3        <nod:sendPaymentOutcomeReq>
4          <idPSP>88888888888</idPSP>
5          <idBrokerPSP>88888888888</idBrokerPSP>
6          <idChannel>88888888888_01</idChannel>
7          <password>**********</password>
8          <idempotencyKey>70000000001_100149bdWB</idempotencyKey>
9          <paymentToken>c110729d258c4ab1b765fe902aae41d6</paymentToken>
10          <outcome>OK</outcome>
11          <details>
12              <paymentMethod>creditCard</paymentMethod>
13              <paymentChannel>app</paymentChannel>
14              <fee>2.00</fee>
15              <payer>
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              </payer>
29              <applicationDate>2021-10-01</applicationDate>
30              <transferDate>2021-10-02</transferDate>
31          </details>
32        </nod:sendPaymentOutcomeReq>
33    </soapenv:Body>
34  </soapenv:Envelope>
35

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.

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
entityUniqueIdentifierType*	String	F : Persona fisica G : Persona giuridica
paymentTokens*	String	sequence che contiene tutti i tokens
idempotencyKey	String	Chiave di idempotenza

1  <soapenv:Envelope>
2    <soapenv:Body>
3        <nod:sendPaymentOutcomeReq>
4          <idPSP>88888888888</idPSP>
5          <idBrokerPSP>88888888888</idBrokerPSP>
6          <idChannel>88888888888_01</idChannel>
7          <password>**********</password>
8          <idempotencyKey>70000000001_100149bdWB</idempotencyKey>
9          <paymentTokens>
10              <paymentToken>d221820d258c4ab1b765fe902aae6d14</paymentToken>
11              <paymentToken>c110729d258c4ab1b765fe902aae41d6</paymentToken>
12          </paymentTokens>
13          <outcome>OK</outcome>
14          <details>
15              <paymentMethod>creditCard</paymentMethod>
16              <paymentChannel>app</paymentChannel>
17              <fee>2.00</fee>
18              <payer>
19                <uniqueIdentifier>
20                    <entityUniqueIdentifierType>F</entityUniqueIdentifierType>
21                    <entityUniqueIdentifierValue>JHNDOE00A01F205N</entityUniqueIdentifierValue>
22                </uniqueIdentifier>
23                <fullName>John Doe</fullName>
24                <streetName>street</streetName>
25                <civicNumber>12</civicNumber>
26                <postalCode>89020</postalCode>
27                <city>city</city>
28                <stateProvinceRegion>MI</stateProvinceRegion>
29                <country>IT</country>
30                <e-mail>john.doe@test.it</e-mail>
31              </payer>
32              <applicationDate>2021-10-01</applicationDate>
33              <transferDate>2021-10-02</transferDate>
34          </details>
35        </nod:sendPaymentOutcomeReq>
36    </soapenv:Body>
37  </soapenv:Envelope>
38

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.

1    <soapenv:Envelope>
2      <soapenv:Body>
3          <pspfn:pspNotifyPaymentReq>
4            <idPSP>88888888888</idPSP>
5            <idBrokerPSP>88888888888</idBrokerPSP>
6            <idChannel>88888888888_01</idChannel>
7            <paymentDescription>test</paymentDescription>
8            <fiscalCodePA>77777777777</fiscalCodePA>
9            <companyName>company EC</companyName>
10            <officeName>office EC</officeName>                        
11            <paymentToken>ac6536ab9967401fb6cfa98bef88ccf0</paymentToken>
12            <creditorReferenceId>11111111112222222</creditorReferenceId>
13            <debtAmount>30.00</debtAmount>
14            <transferList>
15                <transfer>
16                  <idTransfer>1</idTransfer>
17                  <transferAmount>20.00</transferAmount>
18                  <fiscalCodePA>77777777777</fiscalCodePA>
19                  <IBAN>IT0000000000000000000000000</IBAN>
20                  <remittanceInformation>info remittance</remittanceInformation>
21                </transfer>
22                <transfer>
23                  <idTransfer>2</idTransfer>
24                  <transferAmount>10.00</transferAmount>
25                  <fiscalCodePA>77777777778</fiscalCodePA>
26                  <IBAN>IT0000000000000000000000001</IBAN>
27                  <remittanceInformation>info remittance</remittanceInformation>
28                </transfer>
29            </transferList>
30            
31            <!-- dati specifici del canale di pagamento -->
32            
33          </pspfn:pspNotifyPaymentReq>
34      </soapenv:Body>
35    </soapenv:Envelope>
36

Carta di credito

1<creditCardPayment>
2    <rrn>11223344</rrn>
3    <outcomePaymentGateway>00</outcomePaymentGateway>
4    <totalAmount>31.00</totalAmount>
5    <fee>1.00</fee>
6    <timestampOperation>2021-07-09T17:06:03</timestampOperation>
7    <authorizationCode>123456</authorizationCode>
8</creditCardPayment>
9

Paypal

1<paypalPayment> 
2    <transactionId>11223344</transactionId>
3    <pspTransactionId>00</pspTransactionId>
4    <totalAmount>31.00</totalAmount>
5    <fee>1.00</fee>
6    <timestampOperation>2021-07-09T17:06:03</timestampOperation>
7</paypalPayment>
8

Bancomat Pay

1<bancomatpayPayment> 
2    <transactionId>11223344</transactionId>
3    <outcomePaymentGateway>00</outcomePaymentGateway>
4    <totalAmount>31.00</totalAmount>
5    <fee>1.00</fee>
6    <timestampOperation>2021-07-09T17:06:03</timestampOperation>
7    <authorizationCode>123456</authorizationCode>
8    <paymentGateway></paymentGateway>
9</bancomatpayPayment>
10

Altri canali di pagamento

1<additionalPaymentInformations>
2    <metadata>
3        <mapEntry>
4            <key>keytest</key>
5            <value>1</value>
6        </mapEntry>
7    </metadata>
8</additionalPaymentInformations>
9

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.

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.
additionalPaymentList*	String
mapEntry*	String
key*	String
value*	String

1<soapenv:Envelope>
2      <soapenv:Body>
3          <pspfn:pspNotifyPaymentReq>
4            <idPSP>CIPBITMM</idPSP>
5            <idBrokerPSP>13212880150</idBrokerPSP>
6            <idChannel>13212880150_02</idChannel>
7            <paymentList>
8              <payment>
9                <paymentDescription>test</paymentDescription>
10                <fiscalCodePA>77777777777</fiscalCodePA>
11                <companyName>company EC</companyName>
12                <officeName>office EC</officeName>                        
13                <paymentToken>ac6536ab9967401fb6cfa98bef88ccf0</paymentToken>
14                <creditorReferenceId>11111111112222222</creditorReferenceId>
15                <debtAmount>30.00</debtAmount>
16                <transferList>
17                  <transfer>
18                    <idTransfer>1</idTransfer>
19                    <transferAmount>20.00</transferAmount>
20                    <fiscalCodePA>77777777777</fiscalCodePA>
21                    <IBAN>IT0000000000000000000000000</IBAN>
22                    <remittanceInformation>info remittance</remittanceInformation>
23                    <metadata>
24                      <mapEntry>
25                        <key>yyyy</key>
26                        <value>abcde</value>
27                      </mapEntry> 
28                    </metadata>
29                  </transfer>
30                  <transfer>
31                    <idTransfer>2</idTransfer>
32                    <transferAmount>10.00</transferAmount>
33                    <fiscalCodePA>77777777778</fiscalCodePA>
34                    <IBAN>IT0000000000000000000000001</IBAN>
35                    <remittanceInformation>info remittance</remittanceInformation>
36                  </transfer>
37                </transferList> 
38                <metadata>
39                  <mapEntry>
40                    <key>zzzz</key>
41                    <value>g2f3</value>
42                  </mapEntry> 
43                </metadata>
44              </payment>
45            </paymentList>                       
46            <additionalPaymentInformations>
47              <mapEntry>
48                <key>xxxx</key>
49                <value>1234546</value>
50              </mapEntry> 
51            </additionalPaymentInformations>
52          </pspfn:pspNotifyPaymentReq>
53      </soapenv:Body>
54    </soapenv:Envelope>    
55

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 https://github.com/pagopa/pagopa-api .
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.

1<soap:Envelope>
2  <soap:Body>
3    <ns3:demandPaymentNoticeReq>
4      <idPSP>88888888888</idPSP>
5      <idBrokerPSP>88888888888</idBrokerPSP>
6      <idChannel>88888888888_01</idChannel>
7      <password>**********</password>
8      <idSoggettoServizio>00003</idServizio>
9      <datiSpecificiServizio>Dati del servizio base64 encoded</datiSpecificiServizio>
10    </ns3:demandPaymentNoticeReq>
11  </soap:Body>
12</soap:Envelope>
13

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

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.

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      <datiSpecificiServizio>Dati del servizio base64 encoded</datiSpecificiServizio>
9    </ppt:paDemandPaymentNoticeReq>
10  </soapenv:Body>
11</soapenv:Envelope>
12

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

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.

1<soap:Envelope>
2    <soap:Body>
3        <ns5:nodoInviaFlussoRendicontazione>
4            <identificativoPSP>88888888888</identificativoPSP>
5            <identificativoIntermediarioPSP>88888888888</identificativoIntermediarioPSP>
6            <identificativoCanale>88888888888_01</identificativoCanale>
7            <password>**********</password>
8            <identificativoDominio>77777777777</identificativoDominio>
9            <identificativoFlusso>2021-11-2188888888888-AABB648200001295</identificativoFlusso>
10            <dataOraFlusso>2021-11-22T00:37:32</dataOraFlusso>
11            <xmlRendicontazione>Flusso di riversamento base64 encoded</xmlRendicontazione>
12        </ns5:nodoInviaFlussoRendicontazione>
13    </soap:Body>
14</soap:Envelope>
15

1<soapenv:Envelope>
2    <soapenv:Body>
3        <ppt:nodoInviaFlussoRendicontazioneRisposta>
4            <esito>OK</esito>
5        </ppt:nodoInviaFlussoRendicontazioneRisposta>
6    </soapenv:Body>
7</soapenv:Envelope>
8

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

nodoChiediInformativaPA

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.

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

1<soapenv:Envelope>
2    <soapenv:Body>
3        <ppt:nodoChiediInformativaPARisposta>
4            <esito>OK</esito>
5            <xmlInformativa>Informativa base64 encoded</xmlInformativa>
6        </ppt:nodoChiediInformativaPARisposta>
7    </soapenv:Body>
8</soapenv:Envelope>
9

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.

1<soap:Envelope>
2    <soap:Body>
3        <ns5:nodoChiediCatalogoServizi>
4            <identificativoPSP>88888888888</identificativoPSP>
5            <identificativoIntermediarioPSP>88888888888</identificativoIntermediarioPSP>
6            <identificativoCanale>88888888888_01</identificativoCanale>
7            <password>**********</password>
8            <identificativoDominio>77777777777</identificativoDominio>
9            <categoria>Donazioni</categoria>
10            <commissione>N</commissione>
11        </ns5:nodoChiediCatalogoServizi>
12    </soap:Body>
13</soap:Envelope>
14

1<soapenv:Envelope>
2    <soapenv:Body>
3        <nodoChiediCatalogoServizi>
4            <esito>OK</esito>
5            <xmlCatalogoServizi>Catalogo dei servizi base64 encoded</xmlCatalogoServizi>
6        </nodoChiediCatalogoServizi>
7    </soapenv:Body>
8</soapenv:Envelope>
9

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.

1<soap:Envelope>
2    <soap:Body>
3        <ns5:nodoChiediTemplateInformativaPSP>
4            <identificativoPSP>88888888888</identificativoPSP>
5            <identificativoIntermediarioPSP>88888888888</identificativoIntermediarioPSP>
6            <identificativoCanale>88888888888_01</identificativoCanale>
7            <password>**********</password>
8        </ns5:nodoChiediTemplateInformativaPSP>
9    </soap:Body>
10</soap:Envelope>
11

1<soapenv:Envelope>
2    <soapenv:Body>
3        <nodoChiediTemplateInformativaPSP>
4            <esito>OK</esito>
5            <xmlTemplateInformativa>Template informativa base64 encoded</xmlTemplateInformativa>
6        </nodoChiediTemplateInformativaPSP>
7    </soapenv:Body>
8</soapenv:Envelope>
9

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