DevPortalPagoPA



Tabella dei contenuti

Primitive

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

paVerifyPaymentNotice

paVerifyPaymentNotice

POST
Request Body
NameTypeDescription
idPA*Stringcodice fiscale della struttura che invia la richiesta di pagamento
idBrokerPA*Stringidentificativo del soggetto che opera come intermediario per l'EC
idStation*Stringidentificativo della stazione dell'EC nel sistema pagoPa
qrCode*Stringè composto da fiscalCode e noticeNumber
fiscalCode*Stringcodice 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

paGetPayment

paGetPayment versione 1

POST
Request Body
NameTypeDescription
idPA*StringCodice fiscale della struttura che invia la richiesta di pagamento.
dueDateStringData di scadenza del pagamento secondo il formato ISO 8601 [AAAA]-[MM]-[GG].
transferTypeStringValore ammesso: POSTAL.
paymentNoteStringDescrizione del pagamento. Valorizzato con idCart, nel caso il parametro venisse valorizzato nel Pagamento presso frontend dell'EC
amountStringImporto del pagamento in euro.
noticeNumber*String[auxDigit][segregationCode][IUVBase][IUVCheckDigit]
fiscalCode*StringCodice fiscale dell'EC.
qrCode*StringE' composto da fiscalCode e noticeNumber.
idStation*StringIdentificativo della stazione dell'EC nel sistema pagoPa.
idBrokerPA*StringIdentificativo 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

paGetPayment versione 2

POST
In questa versione è possibile inserire i metadata in ogni singolo transfer, inoltre è possibile gestire il servizio @e.bollo.
Request Body
NameTypeDescription
idPA*StringCodice fiscale della struttura che invia la richiesta di pagamento.
idBrokerPA*StringIdentificativo del soggetto che opera come intermediario per l'EC.
idStation*StringIdentificativo della stazione dell'EC nel sistema pagoPa.
qrCode*StringE' composto da fiscalCode e noticeNumber.
amount*StringImporto del pagamento in euro
paymentNoteStringDescrizione del pagamento. Valorizzato con idCart, nel caso il parametro venisse valorizzato nel Pagamento presso frontend dell'EC
transferTypeStringValori ammessiPOSTALPAGOPA
dueDateStringdata di scadenza del pagamento secondo il formato ISO 8601 [AAAA]-[MM]-[GG]
fiscalCode*Stringcodice 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

paSendRT

paSendRT versione 1

