Primitive
Per la gestione degli errori fare riferimento a Gestione degli errori.
I campi contrassegnati con﹡sono obbligatori
Per i dettagli https://github.com/pagopa/pagopa-api/tree/SANP3.6.1
paVerifyPaymentNotice
paVerifyPaymentNotice
POST
Request Body
Name | Type | Description |
---|---|---|
idPA* | String | codice fiscale della struttura che invia la richiesta di pagamento |
idBrokerPA* | String | identificativo del soggetto che opera come intermediario per l'EC |
idStation* | String | identificativo della stazione dell'EC nel sistema pagoPa |
qrCode* | String | è composto da fiscalCode e noticeNumber |
fiscalCode* | String | codice fiscale dell'EC |
noticeNumber* | String | [auxDigit][segregationCode][IUVBase][IUVCheckDigit] |
paGetPayment
paGetPayment versione 1
POST
Request Body
Name | Type | Description |
---|---|---|
idPA* | String | Codice fiscale della struttura che invia la richiesta di pagamento. |
dueDate | String | Data di scadenza del pagamento secondo il formato ISO 8601 [AAAA]-[MM]-[GG]. |
transferType | String | Valore ammesso: POSTAL. |
paymentNote | String | Descrizione del pagamento. Valorizzato con idCart, nel caso il parametro venisse valorizzato nel Pagamento presso frontend dell'EC |
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. |
paGetPayment versione 2
POST
In questa versione è possibile inserire i metadata in ogni singolo transfer, inoltre è possibile gestire il servizio @e.bollo.
Request Body
Name | Type | Description |
---|---|---|
idPA* | String | Codice fiscale della struttura che invia la richiesta di pagamento. |
idBrokerPA* | String | Identificativo del soggetto che opera come intermediario per l'EC. |
idStation* | String | Identificativo della stazione dell'EC nel sistema pagoPa. |
qrCode* | String | E' composto da fiscalCode e noticeNumber. |
amount* | String | Importo del pagamento in euro |
paymentNote | String | Descrizione del pagamento. Valorizzato con idCart, nel caso il parametro venisse valorizzato nel Pagamento presso frontend dell'EC |
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] |
paSendRT
paSendRT versione 1
POST
Request Body
Name | Type | Description |
---|---|---|
idPA* | String | codice fiscale della struttura che invia la richiesta di pagamento |
receiptId* | String | identificatore univoco della receipt contiene il paymentToken assegnato da pagoPa |
outcome* | String | il risultato dell'operazione che può contenere i codici OK o KO |
receipt* | String | la ricevuta di pagamento |
idStation* | String | identificativo della stazione dell'EC nel sistema pagoPa |
idBrokerPA* | String | identificativo del soggetto che opera come intermediario per l'EC |
entityUniqueIdentifierType* | String | F : Persona fisica G : Persona giuridica |
uniqueIdentifier* | String | |
debtor* | String | individua il debitore a cui si riferisce la posizione debitoria |
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 |
paSendRT versione 2
POST
In questa versione possono essere inseriti i metadata in ogni singolo transfer della receipt, inoltre sono gestite le informazioni ricavate da Gestione evoluta commissionie il servizio @e.bollo.
Request Body
Name | Type | Description |
---|---|---|
idPA* | String | codice fiscale della struttura che invia la richiesta di pagamento |
receiptId* | String | identificatore univoco della receipt contiene il paymentToken assegnato da pagoPa |
outcome* | String | il risultato dell'operazione che può contenere i codici OK o KO |
receipt* | String | la ricevuta di pagamento |
idStation* | String | identificativo della stazione dell'EC nel sistema pagoPa |
idBrokerPA* | String | identificativo del soggetto che opera come intermediario per l'EC |
entityUniqueIdentifierType* | String | F : Persona fisica G : Persona giuridica |
uniqueIdentifier* | String | |
debtor* | String | individua il debitore a cui si riferisce la posizione debitoria |
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 | identificativo degli attributi aggiunti dall'EC al pacchetto di Gestione evoluta commissioni |
idBundle | String | identificativo del pacchetto di Gestione evoluta commissioni |
primaryCiIncurredFee | String | importo della commissione a carico dell'EC espresso in euro ricavato da Gestione evoluta commissioni |
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 | Descrizione del pagamento. Valorizzato con idCart, nel caso il parametro venisse valorizzato nel Pagamento presso frontend dell'EC |
standin | Boolean | true: pagamento avvenuto in Stand in |
companyName | String | nome completo dell'EC |
verifyPaymentNotice
verifyPaymentNotice
POST
Request Body
Name | Type | Description |
---|---|---|
idPSP* | String | Identificativo del PSP, assegnato da PagoPA. Il codice è generalmente rappresentato dal codice BIC (Bank Identifier Code) del PSP. In assenza del codice BIC, o per gestire situazioni particolari, può essere utilizzato un altro codice, purché identifichi in modo univoco il PSP. |
idBrokerPSP* | String | Identificativo dell'intermediario, assegnato da PagoPA. Identificazione dell'intermediario/broker del PSP che fornisce l'accesso (canale) al PSP per l'erogazione del servizio. Nota: l'intermediario/broker può coincidere con il PSP stesso. |
idChannel* | String | Identificativo del canale, identifica una categoria di servizio di pagamento e attraverso la quale viene effettuata la transazione. Un identificatore di canale appartiene a un solo intermediario/broker PSP e di conseguenza deve essere univoco rispetto al PSP. |
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. |
verificaBollettino
verificaBollettino
POST
Request Body
Name | Type | Description |
---|---|---|
idPSP* | String | Identificativo del PSP, assegnato da PagoPA. Il codice è generalmente rappresentato dal codice BIC (Bank Identifier Code) del PSP. In assenza del codice BIC, o per gestire situazioni particolari, può essere utilizzato un altro codice, purché identifichi in modo univoco il PSP. |
idBrokerPSP* | String | Identificativo dell'intermediario, assegnato da PagoPA. Identificazione dell'intermediario/broker del PSP che fornisce l'accesso (canale) al PSP per l'erogazione del servizio. Nota: l'intermediario/broker può coincidere con il PSP stesso. |
idChannel* | String | Identificativo del canale, identifica una categoria di servizio di pagamento e attraverso la quale viene effettuata la transazione. Un identificatore di canale appartiene a un solo intermediario/broker PSP e di conseguenza deve essere univoco rispetto al PSP. |
ccPost* | String | conto corrente postale dell'EC. |
noticeNumber* | String | [auxDigit][segregationCode][IUVBase][IUVCheckDigit] |
password* | String | Password del canale, assegnata da PagoPA. |
activatePaymentNotice
activatePaymentNotice versione 1
POST
Request Body
Name | Type | Description |
---|---|---|
idPSP* | String | Identificativo del PSP, assegnato da PagoPA. Il codice è generalmente rappresentato dal codice BIC (Bank Identifier Code) del PSP. In assenza del codice BIC, o per gestire situazioni particolari, può essere utilizzato un altro codice, purché identifichi in modo univoco il PSP. |
idBrokerPSP* | String | Identificativo dell'intermediario, assegnato da PagoPA. Identificazione dell'intermediario/broker del PSP che fornisce l'accesso (canale) al PSP per l'erogazione del servizio. Nota: l'intermediario/broker può coincidere con il PSP stesso. |
idChannel* | String | Identificativo del canale, identifica una categoria di servizio di pagamento e attraverso la quale viene effettuata la transazione. Un identificatore di canale appartiene a un solo intermediario/broker PSP e di conseguenza deve essere univoco rispetto al PSP. |
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 |
activatePaymentNotice versione 2
activatePaymentNotice versione 2
POST
In questa versione è possibile far transitare i metadata per ogni payment e in ogni singolo transfer della response, inoltre sono gestite le informazioni ricavate da Gestione evoluta commissioni.
Request Body
Name | Type | Description |
---|---|---|
idPSP* | String | Identificativo del PSP, assegnato da PagoPA. Il codice è generalmente rappresentato dal codice BIC (Bank Identifier Code) del PSP. In assenza del codice BIC, o per gestire situazioni particolari, può essere utilizzato un altro codice, purché identifichi in modo univoco il PSP. |
idBrokerPSP* | String | Identificativo dell'intermediario, assegnato da PagoPA. Identificazione dell'intermediario/broker del PSP che fornisce l'accesso (canale) al PSP per l'erogazione del servizio. Nota: l'intermediario/broker può coincidere con il PSP stesso. |
idChannel* | String | Identificativo del canale, identifica una categoria di servizio di pagamento e attraverso la quale viene effettuata la transazione. Un identificatore di canale appartiene a un solo intermediario/broker PSP e di conseguenza deve essere univoco rispetto al PSP. |
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, ..) |