outcome﹡: il risultato dell'operazione che può contenere i seguenti codici
OK : operazione eseguita con successo
KO : operazione terminata con errore
paymentList: struttura che contiene i dettagli del pagamento, al momento può contenere una sola paymentOptionDescription, da inserire obbligatoriamente in caso di outcome OK
paymentOptionDescription﹡
amount﹡: importo in euro
options﹡: al momento deve essere valorizzato con EQ
dueDate: data di scadenza del pagamento secondo il formato ISO 8601 [AAAA]-[MM]-[GG]
detailDescription: 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, da inserire obbligatoriamente in caso di outcome OK
fiscalCodePA: codice fiscale dell'EC, da inserire obbligatoriamente in caso di outcome OK
companyName: nome completo dell'EC, da inserire obbligatoriamente in caso di outcome OK
officeName: nome completo dell'ufficio dell'EC
paGetPayment
paGetPayment versione 1
POST
Request Body
Name
Type
Description
idPA*
String
Codice fiscale della struttura che invia la richiesta di pagamento.
dueDate
String
Data di scadenza del pagamento secondo il formato ISO 8601 [AAAA]-[MM]-[GG].
paymentAmount﹡: importo, deve essere uguale alle somme di TransferAmount presenti nella TransferList
dueDate﹡: data di scadenza del pagamento secondo il formato ISO 8601 [AAAA]-[MM]-[GG]
retentionDate: timestamp che indica la fine del periodo di ritenzione delle informazioni sul pagamento da parte del Nodo
lastPayment
description﹡: testo libero per descrivere l'oggetto del pagamento
companyName: nome completo dell'EC
officeName: nome completo dell'ufficio dell'EC
debtor﹡: individua il debitore a cui si riferisce la posizione debitoria
uniqueIdentifier﹡
entityUniqueIdentifierType﹡
F : Persona fisica
G : Persona giuridica
entityUniqueIdentifierValue﹡: codice fiscale o partita IVA, nel caso non siano disponibili è possibile utilizzare 'ANONIMO'
fullName﹡: nome completo del debitore
streetName: indirizzo
civicNumber: numero civico
postalCode: CAP
city: citta'
stateProvinceRegion: regione
country: stato
e-mail
transferList﹡: struttura che contiene i dettagli dei transfer, al momento possono essere inseriti fino a 5 transfer, deve essercene almeno 1
transfer﹡
idTransfer﹡: indice della lista (da 1 a 5)
transferAmount﹡: importo
fiscalCodePA﹡: codice fiscale dell'EC
IBAN﹡: IBAN sul quale sarà effettuato il riversamento
remittanceInformation﹡: motivo del pagamento
transferCategory﹡: codice tassonomico, composto da Codice tipo Ente Creditore + Progressivo macro area + Codice tipologia servizio + Motivo Giuridico ( ex. 0101002IM )
metadata: è un campo di archiviazione chiave/valore ad uso esclusivo dell'EC. I dati saranno inseriti nella receipt (paSendRT)
mapEntry﹡
key﹡
value﹡
paGetPayment versione 2
POST
In questa versione è possibile inserire i metadata in ogni singolo transfer, inoltre è possibile gestire il servizio @e.bollo.
Request Body
Name
Type
Description
idPA*
String
Codice fiscale della struttura che invia la richiesta di pagamento.
idBrokerPA*
String
Identificativo del soggetto che opera come intermediario per l'EC.
idStation*
String
Identificativo della stazione dell'EC nel sistema pagoPa.
qrCode*
String
E' composto da fiscalCode e noticeNumber.
amount*
String
importo del pagamento in euro
paymentNote
String
descrizione del pagamento
transferType
String
valore ammesso: POSTAL
dueDate
String
data di scadenza del pagamento secondo il formato ISO 8601 [AAAA]-[MM]-[GG]
paymentAmount﹡: importo, deve essere uguale alle somme di TransferAmount presenti nella TransferList
dueDate﹡: indica la data di scadenza del pagamento secondo il formato ISO 8601 [AAAA]-[MM]-[GG]
retentionDate: timestamp che indica la fine del periodo di ritenzione delle informazioni sul pagamento da parte del Nodo
lastPayment
description﹡: testo libero per descrivere l'oggetto del pagamento
companyName﹡: nome completo dell'EC
officeName: nome completo dell'ufficio dell'EC
debtor﹡: individua il debitore a cui si riferisce la posizione debitoria
uniqueIdentifier﹡
entityUniqueIdentifierType﹡
F : Persona fisica
G : Persona giuridica
entityUniqueIdentifierValue﹡: codice fiscale o partita IVA, nel caso non siano disponibili è possibile utilizzare 'ANONIMO'
fullName﹡: nome completo del debitore
streetName: indirizzo
civicNumber: numero civico
postalCode: CAP
city: citta'
stateProvinceRegion: regione
country: stato
e-mail
transferList﹡: struttura che contiene i dettagli dei transfer, al momento possono essere inseriti fino a 5 transfer, deve essercene almeno 1
transfer﹡
idTransfer﹡: indice della lista (da 1 a 5)
transferAmount﹡: importo in euro
fiscalCodePA﹡: codice fiscale dell'EC
CHOICE*
IBAN: IBAN sul quale sarà effettuato il riversamento
richiestaMarcaDaBollo: i dati della richiesta della marca da bollo
tipoBollo: tipologia del bollo
hashDocumento: contiene l’impronta informatica (digest), nel formato base64, del documento informatico o della segnatura di protocollo cui è associata la marca da bollo digitale
provinciaResidenza: sigla automobilistica della provincia di residenza del soggetto pagatore
remittanceInformation﹡: motivo del pagamento
transferCategory﹡: codice tassonomico, composto da Codice tipo Ente Creditore + Progressivo macro area + Codice tipologia servizio + Motivo Giuridico ( ex. 0101002IM )
metadata: è un campo di archiviazione chiave/valore.
mapEntry﹡
key﹡
value﹡
metadata: è un campo di archiviazione chiave/valore ad uso esclusivo dell'EC. I dati saranno inseriti nella receipt (paSendRT)
mapEntry﹡
key﹡
value﹡
paSendRT
paSendRT versione 1
POST
Request Body
Name
Type
Description
idPA*
String
codice fiscale della struttura che invia la richiesta di pagamento
receiptId*
String
identificatore univoco della receipt contiene il paymentToken assegnato da pagoPa
outcome*
String
il risultato dell'operazione che può contenere i codici OK o KO
receipt*
String
la ricevuta di pagamento
idStation*
String
identificativo della stazione dell'EC nel sistema pagoPa
idBrokerPA*
String
identificativo del soggetto che opera come intermediario per l'EC
entityUniqueIdentifierType*
String
F : Persona fisica
G : Persona giuridica
uniqueIdentifier*
String
debtor*
String
individua il debitore a cui si riferisce la posizione debitoria
outcome﹡: il risultato dell'operazione che può contenere i seguenti codici
OK : operazione eseguita con successo
KO : operazione terminata con errore
paSendRT versione 2
POST
In questa versione possono essere inseriti i metadata in ogni singolo transfer della receipt, inoltre sono gestite le informazioni ricavate da Gestione evoluta commissionie il servizio @e.bollo.
Request Body
Name
Type
Description
idPA*
String
codice fiscale della struttura che invia la richiesta di pagamento
receiptId*
String
identificatore univoco della receipt contiene il paymentToken assegnato da pagoPa
outcome*
String
il risultato dell'operazione che può contenere i codici OK o KO
receipt*
String
la ricevuta di pagamento
idStation*
String
identificativo della stazione dell'EC nel sistema pagoPa
idBrokerPA*
String
identificativo del soggetto che opera come intermediario per l'EC
entityUniqueIdentifierType*
String
F : Persona fisica
G : Persona giuridica
uniqueIdentifier*
String
debtor*
String
individua il debitore a cui si riferisce la posizione debitoria
outcome﹡: il risultato dell'operazione che può contenere i seguenti codici
OK : operazione eseguita con successo
KO : operazione terminata con errore
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
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.