POST
Request Body
NameTypeDescription
idPA{% mark style="color:red;" %}*{% /mark %}Stringcodice fiscale della struttura che invia la richiesta di pagamento
idBrokerPA{% mark style="color:red;" %}*{% /mark %}Stringidentificativo del soggetto che opera come intermediario per l'EC
idStation{% mark style="color:red;" %}*{% /mark %}Stringidentificativo della stazione dell'EC nel sistema pagoPa
receipt{% mark style="color:red;" %}*{% /mark %}Stringla ricevuta di pagamento
receiptId{% mark style="color:red;" %}*{% /mark %}Stringidentificatore univoco della receipt contiene il paymentToken assegnato da pagoPa
noticeNumber{% mark style="color:red;" %}*{% /mark %}String[auxDigit][segregationCode][IUVBase][IUVCheckDigit]
fiscalCode{% mark style="color:red;" %}*{% /mark %}Stringcodice fiscale dell'EC
outcome{% mark style="color:red;" %}*{% /mark %}Stringil risultato dell'operazione che può contenere i codici OK o KO
creditorReferenceId{% mark style="color:red;" %}*{% /mark %}StringIUV Identificativo Univoco Versamento
paymentAmount{% mark style="color:red;" %}*{% /mark %}Stringimporto espresso in euro
description{% mark style="color:red;" %}*{% /mark %}String
companyNameStringnome completo dell'EC
officeNameString
debtor{% mark style="color:red;" %}*{% /mark %}Stringindividua il debitore a cui si riferisce la posizione debitoria
uniqueIdentifier{% mark style="color:red;" %}*{% /mark %}String
entityUniqueIdentifierType{% mark style="color:red;" %}*{% /mark %}StringF : Persona fisicaG : Persona giuridica
entityUniqueIdentifierValue{% mark style="color:red;" %}*{% /mark %}Stringcodice fiscale o partita IVA
e-mailString
countryString
stateProvinceRegionString
cityString
postalCodeString
civicNumberString
streetNameString
fullName{% mark style="color:red;" %}*{% /mark %}Stringnome completo del debitore
transferList{% mark style="color:red;" %}*{% /mark %}Stringstruttura che contiene i dettagli dei transfer
transfer{% mark style="color:red;" %}*{% /mark %}String
idTransfer{% mark style="color:red;" %}*{% /mark %}Stringindice della lista (da 1 a 5)
fiscalCodePA{% mark style="color:red;" %}*{% /mark %}Stringcodice fiscale dell'EC
transferAmount{% mark style="color:red;" %}*{% /mark %}Stringimporto
IBAN{% mark style="color:red;" %}*{% /mark %}StringIBAN sul quale sarà effettuato il riversamento
remittanceInformation{% mark style="color:red;" %}*{% /mark %}Stringmotivo del pagamento
transferCategory{% mark style="color:red;" %}*{% /mark %}Stringcodice tassonomico, composto da Codice tipo Ente Creditore + Progressivo macro area + Codice tipologia servizio + Motivo Giuridico ( ex. 0101002IM )
idPSP{% mark style="color:red;" %}*{% /mark %}Stringidentificativo del PSP
pspFiscalCodeString
pspPartitaIVAString
PSPCompanyName{% mark style="color:red;" %}*{% /mark %}String
idChannel{% mark style="color:red;" %}*{% /mark %}String
channelDescription{% mark style="color:red;" %}*{% /mark %}String
payerStringindividua il pagatore
uniqueIdentifier{% mark style="color:red;" %}*{% /mark %}
entityUniqueIdentifierType{% mark style="color:red;" %}*{% /mark %}StringF : Persona fisicaG : Persona giuridica
entityUniqueIdentifierValue{% mark style="color:red;" %}*{% /mark %}Stringcodice fiscale o partita IVA
fullName{% mark style="color:red;" %}*{% /mark %}Stringnome completo del debitore
streetNameString
civicNumberString
postalCodeString
cityString
stateProvinceRegionString
countryString
e-mailString
paymentMethodString
feeStringimporto della commissione espresso in euro
paymentDateTimeStringdata e ora del pagamento
applicationDateStringdata applicativa
transferDateStringdata del riversamento
metadataString
mapEntry{% mark style="color:red;" %}*{% /mark %}
key{% mark style="color:red;" %}*{% /mark %}String
value{% mark style="color:red;" %}*{% /mark %}Stringidentificativo del PSP
standinBooleantrue: pagamento avvenuto in Stand in
1  <soapenv:Envelope>
2    <soapenv:Body>
3      <pafn:paSendRTReq>
4        <idPA>77777777777</idPA>
5        <idBrokerPA>77777777777</idBrokerPA>
6        <idStation>77777777777_01</idStation>
7        <receipt>
8          <receiptId>c110729d258c4ab1b765fe902aae41d6</receiptId>
9          <noticeNumber>311111111112222222</noticeNumber>
10          <fiscalCode>77777777777</fiscalCode>
11          <outcome>OK</outcome>
12          <creditorReferenceId>11111111112222222</creditorReferenceId>
13          <paymentAmount>30.00</paymentAmount>
14          <description>test</description>
15          <companyName>company EC</companyName>
16          <officeName>office EC</officeName>
17          <debtor>
18            <uniqueIdentifier>
19              <entityUniqueIdentifierType>F</entityUniqueIdentifierType>
20              <entityUniqueIdentifierValue>JHNDOE00A01F205N</entityUniqueIdentifierValue>
21            </uniqueIdentifier>
22            <fullName>John Doe</fullName>
23            <streetName>street</streetName>
24            <civicNumber>12</civicNumber>
25            <postalCode>89020</postalCode>
26            <city>city</city>
27            <stateProvinceRegion>MI</stateProvinceRegion>
28            <country>IT</country>
29            <e-mail>john.doe@test.it</e-mail>
30          </debtor>
31          <transferList>
32            <transfer>
33              <idTransfer>1</idTransfer>
34              <transferAmount>20.00</transferAmount>
35              <fiscalCodePA>77777777777</fiscalCodePA>
36              <IBAN>IT0000000000000000000000000</IBAN>
37              <remittanceInformation>remittanceInformation1</remittanceInformation>
38              <transferCategory>0101100IM</transferCategory>
39            </transfer>
40            <transfer>
41              <idTransfer>2</idTransfer>
42              <transferAmount>10.00</transferAmount>
43              <fiscalCodePA>77777777778</fiscalCodePA>
44              <IBAN>IT0000000000000000000000001</IBAN>
45              <remittanceInformation>remittanceInformation2</remittanceInformation>
46              <transferCategory>0201102IM</transferCategory>
47            </transfer>
48          </transferList>
49          <idPSP>88888888888</idPSP>
50          <pspFiscalCode>88888888888</pspFiscalCode>
51          <pspPartitaIVA>88888888888</pspPartitaIVA>
52          <PSPCompanyName>PSP name</PSPCompanyName>
53          <idChannel>88888888888_01</idChannel>
54          <channelDescription>app</channelDescription>
55          <payer>
56            <uniqueIdentifier>
57              <entityUniqueIdentifierType>F</entityUniqueIdentifierType>
58              <entityUniqueIdentifierValue>JHNDOE00A01F205N</entityUniqueIdentifierValue>
59            </uniqueIdentifier>
60            <fullName>John Doe</fullName>
61            <streetName>street</streetName>
62            <civicNumber>12</civicNumber>
63            <postalCode>89020</postalCode>
64            <city>city</city>
65            <stateProvinceRegion>MI</stateProvinceRegion>
66            <country>IT</country>
67            <e-mail>john.doe@test.it</e-mail>
68          </payer>
69          <paymentMethod>creditCard</paymentMethod>
70          <fee>2.00</fee>
71          <paymentDateTime>2021-10-01T17:48:22</paymentDateTime>
72          <applicationDate>2021-10-01</applicationDate>
73          <transferDate>2021-10-02</transferDate>
74          <metadata>
75            <mapEntry>
76              <key>keytest</key>
77              <value>1</value>
78            </mapEntry>
79          </metadata>
80          <standin>false</standin>
81        </receipt>
82      </pafn:paSendRTReq>
83    </soapenv:Body>
84  </soapenv:Envelope>
85

