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
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.
<soapenv:Envelope>
<soapenv:Body>
<nod:verifyPaymentNoticeReq>
<idPSP>88888888888</idPSP>
<idBrokerPSP>88888888888</idBrokerPSP>
<idChannel>88888888888_01</idChannel>
<password>**********</password>
<qrCode>
<fiscalCode>77777777777</fiscalCode>
<noticeNumber>311111111112222222</noticeNumber>
</qrCode>
</nod:verifyPaymentNoticeReq>
</soapenv:Body>
</soapenv:Envelope><soapenv:Envelope>
<soapenv:Body>
<nfpsp:verifyPaymentNoticeRes>
<outcome>OK</outcome>
<paymentList>
<paymentOptionDescription>
<amount>30.00</amount>
<options>EQ</options>
<paymentNote>test</paymentNote>
</paymentOptionDescription>
</paymentList>
<paymentDescription>payment</paymentDescription>
<fiscalCodePA>77777777777</fiscalCodePA>
<companyName>company EC</companyName>
<officeName>office EC</officeName>
<standin>false</standin>
</nfpsp:verifyPaymentNoticeRes>
</soapenv:Body>
</soapenv:Envelope> outcome﹡: il risultato dell'operazione che può contenere i seguenti codici
OK : operazione eseguita con successo
KO : operazione terminata con errore
fault: tutti i dettagli dell'errore, dato valorizzato solo in caso di outcome KO Gestione degli errori
paymentList: struttura che contiene i dettagli del pagamento, al momento può contenere una sola paymentOptionDescription, dato valorizzato solo in caso di outcome OK
paymentOptionDescription﹡
amount﹡: importo in euro
options﹡: al momento è valorizzato con EQ
dueDate: data di scadenza del pagamento secondo il formato ISO 8601 [AAAA]-[MM]-[GG]
paymentNote: testo libero per descrivere l'oggetto del pagamento
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
standin: true in caso di pagamento avvenuto in Stand in
verificaBollettino
POST
Request Body
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.
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
paymentBollettinoList: struttura che contiene i dettagli del pagamento, al momento può contenere una sola paymentOptionDescription, dato valorizzato solo in caso di outcome OK, dato valorizzato solo in caso di outcome OK
paymentOptionDescription﹡
amount﹡: importo in euro
options﹡: al momento è valorizzato con EQ
dueDate: data di scadenza del pagamento secondo il formato ISO 8601 [AAAA]-[MM]-[GG]
paymentNote: testo libero per descrivere l'oggetto del pagamento
allCCP﹡: se TRUE indica che tutti i bonifici sono associabili a IBAN postali
paymentDescription: testo libero per descrivere l'oggetto del pagamento
fiscalCodePA: codice fiscale dell'EC, dato valorizzato solo in caso di outcome OK
noticeNumber: [auxDigit][segregationCode][IUVBase][IUVCheckDigit], 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
standin: true in caso di pagamento avvenuto in Stand in
activatePaymentNotice
activatePaymentNotice versione 1
POST
Request Body
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
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
IBAN﹡: IBAN sul quale verra riversato l'importo
remittanceInformation﹡: testo libero per descrivere l'oggetto del pagamento
creditorReferenceId: IUV Identificativo Univoco Versamento, dato valorizzato solo in caso di outcome OK
standin: true in caso di pagamento avvenuto in Stand in
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
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, ..)
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
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
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.
outcome﹡: il risultato dell'operazione che può contenere i seguenti codici
OK : operazione eseguita con successo
KO : operazione terminata con errore
fault: tutti i dettagli dell'errore, da inserire obbligatoriamente in caso di outcome KO Gestione degli errori
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
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
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
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
outcome﹡: il risultato dell'operazione che può contenere i seguenti codici
OK : operazione eseguita con successo
KO : operazione terminata con errore
fault: tutti i dettagli dell'errore, da inserire obbligatoriamente in caso di outcome KO Gestione degli errori
pspNotifyPayment
pspNotifyPayment versione 1
POST
Request Body
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
outcome﹡: il risultato dell'operazione che può contenere i seguenti codici
OK : operazione eseguita con successo
KO : operazione terminata con errore
fault: tutti i dettagli dell'errore, da inserire obbligatoriamente in caso di outcome KO Gestione degli errori
Carta di credito (dismissione 30/04/2023)
Paypal
Bancomat Pay
Altri canali di pagamento
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
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
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
outcome﹡: il risultato dell'operazione che può contenere i seguenti codici
OK : operazione eseguita con successo
KO : operazione terminata con errore
fault: tutti i dettagli dell'errore, da inserire obbligatoriamente in caso di outcome KO Gestione degli errori
demandPaymentNotice
POST
Request Body
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.
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
qrCode: è composto da fiscalCode e noticeNumber, dato valorizzato solo in caso di outcome OK
fiscalCode: codice fiscale dell'EC
noticeNumber: [auxDigit][segregationCode][IUVBase][IUVCheckDigit]
paymentList: struttura che contiene i dettagli del pagamento, al momento può contenere una sola paymentOptionDescription, dato valorizzato solo in caso di outcome OK
paymentOptionDescription﹡
amount﹡: importo in euro
options﹡: al momento è valorizzato con EQ
dueDate: data di scadenza del pagamento secondo il formato ISO 8601 [AAAA]-[MM]-[GG]
paymentNote: testo libero per descrivere l'oggetto del pagamento
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
nodoInviaFlussoRendicontazione
POST
Request Body
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.
esito﹡: 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 esito KO Gestione degli errori
nodoChiediCatalogoServizi
nodoChiediCatalogoServizi versione 2
POST
Request Body
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.
esito﹡: 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 esito KO Gestione degli errori
xmlCatalogoServizi: contenuto del catalogo dei servizi in formato base64, dato valorizzato solo in caso di esito OK
nodoChiediTemplateInformativaPSP
POST
Request Body
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.
esito﹡: 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 esito KO Gestione degli errori
xmlTemplateInformativa: template dell'informativa in formato base64, dato valorizzato solo in caso di esito OK
Last updated