Primitive
Last updated
SANP 3.9.1
Last updated
Per la gestione degli errori fare riferimento a .
Per i dettagli
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
Se presente, rappresenta la 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
Se presente, rappresenta la 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
idBrokerPA*
String
identificativo del soggetto che opera come intermediario per l'EC
idStation*
String
identificativo della stazione dell'EC nel sistema pagoPa
receipt*
String
la ricevuta di pagamento
receiptId*
String
identificatore univoco della receipt contiene il paymentToken assegnato da pagoPa
noticeNumber*
String
[auxDigit][segregationCode][IUVBase][IUVCheckDigit]
fiscalCode*
String
codice fiscale dell'EC
outcome*
String
il risultato dell'operazione che può contenere i codici OK o KO
creditorReferenceId*
String
IUV Identificativo Univoco Versamento
paymentAmount*
String
importo espresso in euro
description*
String
companyName
String
nome completo dell'EC
officeName
String
debtor*
String
individua il debitore a cui si riferisce la posizione debitoria
uniqueIdentifier*
String
entityUniqueIdentifierType*
String
F : Persona fisica
G : Persona giuridica
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
transferList*
String
struttura che contiene i dettagli dei transfer
transfer*
String
idTransfer*
String
indice della lista (da 1 a 5)
fiscalCodePA*
String
codice fiscale dell'EC
transferAmount*
String
importo
IBAN*
String
IBAN sul quale sarà effettuato il riversamento
remittanceInformation*
String
motivo del pagamento
transferCategory*
String
codice tassonomico, composto da Codice tipo Ente Creditore + Progressivo macro area + Codice tipologia servizio + Motivo Giuridico ( ex. 0101002IM )
idPSP*
String
identificativo del PSP
pspFiscalCode
String
pspPartitaIVA
String
PSPCompanyName*
String
idChannel*
String
channelDescription*
String
payer
String
individua il pagatore
uniqueIdentifier*
entityUniqueIdentifierType*
String
F : Persona fisica
G : Persona giuridica
entityUniqueIdentifierValue*
String
codice fiscale o partita IVA
fullName*
String
nome completo del debitore
streetName
String
civicNumber
String
postalCode
String
city
String
stateProvinceRegion
String
country
String
String
paymentMethod
String
fee
String
importo della commissione espresso in euro
paymentDateTime
String
data e ora del pagamento
applicationDate
String
data applicativa
transferDate
String
data del riversamento
metadata
String
mapEntry*
key*
String
value*
String
identificativo del PSP
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
idBrokerPA*
String
identificativo del soggetto che opera come intermediario per l'EC
idStation*
String
identificativo della stazione dell'EC nel sistema pagoPa
receipt*
String
la ricevuta di pagamento
receiptId*
String
identificatore univoco della receipt contiene il paymentToken assegnato da pagoPa
noticeNumber*
String
[auxDigit][segregationCode][IUVBase][IUVCheckDigit]
fiscalCode*
String
codice fiscale dell'EC
outcome*
String
il risultato dell'operazione che può contenere i codici OK o KO
creditorReferenceId*
String
IUV Identificativo Univoco Versamento
paymentAmount*
String
importo espresso in euro
description*
String
companyName*
String
nome completo dell'EC
officeName
String
debtor*
String
individua il debitore a cui si riferisce la posizione debitoria
uniqueIdentifier*
String
entityUniqueIdentifierType*
String
F : Persona fisica
G : Persona giuridica
entityUniqueIdentifierValue*
String
codice fiscale o partita IVA
fullName*
String
nome completo del debitore
streetName
String
civicNumber
String
postalCode
String
city
String
stateProvinceRegion
String
country
String
String
transferList*
String
struttura che contiene i dettagli dei transfer
transfer*
String
idTransfer*
String
indice della lista (da 1 a 5)
transferAmount*
String
importo
fiscalCodePA*
String
codice fiscale dell'EC
companyName
String
nome completo dell'EC
IBAN
String
IBAN sul quale sarà effettuato il riversamento
remittanceInformation*
String
motivo del pagamento
transferCategory*
String
codice tassonomico, composto da Codice tipo Ente Creditore + Progressivo macro area + Codice tipologia servizio + Motivo Giuridico ( ex. 0101002IM )
metadata
String
mapEntry
String
key
String
value*
String
idPSP*
String
identificativo del PSP
pspFiscalCode
String
pspPartitaIVA
String
PSPCompanyName*
String
idChannel*
String
channelDescription*
String
payer
String
individua il pagatore
uniqueIdentifier*
String
entityUniqueIdentifierType*
String
F : Persona fisica
G : Persona giuridica
entityUniqueIdentifierValue*
String
codice fiscale o partita IVA
fullName*
String
nome completo del debitore
streetName
String
civicNumber
String
postalCode
String
city
String
stateProvinceRegion
String
country
String
String
paymentMethod
String
fee
String
importo della commissione espresso in euro
primaryCiIncurredFee
String
idBundle
String
idCiBundle
String
paymentDateTime
String
data e ora del pagamento
applicationDate
String
data applicativa
transferDate
String
data del riversamento
metadata
String
mapEntry
String
key
String
value
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
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
Se presente, rappresenta la 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
Se presente, rappresenta la 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:
Recupero della ricevuta mediante il codice IUR
Recupero della ricevuta mediante i codici IUV
fault: tutti i dettagli dell'errore, da inserire obbligatoriamente in caso di outcome KO
Per maggiori informazioni, consulta le
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
Per maggiori informazioni, consulta le .
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
importo della commissione a carico dell'EC espresso in euro ricavato da
identificativo del pacchetto di
identificativo degli attributi aggiunti dall'EC al pacchetto di
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
Per maggiori informazioni, consulta le .
fault: tutti i dettagli dell'errore, dato valorizzato solo in caso di outcome KO
Per maggiori informazioni, consulta le
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
Get fdr
Format - int64.
Get payments of fdr
Format - int64.
Format - int64.
1Format - int64.
1000Get all fdr published
^(.{1,35})$Format - int64.
1^(.{1,35})$Format - date-time (as date-time in RFC3339).
2022-03-10T04:15:50.0000000+00:00Format - int64.
1000The fiscal code of the Organization.
The unique reference of the operation assigned to the payment (Payment Token).
This header identifies the call, if not passed it is self-generated. This ID is returned in the response.
The 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
This header identifies the call, if not passed it is self-generated. This ID is returned in the response.
Get created fdr
Get payments of fdr Published
Format - int64.
Format - int64.
1Format - int64.
1000Get fdr Published
Format - int64.
Get all fdr created
Format - date-time (as date-time in RFC3339).
2022-03-10T04:15:50.0000000+00:00Format - int64.
1Format - int64.
1000Get created payments of fdr
Format - int64.
1Format - int64.
1000Get all fdr published
^(.{1,35})$Format - int64.
1Format - date-time (as date-time in RFC3339).
2022-03-10T04:15:50.0000000+00:00Format - int64.
1000Create a new debt position.
Segregation codes for which broker is authorized
Request body for creating a new transaction
12345678910GPossible values: 12345678910Full Name00000000000000000notice number, if not specified it will created using the following pattern: 3 + iuv
30000000000000000Amount for payments, in eurocents
100ACA Debt Position descriptionIT0000000000000000000000000IT60X0542811101000000123456falseExample: truetrueExample: trueCreate fdr
[a-zA-Z0-9\-_]{1,35}[XML NodoInviaFlussoRendicontazione]=[identificativoFlusso]
2016-08-16pspTest-1178Pattern: [a-zA-Z0-9\-_]{1,35}[XML NodoInviaFlussoRendicontazione]=[dataOraFlusso]
2023-04-05T09:21:37.81Z2022-03-10T04:15:50.0000000+00:00[XML FlussoRiversamento]=[identificativoUnivocoRegolamento]
SEPA - Bonifico xzyPattern: ^(.{1,35})$[XML FlussoRiversamento]=[dataRegolamento]
2023-04-03T12:00:30.9Z2022-03-10T04:15:50.0000000+00:00[XML FlussoRiversamento]=[codiceBicBancaDiRiversamento]
UNCRITMMXXXPattern: ^(.{1,35})$[XML FlussoRiversamento]=[numeroTotalePagamenti]
1[XML FlussoRiversamento]=[importoTotalePagamenti]
0.01Pattern: ^\d{1,2147483647}([.]\d{1,2})?$Delete payments to fdr
Restituisce le opzioni di pagamento per un determinato avviso, specificato dal parametro noticeId, per un ente identificato dal codice fiscale paTaxCode .
Codice fiscale dell'ente.
77777777777Identificatore univoco dell'avviso di pagamento.
311111111111111111Opzioni di pagamento recuperate con successo.
Retrieve the payment options related to the provided input
Create a cart of payment notices checking each payment notice by mean of checkPosition
Cart request body
Email to which send the payment receipt
my_email@mail.itthe id of the cart from the ec
id_cartflag for internal purpose
falseNo content