paSendRT versione 2

POST
In questa versione possono essere inseriti i metadata in ogni singolo transfer della receipt, inoltre sono gestite le informazioni ricavate da Gestione evoluta commissionie il servizio @e.bollo.
Request Body
NameTypeDescription
idPA*Stringcodice fiscale della struttura che invia la richiesta di pagamento
idBrokerPA*Stringidentificativo del soggetto che opera come intermediario per l'EC
idStation*Stringidentificativo della stazione dell'EC nel sistema pagoPa
receipt*Stringla ricevuta di pagamento
receiptId*Stringidentificatore univoco della receipt contiene il paymentToken assegnato da pagoPa
noticeNumber*String[auxDigit][segregationCode][IUVBase][IUVCheckDigit]
fiscalCode*Stringcodice fiscale dell'EC
outcome*Stringil risultato dell'operazione che può contenere i codici OK o KO
creditorReferenceId*StringIUV Identificativo Univoco Versamento
paymentAmount*Stringimporto espresso in euro
description*String
companyName*Stringnome completo dell'EC
officeNameString
debtor*Stringindividua il debitore a cui si riferisce la posizione debitoria
uniqueIdentifier*String
entityUniqueIdentifierType*StringF : Persona fisicaG : Persona giuridica
entityUniqueIdentifierValue*Stringcodice fiscale o partita IVA
fullName*Stringnome completo del debitore
streetNameString
civicNumberString
postalCodeString
cityString
stateProvinceRegionString
countryString
e-mailString
transferList*Stringstruttura che contiene i dettagli dei transfer
transfer*String
idTransfer*Stringindice della lista (da 1 a 5)
transferAmount*Stringimporto
fiscalCodePA*Stringcodice fiscale dell'EC
companyNameStringnome completo dell'EC
IBANStringIBAN sul quale sarà effettuato il riversamento
remittanceInformation*Stringmotivo del pagamento
transferCategory*Stringcodice tassonomico, composto da Codice tipo Ente Creditore + Progressivo macro area + Codice tipologia servizio + Motivo Giuridico ( ex. 0101002IM )
metadataString
mapEntryString
keyString
value*String
idPSP*Stringidentificativo del PSP
pspFiscalCodeString
pspPartitaIVAString
PSPCompanyName*String
idChannel*String
channelDescription*String
payerStringindividua il pagatore
uniqueIdentifier*String
entityUniqueIdentifierType*StringF : Persona fisicaG : Persona giuridica
entityUniqueIdentifierValue*Stringcodice fiscale o partita IVA
fullName*Stringnome completo del debitore
streetNameString
civicNumberString
postalCodeString
cityString
stateProvinceRegionString
countryString
e-mailString
paymentMethodString
feeStringimporto della commissione espresso in euro
primaryCiIncurredFeeStringimporto della commissione a carico dell'EC espresso in euro ricavato da Gestione evoluta commissioni
idBundleStringidentificativo del pacchetto di Gestione evoluta commissioni
idCiBundleStringidentificativo degli attributi aggiunti dall'EC al pacchetto di Gestione evoluta commissioni
paymentDateTimeStringdata e ora del pagamento
applicationDateStringdata applicativa
transferDateStringdata del riversamento
metadataString
mapEntryString
keyString
valueString
CHOICE*StringChoice tra IBAN e marcaDaBollo
tipoBolloStringTipologia del bollo
marcaDaBolloStringI dati della marca da bollo digitale
MBDAttachmentStringIl documento XML che contiene la marca da bollo digitale, nel formato base64.
paymentNoteStringDescrizione del pagamento. Valorizzato con idCart, nel caso il parametro venisse valorizzato nel Pagamento presso frontend dell'EC
standinBooleantrue: pagamento avvenuto in Stand in
1  <soapenv:Envelope>
2    <soapenv:Body>
3      <pafn:paSendRTReq>
4        <idPA>77777777777</idPA>
5        <idBrokerPA>77777777777</idBrokerPA>
6        <idStation>77777777777_01</idStation>
7        <receipt>
8          <receiptId>c110729d258c4ab1b765fe902aae41d6</receiptId>
9          <noticeNumber>311111111112222222</noticeNumber>
10          <fiscalCode>77777777777</fiscalCode>
11          <outcome>OK</outcome>
12          <creditorReferenceId>11111111112222222</creditorReferenceId>
13          <paymentAmount>30.00</paymentAmount>
14          <description>test</description>
15          <companyName>company EC1</companyName>
16          <officeName>office EC</officeName>
17          <debtor>
18            <uniqueIdentifier>
19              <entityUniqueIdentifierType>F</entityUniqueIdentifierType>
20              <entityUniqueIdentifierValue>JHNDOE00A01F205N</entityUniqueIdentifierValue>
21            </uniqueIdentifier>
22            <fullName>John Doe</fullName>
23            <streetName>street</streetName>
24            <civicNumber>12</civicNumber>
25            <postalCode>89020</postalCode>
26            <city>city</city>
27            <stateProvinceRegion>MI</stateProvinceRegion>
28            <country>IT</country>
29            <e-mail>john.doe@test.it</e-mail>
30          </debtor>
31          <transferList>
32            <transfer>
33              <idTransfer>1</idTransfer>
34              <transferAmount>20.00</transferAmount>
35              <fiscalCodePA>77777777777</fiscalCodePA>
36              <companyName>company EC1</companyName>
37              <IBAN>IT0000000000000000000000000</IBAN>
38              <remittanceInformation>remittanceInformation1</remittanceInformation>
39              <transferCategory>0101100IM</transferCategory>
40              <metadata>
41                <mapEntry>
42                  <key>keytest</key>
43                  <value>1</value>
44                </mapEntry>
45              </metadata>            
46            </transfer>
47            <transfer>
48              <idTransfer>2</idTransfer>
49              <transferAmount>10.00</transferAmount>
50              <fiscalCodePA>77777777778</fiscalCodePA>
51              <companyName>company EC2</companyName>
52              <IBAN>IT0000000000000000000000001</IBAN>
53              <remittanceInformation>remittanceInformation2</remittanceInformation>
54              <transferCategory>0201102IM</transferCategory>
55            </transfer>
56          </transferList>
57          <idPSP>88888888888</idPSP>
58          <pspFiscalCode>88888888888</pspFiscalCode>
59          <pspPartitaIVA>88888888888</pspPartitaIVA>
60          <PSPCompanyName>PSP name</PSPCompanyName>
61          <idChannel>88888888888_01</idChannel>
62          <channelDescription>app</channelDescription>
63          <payer>
64            <uniqueIdentifier>
65              <entityUniqueIdentifierType>F</entityUniqueIdentifierType>
66              <entityUniqueIdentifierValue>JHNDOE00A01F205N</entityUniqueIdentifierValue>
67            </uniqueIdentifier>
68            <fullName>John Doe</fullName>
69            <streetName>street</streetName>
70            <civicNumber>12</civicNumber>
71            <postalCode>89020</postalCode>
72            <city>city</city>
73            <stateProvinceRegion>MI</stateProvinceRegion>
74            <country>IT</country>
75            <e-mail>john.doe@test.it</e-mail>
76          </payer>
77          <paymentMethod>creditCard</paymentMethod>
78          <fee>2.00</fee>
79          <primaryCiIncurredFee>0.50</primaryCiIncurredFee>
80          <idBundle>1</idBundle>
81          <idCiBundle>2</idCiBundle>
82          <paymentDateTime>2021-10-01T17:48:22</paymentDateTime>
83          <applicationDate>2021-10-01</applicationDate>
84          <transferDate>2021-10-02</transferDate>
85          <metadata>
86            <mapEntry>
87              <key>keytest</key>
88              <value>1</value>
89            </mapEntry>
90          </metadata>
91          <standin>false</standin>
92        </receipt>
93      </pafn:paSendRTReq>
94    </soapenv:Body>
95  </soapenv:Envelope>
96

