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
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
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
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.
paymentAmount﹡: importo, deve essere uguale alle somme di TransferAmount presenti nella TransferList
dueDate﹡: indica la data di scadenza del pagamento secondo il formato ISO 8601 [AAAA]-[MM]-[GG]
retentionDate: timestamp che indica la fine del periodo di ritenzione delle informazioni sul pagamento da parte del Nodo
lastPayment
description﹡: testo libero per descrivere l'oggetto del pagamento
companyName: nome completo dell'EC
officeName: nome completo dell'ufficio dell'EC
debtor﹡: individua il debitore a cui si riferisce la posizione debitoria
uniqueIdentifier﹡
entityUniqueIdentifierType﹡
F : Persona fisica
G : Persona giuridica
entityUniqueIdentifierValue﹡: codice fiscale o partita IVA
fullName﹡: nome completo del debitore
streetName: indirizzo
civicNumber: numero civico
postalCode: CAP
city: citta'
stateProvinceRegion: regione
country: stato
e-mail
transferList﹡: struttura che contiene i dettagli dei transfer, al momento possono essere inseriti fino a 5 transfer, deve essercene almeno 1
transfer﹡
idTransfer﹡: indice della lista (da 1 a 5)
transferAmount﹡: importo in euro
fiscalCodePA﹡: codice fiscale dell'EC
IBAN﹡: IBAN sul quale sarà effettuato il riversamento
remittanceInformation﹡: motivo del pagamento
transferCategory﹡: codice tassonomico, composto da Codice tipo Ente Creditore + Progressivo macro area + Codice tipologia servizio + Motivo Giuridico ( ex. 0101002IM )
metadata: è un campo di archiviazione chiave/valore.
mapEntry﹡
key﹡
value﹡
metadata: è un campo di archiviazione chiave/valore ad uso esclusivo dell'EC. I dati saranno inseriti nella receipt (paSendRT)
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
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
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﹡: al momento è valorizzato con EQ
IBAN﹡: IBAN sul quale verra riversata l'importo
remittanceInformation﹡: testo libero per descrivere l'oggetto del pagamento
creditorReferenceId: IUV Identificativo Univoco Versamento, dato valorizzato solo in caso di outcome OK
activatePaymentNotice versione 2
POST
In questa versione è possibile inserire i metadata in ogni singolo transfer.
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﹡: al momento è valorizzato con EQ
IBAN﹡: IBAN sul quale verra riversata l'importo
remittanceInformation﹡: testo libero per descrivere l'oggetto del pagamento
metadata: è un campo di archiviazione chiave/valore.
mapEntry﹡
key﹡
value﹡
creditorReferenceId: IUV Identificativo Univoco Versamento, dato valorizzato solo in caso di outcome OK
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.
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.
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.
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.
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.
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.
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.
idServizio*
String
Identificativo del servizio per cui si vuole attivare il 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.
<soap:Envelope> <soap:Body> <ns3:demandPaymentNoticeReq> <idPSP>88888888888</idPSP> <idBrokerPSP>88888888888</idBrokerPSP> <idChannel>88888888888_01</idChannel> <password>**********</password> <idServizio>001001002</idServizio> //identifica la codifica sul DB pagoPA per poter estrarre il destinatario <datiSpecificiServizio>Dati del servizio base64 encoded</datiSpecificiServizio> </ns3:demandPaymentNoticeReq> </soap:Body></soap:Envelope>
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
Codice fiscale della struttura che invia la richiesta di pagamento.
datiSpecificiServizio*
String
Sono censiti nel Catalogo dei Servizi, che è il repository che contiene l’elenco dei servizi generalizzati attivati dagli EC, inviati in formato base64.
idServizio*
String
Identificativo del servizio per cui si vuole attivare il pagamento.
idStation*
String
Identificativo della stazione dell'EC nel sistema pagoPa.
idBrokerPA*
String
Identificativo del soggetto che opera come intermediario per l'EC.
<soapenv:Envelope> <soapenv:Body> <ppt:paDemandPaymentNoticeReq> <idPA>77777777777</idPA> <idBrokerPA>77777777777</idBrokerPA> <idStation>77777777777_01</idStation> <idServizio>001001002</idServizio> <datiSpecificiServizio>Dati del servizio base64 encoded</datiSpecificiServizio> </ppt:paDemandPaymentNoticeReq> </soapenv:Body></soapenv:Envelope>
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