Primitive
Last updated
Last updated
Per la gestione degli errori fare riferimento a .
I campi contrassegnati con﹡sono obbligatori
Per i dettagli https://github.com/pagopa/pagopa-api/tree/SANP3.6.0
POST
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
è composto da fiscalCode e noticeNumber
fiscalCode*
String
codice fiscale dell'EC
noticeNumber*
String
[auxDigit][segregationCode][IUVBase][IUVCheckDigit]
POST
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].
transferType
String
Valore ammesso: POSTAL.
paymentNote
String
amount
String
Importo del pagamento in euro.
noticeNumber*
String
[auxDigit][segregationCode][IUVBase][IUVCheckDigit]
fiscalCode*
String
Codice fiscale dell'EC.
qrCode*
String
E' composto da fiscalCode e noticeNumber.
idStation*
String
Identificativo della stazione dell'EC nel sistema pagoPa.
idBrokerPA*
String
Identificativo del soggetto che opera come intermediario per l'EC.
POST
In questa versione è possibile inserire i metadata in ogni singolo transfer, inoltre è possibile gestire il servizio @e.bollo.
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
transferType
String
Valori ammessi
POSTAL
PAGOPA
dueDate
String
data di scadenza del pagamento secondo il formato ISO 8601 [AAAA]-[MM]-[GG]
fiscalCode*
String
codice fiscale dell'EC
noticeNumber*
String
[auxDigit][segregationCode][IUVBase][IUVCheckDigit]
POST
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
officeName
String
companyName*
String
nome completo dell'EC
description*
String
paymentAmount*
String
importo espresso in euro
creditorReferenceId*
String
IUV Identificativo Univoco Versamento
fiscalCode*
String
codice fiscale dell'EC
noticeNumber*
String
[auxDigit][segregationCode][IUVBase][IUVCheckDigit]
entityUniqueIdentifierValue*
String
codice fiscale o partita IVA
String
country
String
stateProvinceRegion
String
city
String
postalCode
String
civicNumber
String
streetName
String
fullName*
String
nome completo del debitore
transferCategory*
String
codice tassonomico, composto da Codice tipo Ente Creditore + Progressivo macro area + Codice tipologia servizio + Motivo Giuridico ( ex. 0101002IM )
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
channelDescription*
String
idChannel*
String
PSPCompanyName*
String
pspPartitaIVA
String
pspFiscalCode
String
idPSP*
String
identificativo del PSP
key*
String
mapEntry*
metadata
String
transferDate
String
data del riversamento
applicationDate
String
data applicativa
paymentDateTime
String
data e ora del pagamento
fee
String
importo della commissione espresso in euro
paymentMethod
String
String
country
String
stateProvinceRegion
String
city
String
postalCode
String
civicNumber
String
streetName
String
fullName*
String
nome completo del debitore
entityUniqueIdentifierValue*
String
codice fiscale o partita IVA
entityUniqueIdentifierType*
String
F : Persona fisica
G : Persona giuridica
uniqueIdentifier*
String
payer
String
individua il pagatore
value*
String
standin
Boolean
true: pagamento avvenuto in Stand in
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.
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
officeName
String
companyName*
String
nome completo dell'EC
description*
String
paymentAmount*
String
importo espresso in euro
creditorReferenceId*
String
IUV Identificativo Univoco Versamento
fiscalCode*
String
codice fiscale dell'EC
noticeNumber*
String
[auxDigit][segregationCode][IUVBase][IUVCheckDigit]
entityUniqueIdentifierValue*
String
codice fiscale o partita IVA
String
country
String
stateProvinceRegion
String
city
String
postalCode
String
civicNumber
String
streetName
String
fullName*
String
nome completo del debitore
transferCategory*
String
codice tassonomico, composto da Codice tipo Ente Creditore + Progressivo macro area + Codice tipologia servizio + Motivo Giuridico ( ex. 0101002IM )
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
channelDescription*
String
idChannel*
String
PSPCompanyName*
String
pspPartitaIVA
String
pspFiscalCode
String
idPSP*
String
identificativo del PSP
key*
String
mapEntry*
String
metadata
String
transferDate
String
data del riversamento
applicationDate
String
data applicativa
paymentDateTime
String
data e ora del pagamento
fee
String
importo della commissione espresso in euro
paymentMethod
String
String
country
String
stateProvinceRegion
String
city
String
postalCode
String
civicNumber
String
streetName
String
fullName*
String
nome completo del debitore
entityUniqueIdentifierValue*
String
codice fiscale o partita IVA
entityUniqueIdentifierType*
String
F : Persona fisica
G : Persona giuridica
uniqueIdentifier*
String
payer
String
individua il pagatore
value*
String
value
String
key
String
mapEntry
String
metadata
String
idCiBundle
String
idBundle
String
primaryCiIncurredFee
String
CHOICE*
String
Choice tra IBAN e marcaDaBollo
tipoBollo
String
Tipologia del bollo
marcaDaBollo
String
I dati della marca da bollo digitale
MBDAttachment
String
Il documento XML che contiene la marca da bollo digitale, nel formato base64.
paymentNote
String
standin
Boolean
true: pagamento avvenuto in Stand in
companyName
String
nome completo dell'EC
POST
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.
POST
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.
POST
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
data di scadenza del pagamento secondo il formato ISO 8601 [AAAA]-[MM]-[GG]
amount*
String
Importo in euro
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.
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
data di scadenza del pagamento secondo il formato ISO 8601 [AAAA]-[MM]-[GG]
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, ..)
POST
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.
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.
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
idBundle
String
primaryCiIncurredFee
String
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
POST
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
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.
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
IdBundle
String
primaryCiIncurredFee
String
standin
Boolean
true se pagamento eseguito in standin
companyName
String
codice fiscale dell'EC
POST
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
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.
POST
idPA*
String
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.
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.
POST
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.
POST
identificativoIntermediarioPA*
String
Identificativo del soggetto che opera come intermediario per l'EC.
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 della stazione, assegnata da PagoPA.
identificativoStazioneIntermediarioPA*
String
Identificativo della stazione dell'EC nel sistema pagoPa.
POST
identificativoIntermediarioPA*
String
Identificativo del soggetto che opera come intermediario per l'EC.
identificativoFlusso*
String
Identificativo del Flusso di Rendicontazione.
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 della stazione, assegnata da PagoPA.
identificativoStazioneIntermediarioPA*
String
Identificativo della stazione dell'EC nel sistema pagoPa.
POST
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.
POST
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.
Per gli EC:
Per i PSP:
fault: tutti i dettagli dell'errore, da inserire obbligatoriamente in caso di outcome KO
Descrizione del pagamento. Valorizzato con idCart, nel caso il parametro venisse valorizzato nel
fault: tutti i dettagli dell'errore, da inserire obbligatoriamente in caso di outcome KO
Descrizione del pagamento. Valorizzato con idCart, nel caso il parametro venisse valorizzato nel
fault: tutti i dettagli dell'errore, da inserire obbligatoriamente in caso di outcome KO
fault: tutti i dettagli dell'errore, da inserire obbligatoriamente in caso di outcome KO
identificativo degli attributi aggiunti dall'EC al pacchetto di
identificativo del pacchetto di
importo della commissione a carico dell'EC espresso in euro ricavato da
Descrizione del pagamento. Valorizzato con idCart, nel caso il parametro venisse valorizzato nel
fault: tutti i dettagli dell'errore, da inserire obbligatoriamente in caso di outcome KO
fault: tutti i dettagli dell'errore, dato valorizzato solo in caso di outcome KO
fault: tutti i dettagli dell'errore, dato valorizzato solo in caso di outcome KO
fault: tutti i dettagli dell'errore, dato valorizzato solo in caso di outcome KO
fault: tutti i dettagli dell'errore, dato valorizzato solo in caso di outcome KO
fault: tutti i dettagli dell'errore, da inserire obbligatoriamente in caso di outcome KO
identificativo degli attributi aggiunti dall'EC al pacchetto di
identificativo del pacchetto di
importo della commissione a carico dell'EC espresso in euro ricavato da
fault: tutti i dettagli dell'errore, da inserire obbligatoriamente in caso di outcome KO
fault: tutti i dettagli dell'errore, da inserire obbligatoriamente in caso di outcome KO
identificativo degli attributi aggiunti dall'EC al pacchetto associato a
identificativo del pacchetto associato a
importo della commissione a carico dell'EC espresso in euro associato a
fault: tutti i dettagli dell'errore, da inserire obbligatoriamente in caso di outcome KO
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 .
fault: tutti i dettagli dell'errore, dato valorizzato solo in caso di outcome KO
fault: tutti i dettagli dell'errore, dato valorizzato solo in caso di outcome KO
fault: tutti i dettagli dell'errore, dato valorizzato solo in caso di esito KO
fault: tutti i dettagli dell'errore, dato valorizzato solo in caso di esito KO
fault: tutti i dettagli dell'errore, dato valorizzato solo in caso di esito KO
fault: tutti i dettagli dell'errore, dato valorizzato solo in caso di esito KO
fault: tutti i dettagli dell'errore, dato valorizzato solo in caso di esito KO
Create / Update / Invalidate a debt position.
Amount for payments, in euro cents
create / update / invalidate debt position successfully
Success
"pagopa-fdr""1.2.3""dev""FDR - Flussi di rendicontazione"Get all fdr published
^(.{1,35})$Success
100Get payments of fdr
Success
100Get fdr
Success
"CREATED"4"2023-04-03T12:00:30.900000Z""2023-04-03T12:00:30.900000Z""2016-08-16pspTest-1178""2023-04-05T09:21:37.810000Z""SEPA - Bonifico xzy""2023-04-03T12:00:30.900000Z""UNCRITMMXXX""2023-04-03T12:00:30.900000Z"100100.9100100.9The fiscal code of the Organization.
The unique reference of the operation assigned to the payment (Payment Token).
The unique payment identification. Alphanumeric code that uniquely associates and identifies three key elements of a payment: reason, payer, amount
Obtained receipt.
Create a cart of payment notices checking each payment notice by mean of checkPosition
New Cart related to payment requests
Email to which send the payment receipt
"my_email@mail.it"List of payment notices in the cart
Structure containing all the returning URL's to which user will be redirect after payment process has been completed
the id of the cart from the ec
"id_cart"flag for internal purpose
falseRedirect
Success
"pagopa-fdr""1.2.3""dev""FDR - Flussi di rendicontazione"Get payments of fdr Published
Success
100Delete payments to fdr
Success
"Success"Add payments to fdr
Success
"Success"Get all fdr created
Success
100Get all fdr published
Success
100Delete fdr
Success
"Success"Publish fdr
Success
"Success"Get created payments of fdr
Success
100Get created fdr
Success
"CREATED"4"2023-04-03T12:00:30.900000Z""2023-04-03T12:00:30.900000Z""2016-08-16pspTest-1178""2023-04-05T09:21:37.810000Z""SEPA - Bonifico xzy""2023-04-03T12:00:30.900000Z""UNCRITMMXXX"100100.9100100.9Get fdr Published
Success
"CREATED"4"2023-04-03T12:00:30.900000Z""2023-04-03T12:00:30.900000Z""2016-08-16pspTest-1178""2023-04-05T09:21:37.810000Z""SEPA - Bonifico xzy""2023-04-03T12:00:30.900000Z""UNCRITMMXXX""2023-04-03T12:00:30.900000Z"100100.9100100.9Create fdr
[a-zA-Z0-9\-_]{1,35}[XML NodoInviaFlussoRendicontazione]=[identificativoFlusso]
"2016-08-16pspTest-1178"[a-zA-Z0-9\-_]{1,35}[XML NodoInviaFlussoRendicontazione]=[dataOraFlusso]
"2023-04-05T09:21:37.810000Z"[XML FlussoRiversamento]=[identificativoUnivocoRegolamento]
"SEPA - Bonifico xzy"^(.{1,35})$[XML FlussoRiversamento]=[dataRegolamento]
"2023-04-03T12:00:30.900000Z"[XML FlussoRiversamento]=[codiceBicBancaDiRiversamento]
"UNCRITMMXXX"^(.{1,35})$[XML FlussoRiversamento]=[numeroTotalePagamenti]
1[XML FlussoRiversamento]=[importoTotalePagamenti]
0.01^\d{1,2147483647}([.]\d{1,2})?$Created
"Success"