verifyPaymentNotice

verifyPaymentNotice

POST
Request Body
NameTypeDescription
idPSP*StringIdentificativo 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*StringIdentificativo 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*StringIdentificativo 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*Stringcodice fiscale dell'EC.
noticeNumber*String[auxDigit][segregationCode][IUVBase][IUVCheckDigit]
password*StringPassword 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

verificaBollettino

verificaBollettino

POST
Request Body
NameTypeDescription
idPSP*StringIdentificativo 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*StringIdentificativo 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*StringIdentificativo 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*Stringconto corrente postale dell'EC.
noticeNumber*String[auxDigit][segregationCode][IUVBase][IUVCheckDigit]
password*StringPassword 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

activatePaymentNotice

activatePaymentNotice versione 1

POST
Request Body
NameTypeDescription
idPSP*StringIdentificativo 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*StringIdentificativo 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*StringIdentificativo 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*StringE' composto da fiscalCode e noticeNumber.
fiscalCode*StringCodice fiscale dell'EC.
noticeNumber*String[auxDigit][segregationCode][IUVBase][IUVCheckDigit]
password*StringPassword del canale, assegnata da PagoPA.
idempotencyKeyChiave di idempotenza
expirationTimeStringTempo 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
paymentNoteStringTesto libero per descrivere l'oggetto del pagamento
dueDateStringdata di scadenza del pagamento secondo il formato ISO 8601 [AAAA]-[MM]-[GG]
amount*StringImporto 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

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
NameTypeDescription
idPSP*StringIdentificativo 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*StringIdentificativo 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*StringIdentificativo 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*StringE' composto da fiscalCode e noticeNumber.
fiscalCode*StringCodice fiscale dell'EC.
noticeNumber*String[auxDigit][segregationCode][IUVBase][IUVCheckDigit]
password*StringPassword del canale, assegnata da PagoPA.
idempotencyKeyChiave di idempotenza
expirationTimeStringTempo 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
paymentNoteStringTesto libero per descrivere l'oggetto del pagamento
dueDateStringdata di scadenza del pagamento secondo il formato ISO 8601 [AAAA]-[MM]-[GG]
amount*StringImporto in euro
allCCPStringad uso interno per i servizi PagoPA
String
paymentMethodStringmetodo di pagamento
touchPointStringtouchpoint utilizzato per il pagamento (es. POS fisico, ATM, ..)
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

