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

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      <standin>false</standin>
17    </nfpsp:verifyPaymentNoticeRes>
18  </soapenv:Body>
19</soapenv:Envelope> 
20

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      <standin>false</standin>
20    </nfpsp:verificaBollettinoRes>
21  </soapenv:Body>
22</soapenv:Envelope>
23

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	Se presente, rappresenta la data di scadenza del pagamento secondo il formato ISO 8601 [AAAA]-[MM]-[GG]. Per maggiori informazioni, consulta le Best Practice.
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      <standin>false</standin>
29    </nfpsp:activatePaymentNoticeRes>
30  </soapenv:Body>
31</soapenv:Envelope>
32

activatePaymentNotice versione 2

POST

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

Request Body

Name	Type	Description
idPSP*	String	Identificativo del PSP, assegnato da PagoPA. Il codice è generalmente rappresentato dal codice BIC (Bank Identifier Code) del PSP. In assenza del codice BIC, o per gestire situazioni particolari, può essere utilizzato un altro codice, purché identifichi in modo univoco il PSP.
idBrokerPSP*	String	Identificativo dell'intermediario, assegnato da PagoPA. Identificazione dell'intermediario/broker del PSP che fornisce l'accesso (canale) al PSP per l'erogazione del servizio. Nota: l'intermediario/broker può coincidere con il PSP stesso.
idChannel*	String	Identificativo del canale, identifica una categoria di servizio di pagamento e attraverso la quale viene effettuata la transazione. Un identificatore di canale appartiene a un solo intermediario/broker PSP e di conseguenza deve essere univoco rispetto al PSP.
qrCode*	String	E' composto da fiscalCode e noticeNumber.
fiscalCode*	String	Codice fiscale dell'EC.
noticeNumber*	String	[auxDigit][segregationCode][IUVBase][IUVCheckDigit]
password*	String	Password del canale, assegnata da PagoPA.
idempotencyKey		Chiave di idempotenza
expirationTime	String	Tempo di scadenza del token ( ms ), max 30 minuti. La durata del token di pagamento può essere impostata in 2 modi: - Implicitamente dalla piattaforma pagoPA, se non è impostato nella richiesta di activatePaymentNotice (valore di default durata = 30 minuti) - Esplicitamente dal PSP, se impostato in richiesta all'activatePaymentNotice
paymentNote	String	Testo libero per descrivere l'oggetto del pagamento
dueDate	String	Se presente, rappresenta la data di scadenza del pagamento secondo il formato ISO 8601 [AAAA]-[MM]-[GG]. Per maggiori informazioni, consulta le Best Practice.
amount*	String	Importo in euro
allCCP	String	ad uso interno per i servizi PagoPA
	String
paymentMethod	String	metodo di pagamento
touchPoint	String	touchpoint utilizzato per il pagamento (es. POS fisico, ATM, ..)

1  <soapenv:Envelope>
2    <soapenv:Body>
3      <nod:activatePaymentNoticeV2Request>
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:activatePaymentNoticeV2Request>
16    </soapenv:Body>
17  </soapenv:Envelope>
18

1<soapenv:Envelope>
2  <soapenv:Body>
3    <nfpsp:activatePaymentNoticeV2Response>
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          <companyName>Test EC</companyName>
17          <IBAN>IT0000000000000000000000000</IBAN>
18          <remittanceInformation>remittanceInformation1</remittanceInformation>
19          <metadata>
20            <mapEntry>
21              <key>keytest1</key>
22              <value>1</value>
23            </mapEntry>
24          </metadata>        
25        </transfer>
26        <transfer>
27          <idTransfer>2</idTransfer>
28          <transferAmount>10.00</transferAmount>
29          <fiscalCodePA>77777777778</fiscalCodePA>
30          <companyName>Test EC 2</companyName>
31          <IBAN>IT0000000000000000000000001</IBAN>
32          <remittanceInformation>remittanceInformation2</remittanceInformation>
33        </transfer>
34        <metadata>
35          <mapEntry>
36            <key>keytest2</key>
37            <value>2</value>
38          </mapEntry>
39        </metadata> 
40      </transferList>
41      <creditorReferenceId>11111111112222222</creditorReferenceId>
42      <suggestedUserFee>1.00</suggestedUserFee>
43      <suggestedPaFee>0.50</suggestedPaFee>
44      <suggestedIdBundle>1</suggestedIdBundle>
45      <suggestedIdCiBundle>2</suggestedIdCiBundle>
46      <standin>false</standin>
47    </nfpsp:activatePaymentNoticeV2Response>
48  </soapenv:Body>
49</soapenv:Envelope>
50

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