sendPaymentOutcome

sendPaymentOutcome versione 1

POST
Request Body
NameTypeDescription
idPSP*Stringidentificativo 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.
detailsStringDettagli del risultato dell'operazione, da inserire obbligatoriamente in caso di outcome OK
outcome*String Il risultato dell'operazione che può contenere i seguenti codiciOK : operazione eseguita con successoKO : operazione terminata con errore
paymentToken*StringViene generato dal sistema durante la fase di attivazione del pagamento, è l'identificatore di correlazione da abbinare all'attivazione e all'esito del pagamento.
password*StringPassword del canale, assegnata da PagoPA.
idChannel*Stringidentificativo 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*Stringidentificativo 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.
payerStringindividua il pagatore
fee*Stringimporto della commissione pagata in euro
paymentChannelStringcanale di pagamentoenum: "frontOffice" "atm" "onLine" "app" "other"
paymentMethod*Stringmetodo di pagamentoenum: "cash" "creditCard" "bancomat" "other"
transferDate*Stringdata del riversamento verso l'EC
applicationDate*Stringdata applicativa del pagamento
e-mailString
countryString
stateProvinceRegionString
cityString
postalCodeString
civicNumberString
streetNameString
fullName*Stringnome completo del pagatore
uniqueIdentifier*String
entityUniqueIdentifierValue*Stringcodice fiscale o partita IVA, nel caso non siano disponibili è possibile utilizzare 'ANONIMO'
entityUniqueIdentifierType*StringF : Persona fisicaG : Persona giuridica
idempotencyKeyStringChiave 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
NameTypeDescription
idPSP*StringIdentificativo 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.
detailsStringdettagli del risultato dell'operazione, da inserire obbligatoriamente in caso di outcome OK
outcome*Stringil risultato dell'operazione che può contenere i seguenti codiciOK : operazione eseguita con successoKO : operazione terminata con errore
paymentToken*Stringviene generato dal sistema durante la fase di attivazione del pagamento, è l'identificatore di correlazione da abbinare all'attivazione e all'esito del pagamento
password*StringPassword del canale, assegnata da PagoPA.
idChannel*StringIdentificativo 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*StringIdentificativo 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.
payerStringindividua il pagatore
fee*Stringimporto della commissione pagata in euro
paymentChannelStringcanale di pagamentoenum: "frontOffice" "atm" "onLine" "app" "other"
paymentMethod*Stringmetodo di pagamentoenum: "cash" "creditCard" "bancomat" "other"
transferDate*Stringdata del riversamento verso l'EC
applicationDate*Stringdata applicativa del pagamento
e-mailString
countryString
stateProvinceRegionString
cityString
postalCodeString
civicNumberString
streetNameString
fullName*Stringnome completo del pagatore
uniqueIdentifier*String
entityUniqueIdentifierValue*Stringcodice fiscale o partita IVA, nel caso non siano disponibili è possibile utilizzare 'ANONIMO'
entityUniqueIdentifierType*StringF : Persona fisicaG : Persona giuridica
paymentTokens*Stringsequence che contiene tutti i tokens
idempotencyKeyStringChiave di idempotenza
idCiBundleStringidentificativo degli attributi aggiunti dall'EC al pacchetto di Gestione evoluta commissioni
idBundleStringidentificativo del pacchetto di Gestione evoluta commissioni
primaryCiIncurredFeeStringimporto della commissione a carico dell'EC espresso in euro ricavato da Gestione evoluta commissioni
marcheDaBolloStringLa lista delle marche da bollo digitali gestite nella transazione di pagamento
paymentTokenStringIl paymentToken con cui è arrivata la richiesta di marca da bollo digitale
idTransferStringL'identificativo del transfer che contiene il dato richiestaMarcaDaBollo
MBDAttachmentStringIl documento XML che contiene la marca da bollo digitale, nel formato base64
marcaDaBolloStringI dati di ogni singola marca da bollo digitale
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              <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:sendPaymentOutcomeReq>
39    </soapenv:Body>
40  </soapenv:Envelope>
41

pspNotifyPayment

pspNotifyPayment versione 1

POST
Request Body
NameTypeDescription
fiscalCodePA*StringCodice fiscale dell'EC.
paymentToken*StringViene generato dal sistema durante la fase di attivazione del pagamento, è l'identificatore di correlazione da abbinare all'attivazione e all'esito del pagamento.
idPSP*StringIdentificativo 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*StringIdentificativo 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*StringIUV Identificativo Univoco Versamento.
companyName*StringNome completo dell'EC.
officeNameStringNome completo dell'ufficio dell'EC.
idBrokerPSP*StringIdentificativo 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*StringRappresenta la somma degli importi dei singoli transfer.
paymentDescription*StringTesto libero per descrivere l'oggetto del pagamento.
remittanceInformation*StringMotivo del pagamento.
IBAN*StringIBAN sul quale sarà effettuato il riversamento
fiscalCodePA*StringCodice fiscale dell'EC.
transferAmount*StringImporto
idTransfer*StringIndice della lista (da 1 a 5).
transfer*String
transferList*StringStruttura che contiene i dettagli dei transfer pagamento, al momento i transfer possono essere al massimo 5.
dati specifici del canale di pagamentoStringStruttura dati specifica del canale di pagamento utilizzato.
standinBooleantrue 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

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
NameTypeDescription
fiscalCodePA*StringCodice fiscale dell'EC.
paymentToken*StringViene generato dal sistema durante la fase di attivazione del pagamento, è l'identificatore di correlazione da abbinare all'attivazione e all'esito del pagamento.
idPSP*StringIdentificativo 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*StringIdentificativo 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*StringIUV Identificativo Univoco Versamento.
companyName*StringNome completo dell'EC.
officeNameStringNome completo dell'ufficio dell'EC.
idBrokerPSP*StringIdentificativo 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*StringRappresenta la somma degli importi dei singoli transfer.
paymentDescription*StringTesto libero per descrivere l'oggetto del pagamento.
remittanceInformation*StringMotivo del pagamento.
IBANStringIBAN sul quale sarà effettuato il riversamento
fiscalCodePA*StringCodice fiscale dell'EC.
transferAmount*StringImporto
idTransfer*StringIndice della lista (da 1 a 5).
transfer*String
transferList*StringStruttura che contiene i dettagli dei transfer pagamento, al momento i transfer possono essere al massimo 5.
payment*String
paymentList*StringLista dei pagamenti.
additionalPaymentInformationsStringStruttura che contiene i dati specifici del canale di pagamento utilizzato.
mapEntry*String
key*String
value*String
CHOICE*StringChoice tra IBAN e richiestaMarcaDaBollo
provinciaResidenzaStringSigla automobilistica della provincia di residenza del soggetto pagatore
hashDocumentoStringImpronta informatica (digest), nel formato base64, del documento informatico o della segnatura di protocollo cui è associata la marca da bollo digitale
tipoBolloStringTipologia del bollo
richiestaMarcaDaBolloStringI dati della richiesta della marca da bollo
transactionId*StringIdentificativo dell'operazione di pagamento.
fee*StringImporto della commissione.
totalAmount*StringRappresenta la somma pagata dall'utente, comprensiva di commissione.
timestampOperation*StringTimestamp dell'operazione di pagamento.
IdCiBundleStringidentificativo degli attributi aggiunti dall'EC al pacchetto associato a Gestione evoluta commissioni
IdBundleStringidentificativo del pacchetto associato a Gestione evoluta commissioni
primaryCiIncurredFeeStringimporto della commissione a carico dell'EC espresso in euro associato a Gestione evoluta commissioni
standinBooleantrue se pagamento eseguito in standin
companyNameStringcodice 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              </payment>
50            </paymentList>                       
51            <additionalPaymentInformations>
52              <mapEntry>
53                <key>xxxx</key>
54                <value>1234546</value>
55              </mapEntry> 
56            </additionalPaymentInformations>
57            <standin>false</standin>
58          </pspfn:pspNotifyPaymentV2>
59      </soapenv:Body>
60    </soapenv:Envelope>    
61