sendPaymentOutcome

sendPaymentOutcome versione 1

POST

Request Body

Name	Type	Description
idPSP*	String	identificativo del PSP, assegnato da PagoPA. Il codice è generalmente rappresentato dal codice BIC (Bank Identifier Code) del PSP. In assenza del codice BIC, o per gestire situazioni particolari, può essere utilizzato un altro codice, purché identifichi in modo univoco il PSP.
details	String	Dettagli del risultato dell'operazione, da inserire obbligatoriamente in caso di outcome OK
outcome*	String	Il risultato dell'operazione che può contenere i seguenti codici OK : operazione eseguita con successo KO : operazione terminata con errore
paymentToken*	String	Viene generato dal sistema durante la fase di attivazione del pagamento, è l'identificatore di correlazione da abbinare all'attivazione e all'esito del pagamento.
password*	String	Password del canale, assegnata da PagoPA.
idChannel*	String	identificativo del canale, identifica una categoria di servizio di pagamento e attraverso la quale viene effettuata la transazione. Un identificatore di canale appartiene a un solo intermediario/broker PSP e di conseguenza deve essere univoco rispetto al PSP.
idBrokerPSP*	String	identificativo dell'intermediario, assegnato da PagoPA. Identificazione dell'intermediario/broker del PSP che fornisce l'accesso (canale) al PSP per l'erogazione del servizio. Nota: l'intermediario/broker può coincidere con il PSP stesso.
payer	String	individua il pagatore
fee*	String	importo della commissione pagata in euro
paymentChannel	String	canale di pagamento enum: "frontOffice" "atm" "onLine" "app" "other"
paymentMethod*	String	metodo di pagamento enum: "cash" "creditCard" "bancomat" "other"
transferDate*	String	data del riversamento verso l'EC
applicationDate*	String	data applicativa del pagamento
e-mail	String
country	String
stateProvinceRegion	String
city	String
postalCode	String
civicNumber	String
streetName	String
fullName*	String	nome completo del pagatore
uniqueIdentifier*	String
entityUniqueIdentifierValue*	String	codice fiscale o partita IVA, nel caso non siano disponibili è possibile utilizzare 'ANONIMO'
entityUniqueIdentifierType*	String	F : Persona fisica G : Persona giuridica
idempotencyKey	String	Chiave di idempotenza.

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, inoltre sono gestite le informazioni ricavate da Gestione evoluta commissionie il servizio @e.bollo.

Request Body

Name	Type	Description
idPSP*	String	Identificativo del PSP, assegnato da PagoPA. Il codice è generalmente rappresentato dal codice BIC (Bank Identifier Code) del PSP. In assenza del codice BIC, o per gestire situazioni particolari, può essere utilizzato un altro codice, purché identifichi in modo univoco il PSP.
details	String	dettagli del risultato dell'operazione, da inserire obbligatoriamente in caso di outcome OK
outcome*	String	il risultato dell'operazione che può contenere i seguenti codici OK : operazione eseguita con successo KO : operazione terminata con errore
paymentToken*	String	viene generato dal sistema durante la fase di attivazione del pagamento, è l'identificatore di correlazione da abbinare all'attivazione e all'esito del pagamento
password*	String	Password del canale, assegnata da PagoPA.
idChannel*	String	Identificativo del canale, identifica una categoria di servizio di pagamento e attraverso la quale viene effettuata la transazione. Un identificatore di canale appartiene a un solo intermediario/broker PSP e di conseguenza deve essere univoco rispetto al PSP.
idBrokerPSP*	String	Identificativo dell'intermediario, assegnato da PagoPA. Identificazione dell'intermediario/broker del PSP che fornisce l'accesso (canale) al PSP per l'erogazione del servizio. Nota: l'intermediario/broker può coincidere con il PSP stesso.
payer	String	individua il pagatore
fee*	String	importo della commissione pagata in euro
paymentChannel	String	canale di pagamento enum: "frontOffice" "atm" "onLine" "app" "other"
paymentMethod*	String	metodo di pagamento enum: "cash" "creditCard" "bancomat" "other"
transferDate*	String	data del riversamento verso l'EC
applicationDate*	String	data applicativa del pagamento
e-mail	String
country	String
stateProvinceRegion	String
city	String
postalCode	String
civicNumber	String
streetName	String
fullName*	String	nome completo del pagatore
uniqueIdentifier*	String
entityUniqueIdentifierValue*	String	codice fiscale o partita IVA, nel caso non siano disponibili è possibile utilizzare 'ANONIMO'
entityUniqueIdentifierType*	String	F : Persona fisica G : Persona giuridica
paymentTokens*	String	sequence che contiene tutti i tokens
idempotencyKey	String	Chiave di idempotenza
idCiBundle	String	identificativo degli attributi aggiunti dall'EC al pacchetto di Gestione evoluta commissioni
idBundle	String	identificativo del pacchetto di Gestione evoluta commissioni
primaryCiIncurredFee	String	importo della commissione a carico dell'EC espresso in euro ricavato da Gestione evoluta commissioni
marcheDaBollo	String	La lista delle marche da bollo digitali gestite nella transazione di pagamento
paymentToken	String	Il paymentToken con cui è arrivata la richiesta di marca da bollo digitale
idTransfer	String	L'identificativo del transfer che contiene il dato richiestaMarcaDaBollo
MBDAttachment	String	Il documento XML che contiene la marca da bollo digitale, nel formato base64
marcaDaBollo	String	I dati di ogni singola marca da bollo digitale

1  <soapenv:Envelope>
2    <soapenv:Body>
3        <nod:sendPaymentOutcomeV2Request>
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              <primaryCiIncurredFee>0.50</primaryCiIncurredFee>
19              <idBundle>1</idBundle>
20              <idCiBundle>2</idCiBundle>
21              <payer>
22                <uniqueIdentifier>
23                    <entityUniqueIdentifierType>F</entityUniqueIdentifierType>
24                    <entityUniqueIdentifierValue>JHNDOE00A01F205N</entityUniqueIdentifierValue>
25                </uniqueIdentifier>
26                <fullName>John Doe</fullName>
27                <streetName>street</streetName>
28                <civicNumber>12</civicNumber>
29                <postalCode>89020</postalCode>
30                <city>city</city>
31                <stateProvinceRegion>MI</stateProvinceRegion>
32                <country>IT</country>
33                <e-mail>john.doe@test.it</e-mail>
34              </payer>
35              <applicationDate>2021-10-01</applicationDate>
36              <transferDate>2021-10-02</transferDate>
37          </details>
38        </nod:sendPaymentOutcomeV2Request>
39    </soapenv:Body>
40  </soapenv:Envelope>
41

pspNotifyPayment

pspNotifyPayment versione 1

POST

Request Body