demandPaymentNotice

demandPaymentNotice

POST
Request Body
NameTypeDescription
idPSP*StringIdentificativo 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*StringSono 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*StringIdentificativo dell'associazione tra servizio e EC per cui si vuole attivare il pagamento. Corrisponde al tag elencoSoggettiEroganti.soggettoErogante.idSoggettoServizio del Catalogo dei Servizi.
password*StringPassword del canale, assegnata da PagoPA.
idChannel*StringIdentificativo 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*StringIdentificativo 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

paDemandPaymentNotice

paDemandPaymentNotice

POST
Request Body
NameTypeDescription
idPA*StringCodice fiscale della struttura che invia la richiesta di pagamento.
datiSpecificiServizio*StringSono censiti nel Catalogo dei Servizi, che è il repository che contiene l’elenco dei servizi generalizzati attivati dagli EC, inviati in formato base64.
idServizio*StringIdentificativo del servizio per cui si vuole attivare il pagamento.
idStation*StringIdentificativo della stazione dell'EC nel sistema pagoPa.
idBrokerPA*StringIdentificativo del soggetto che opera come intermediario per l'EC.
idSoggettoServizio*StringIdentificativo dell'associazione tra servizio e EC per cui si vuole attivare il pagamento. Corrisponde al tag elencoSoggettiEroganti.soggettoErogante.idSoggettoServizio del Catalogo dei Servizi.
1<soapenv:Envelope>
2  <soapenv:Body>
3    <ppt:paDemandPaymentNoticeReq>
4      <idPA>77777777777</idPA>
5      <idBrokerPA>77777777777</idBrokerPA>
6      <idStation>77777777777_01</idStation>
7      <idServizio>00002</idServizio>
8      <idSoggettoServizio>00003</idSoggettoServizio>       
9      <datiSpecificiServizio>Dati del servizio base64 encoded</datiSpecificiServizio>
10    </ppt:paDemandPaymentNoticeReq>
11  </soapenv:Body>
12</soapenv:Envelope>
13