Name	Type	Description
fiscalCodePA*	String	Codice fiscale dell'EC.
paymentToken*	String	Viene generato dal sistema durante la fase di attivazione del pagamento, è l'identificatore di correlazione da abbinare all'attivazione e all'esito del pagamento.
idPSP*	String	Identificativo del PSP, assegnato da PagoPA. Il codice è generalmente rappresentato dal codice BIC (Bank Identifier Code) del PSP. In assenza del codice BIC, o per gestire situazioni particolari, può essere utilizzato un altro codice, purché identifichi in modo univoco il PSP.
idChannel*	String	Identificativo del canale, identifica una categoria di servizio di pagamento e attraverso la quale viene effettuata la transazione. Un identificatore di canale appartiene a un solo intermediario/broker PSP e di conseguenza deve essere univoco rispetto al PSP.
creditorReferenceId*	String	IUV Identificativo Univoco Versamento.
companyName*	String	Nome completo dell'EC.
officeName	String	Nome completo dell'ufficio dell'EC.
idBrokerPSP*	String	Identificativo dell'intermediario, assegnato da PagoPA. Identificazione dell'intermediario/broker del PSP che fornisce l'accesso (canale) al PSP per l'erogazione del servizio. Nota: l'intermediario/broker può coincidere con il PSP stesso.
debtAmount*	String	Rappresenta la somma degli importi dei singoli transfer.
paymentDescription*	String	Testo libero per descrivere l'oggetto del pagamento.
remittanceInformation*	String	Motivo del pagamento.
IBAN*	String	IBAN sul quale sarà effettuato il riversamento
fiscalCodePA*	String	Codice fiscale dell'EC.
transferAmount*	String	Importo
idTransfer*	String	Indice della lista (da 1 a 5).
transfer*	String
transferList*	String	Struttura che contiene i dettagli dei transfer pagamento, al momento i transfer possono essere al massimo 5.
dati specifici del canale di pagamento	String	Struttura dati specifica del canale di pagamento utilizzato.
standin	Boolean	true se pagamento eseguito in standin

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            <standin>false</standin>
34          </pspfn:pspNotifyPaymentReq>
35      </soapenv:Body>
36    </soapenv:Envelope>
37

Carta di credito (dismissione 30/04/2023)

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 e gestire il servizio @e.bollo.

Request Body

Name	Type	Description
fiscalCodePA*	String	Codice fiscale dell'EC.
paymentToken*	String	Viene generato dal sistema durante la fase di attivazione del pagamento, è l'identificatore di correlazione da abbinare all'attivazione e all'esito del pagamento.
idPSP*	String	Identificativo del PSP, assegnato da PagoPA. Il codice è generalmente rappresentato dal codice BIC (Bank Identifier Code) del PSP. In assenza del codice BIC, o per gestire situazioni particolari, può essere utilizzato un altro codice, purché identifichi in modo univoco il PSP.
idChannel*	String	Identificativo del canale, identifica una categoria di servizio di pagamento e attraverso la quale viene effettuata la transazione. Un identificatore di canale appartiene a un solo intermediario/broker PSP e di conseguenza deve essere univoco rispetto al PSP.
creditorReferenceId*	String	IUV Identificativo Univoco Versamento.
companyName*	String	Nome completo dell'EC.
officeName	String	Nome completo dell'ufficio dell'EC.
idBrokerPSP*	String	Identificativo dell'intermediario, assegnato da PagoPA. Identificazione dell'intermediario/broker del PSP che fornisce l'accesso (canale) al PSP per l'erogazione del servizio. Nota: l'intermediario/broker può coincidere con il PSP stesso.
debtAmount*	String	Rappresenta la somma degli importi dei singoli transfer.
paymentDescription*	String	Testo libero per descrivere l'oggetto del pagamento.
remittanceInformation*	String	Motivo del pagamento.
IBAN	String	IBAN sul quale sarà effettuato il riversamento
fiscalCodePA*	String	Codice fiscale dell'EC.
transferAmount*	String	Importo
idTransfer*	String	Indice della lista (da 1 a 5).
transfer*	String
transferList*	String	Struttura che contiene i dettagli dei transfer pagamento, al momento i transfer possono essere al massimo 5.
payment*	String
paymentList*	String	Lista dei pagamenti.
additionalPaymentInformations	String	Struttura che contiene i dati specifici del canale di pagamento utilizzato.
mapEntry*	String
key*	String
value*	String
CHOICE*	String	Choice tra IBAN e richiestaMarcaDaBollo
provinciaResidenza	String	Sigla automobilistica della provincia di residenza del soggetto pagatore
hashDocumento	String	Impronta informatica (digest), nel formato base64, del documento informatico o della segnatura di protocollo cui è associata la marca da bollo digitale
tipoBollo	String	Tipologia del bollo
richiestaMarcaDaBollo	String	I dati della richiesta della marca da bollo
transactionId*	String	Identificativo dell'operazione di pagamento.
fee*	String	Importo della commissione.
totalAmount*	String	Rappresenta la somma pagata dall'utente, comprensiva di commissione.
timestampOperation*	String	Timestamp dell'operazione di pagamento.
IdCiBundle	String	identificativo degli attributi aggiunti dall'EC al pacchetto associato a Gestione evoluta commissioni
IdBundle	String	identificativo del pacchetto associato a Gestione evoluta commissioni
primaryCiIncurredFee	String	importo della commissione a carico dell'EC espresso in euro associato a Gestione evoluta commissioni
standin	Boolean	true se pagamento eseguito in standin
companyName	String	codice fiscale dell'EC

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

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

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

nodoChiediCatalogoServizi

nodoChiediCatalogoServizi versione 2

POST

Request Body

Name	Type	Description
identificativoPSP*	String	Identificativo del PSP, assegnato da PagoPA. Il codice è generalmente rappresentato dal codice BIC (Bank Identifier Code) del PSP. In assenza del codice BIC, o per gestire situazioni particolari, può essere utilizzato un altro codice, purché identifichi in modo univoco il PSP.
identificativoDominio	String	Codice fiscale dell'EC.
password*	String	Password del canale, assegnata da PagoPA.
identificativoCanale*	String	Identificativo del canale, identifica una categoria di servizio di pagamento e attraverso la quale viene effettuata la transazione. Un identificatore di canale appartiene a un solo intermediario/broker PSP e di conseguenza deve essere univoco rispetto al PSP.
identificativoIntermediarioPSP*	String	Identificativo dell'intermediario, assegnato da PagoPA. Identificazione dell'intermediario/broker del PSP che fornisce l'accesso (canale) al PSP per l'erogazione del servizio. Nota: l'intermediario/broker può coincidere con il PSP stesso.
categoria	String	Filtro in base alla categoria dei servizi.
commissione	String	Filtro in base al consiglio di applicare o meno le commissioni inserite dall'EC che ha creato il servizio.

1<soap:Envelope>
2    <soap:Body>
3        <ns5:nodoChiediCatalogoServiziV2Request>
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:nodoChiediCatalogoServiziV2Request>
12    </soap:Body>
13</soap:Envelope>
14

1<soapenv:Envelope>
2    <soapenv:Body>
3        <nodoChiediCatalogoServiziV2Response>
4            <esito>OK</esito>
5            <xmlCatalogoServizi>Catalogo dei servizi base64 encoded</xmlCatalogoServizi>
6        </nodoChiediCatalogoServiziV2Response>
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

In questa pagina

verifyPaymentNotice

verificaBollettino

activatePaymentNotice

activatePaymentNotice versione 1

activatePaymentNotice versione 2

sendPaymentOutcome

sendPaymentOutcome versione 1

sendPaymentOutcome versione 2

pspNotifyPayment

pspNotifyPayment versione 1

pspNotifyPayment versione 2

demandPaymentNotice

nodoInviaFlussoRendicontazione

nodoChiediCatalogoServizi

nodoChiediCatalogoServizi versione 2

nodoChiediTemplateInformativaPSP

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