nodoInviaFlussoRendicontazione

nodoInviaFlussoRendicontazione

POST
Request Body
NameTypeDescription
identificativoPSP*StringIdentificativo 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*StringContenuto del Flusso di riversamento in formato base64.
dataOraFlusso*StringData e ora del Flusso di Rendicontazione.
identificativoFlusso*StringIdentificativo del Flusso di Rendicontazione.
identificativoDominio*StringCodice fiscale dell'EC.
password*StringPassword del canale, assegnata da PagoPA.
identificativoCanale*StringIdentificativo 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*StringIdentificativo 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

nodoChiediElencoFlussiRendicontazione

nodoChiediElencoFlussiRendicontazione

POST
Request Body
NameTypeDescription
identificativoIntermediarioPA*StringIdentificativo del soggetto che opera come intermediario per l'EC.
identificativoPSPStringIdentificativo 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.
identificativoDominioStringCodice fiscale dell'EC.
password*StringPassword della stazione, assegnata da PagoPA.
identificativoStazioneIntermediarioPA*StringIdentificativo 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

nodoChiediFlussoRendicontazione

nodoChiediFlussoRendicontazione

POST
Request Body
NameTypeDescription
identificativoIntermediarioPA*StringIdentificativo del soggetto che opera come intermediario per l'EC.
identificativoFlusso*StringIdentificativo del Flusso di Rendicontazione.
identificativoPSPStringIdentificativo 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.
identificativoDominioStringCodice fiscale dell'EC.
password*StringPassword della stazione, assegnata da PagoPA.
identificativoStazioneIntermediarioPA*StringIdentificativo 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

nodoChiediCatalogoServizi

nodoChiediCatalogoServizi versione 2

POST
Request Body
NameTypeDescription
identificativoPSP*StringIdentificativo 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.
identificativoDominioStringCodice fiscale dell'EC.
password*StringPassword del canale, assegnata da PagoPA.
identificativoCanale*StringIdentificativo 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*StringIdentificativo 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.
categoriaStringFiltro in base alla categoria dei servizi.
commissioneStringFiltro 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

nodoChiediTemplateInformativaPSP

nodoChiediTemplateInformativaPSP

POST
Request Body
NameTypeDescription
identificativoPSP*StringIdentificativo 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*StringIdentificativo 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*StringIdentificativo 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*StringPassword 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

EC Checkout API

Nuove API - Gestione Flussi di Rendicontazione

Per gli EC:
Per i PSP:

getOrganizationReceipt

Recupero della ricevuta mediante il codice IUR
Recupero della ricevuta mediante i codici IUV

paCreatePosition

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