Primitive
I campi contrassegnati con﹡sono obbligatori
Per i dettagli https://github.com/pagopa/pagopa-api/tree/SANP3.3.1
paVerifyPaymentNotice
POST
Request Body
<soapenv:Envelope>
<soapenv:Header />
<soapenv:Body>
<nod:paVerifyPaymentNoticeReq>
<idPA>77777777777</idPA>
<idBrokerPA>77777777777</idBrokerPA>
<idStation>77777777777_01</idStation>
<qrCode>
<fiscalCode>77777777777</fiscalCode>
<noticeNumber>311111111112222222</noticeNumber>
</qrCode>
</nod:paVerifyPaymentNoticeReq>
</soapenv:Body>
</soapenv:Envelope><soapenv:Envelope>
<soapenv:Header />
<soapenv:Body>
<paf:paVerifyPaymentNoticeRes>
<outcome>OK</outcome>
<paymentList>
<paymentOptionDescription>
<amount>30.00</amount>
<options>EQ</options>
<dueDate>2021-12-31</dueDate>
<detailDescription>test</detailDescription>
<allCCP>false</allCCP>
</paymentOptionDescription>
</paymentList>
<paymentDescription>payment</paymentDescription>
<fiscalCodePA>77777777777</fiscalCodePA>
<companyName>company EC</companyName>
<officeName>office EC</officeName>
</paf:paVerifyPaymentNoticeRes>
</soapenv:Body>
</soapenv:Envelope>outcome﹡: il risultato dell'operazione che può contenere i seguenti codici
OK : operazione eseguita con successo
KO : operazione terminata con errore
paymentList: struttura che contiene i dettagli del pagamento, al momento può contenere una sola paymentOptionDescription, da inserire obbligatoriamente in caso di outcome OK
paymentOptionDescription﹡
amount﹡: importo in euro
options﹡: al momento deve essere valorizzato con EQ
dueDate: data di scadenza del pagamento secondo il formato ISO 8601 [AAAA]-[MM]-[GG]
detailDescription: testo libero per descrivere l'oggetto del pagamento
allCCP﹡: se TRUE indica che tutti i bonifici sono associabili a IBAN postali
paymentDescription: testo libero per descrivere l'oggetto del pagamento, da inserire obbligatoriamente in caso di outcome OK
fiscalCodePA: codice fiscale dell'EC, da inserire obbligatoriamente in caso di outcome OK
companyName: nome completo dell'EC, da inserire obbligatoriamente in caso di outcome OK
officeName: nome completo dell'ufficio dell'EC
paGetPayment
paGetPayment versione 1
POST
Request Body
<soapenv:Envelope>
<soapenv:Body>
<pafn:paGetPaymentReq>
<idPA>77777777777</idPA>
<idBrokerPA>77777777777</idBrokerPA>
<idStation>77777777777_01</idStation>
<qrCode>
<fiscalCode>77777777777</fiscalCode>
<noticeNumber>311111111112222222</noticeNumber>
</qrCode>
<amount>30.00</amount>
</pafn:paGetPaymentReq>
</soapenv:Body>
</soapenv:Envelope> <soapenv:Envelope>
<soapenv:Header />
<soapenv:Body>
<paf:paGetPaymentRes>
<outcome>OK</outcome>
<data>
<creditorReferenceId>11111111112222222</creditorReferenceId>
<paymentAmount>30.00</paymentAmount>
<dueDate>2021-12-31</dueDate>
<retentionDate>2021-12-31T23:59:59</retentionDate>
<lastPayment>0</lastPayment>
<description>test</description>
<companyName>company EC</companyName>
<officeName>office EC</officeName>
<debtor>
<uniqueIdentifier>
<entityUniqueIdentifierType>F</entityUniqueIdentifierType>
<entityUniqueIdentifierValue>JHNDOE00A01F205N</entityUniqueIdentifierValue>
</uniqueIdentifier>
<fullName>John Doe</fullName>
<streetName>street</streetName>
<civicNumber>12</civicNumber>
<postalCode>89020</postalCode>
<city>city</city>
<stateProvinceRegion>MI</stateProvinceRegion>
<country>IT</country>
<e-mail>john.doe@test.it</e-mail>
</debtor>
<transferList>
<transfer>
<idTransfer>1</idTransfer>
<transferAmount>20.00</transferAmount>
<fiscalCodePA>77777777777</fiscalCodePA>
<IBAN>IT0000000000000000000000000</IBAN>
<remittanceInformation>remittanceInformation1</remittanceInformation>
<transferCategory>0101100IM</transferCategory>
</transfer>
<transfer>
<idTransfer>2</idTransfer>
<transferAmount>10.00</transferAmount>
<fiscalCodePA>77777777778</fiscalCodePA>
<IBAN>IT0000000000000000000000001</IBAN>
<remittanceInformation>remittanceInformation2</remittanceInformation>
<transferCategory>0201102IM</transferCategory>
</transfer>
</transferList>
<metadata>
<mapEntry>
<key>keytest</key>
<value>1</value>
</mapEntry>
</metadata>
</data>
</paf:paGetPaymentRes>
</soapenv:Body>
</soapenv:Envelope>outcome﹡: il risultato dell'operazione che può contenere i seguenti codici
OK : operazione eseguita con successo
KO : operazione terminata con errore
data: tutti i dettagli del pagamento, da inserire obbligatoriamente in caso di outcome OK
creditorReferenceId﹡: IUV Identificativo Univoco Versamento
paymentAmount﹡: importo, deve essere uguale alle somme di TransferAmount presenti nella TransferList
dueDate﹡: data di scadenza del pagamento secondo il formato ISO 8601 [AAAA]-[MM]-[GG]
retentionDate: timestamp che indica la fine del periodo di ritenzione delle informazioni sul pagamento da parte del Nodo
lastPayment
description﹡: testo libero per descrivere l'oggetto del pagamento
companyName: nome completo dell'EC
officeName: nome completo dell'ufficio dell'EC
debtor﹡: individua il debitore a cui si riferisce la posizione debitoria
uniqueIdentifier﹡
entityUniqueIdentifierType﹡
F : Persona fisica
G : Persona giuridica
entityUniqueIdentifierValue﹡: codice fiscale o partita IVA, nel caso non siano disponibili è possibile utilizzare 'ANONIMO'
fullName﹡: nome completo del debitore
streetName: indirizzo
civicNumber: numero civico
postalCode: CAP
city: citta'
stateProvinceRegion: regione
country: stato
e-mail
transferList﹡: struttura che contiene i dettagli dei transfer, al momento possono essere inseriti fino a 5 transfer, deve essercene almeno 1
transfer﹡
idTransfer﹡: indice della lista (da 1 a 5)
transferAmount﹡: importo
fiscalCodePA﹡: codice fiscale dell'EC
IBAN﹡: IBAN sul quale sarà effettuato il riversamento
remittanceInformation﹡: motivo del pagamento
transferCategory﹡: codice tassonomico, composto da Codice tipo Ente Creditore + Progressivo macro area + Codice tipologia servizio + Motivo Giuridico ( ex. 0101002IM )
metadata: è un campo di archiviazione chiave/valore ad uso esclusivo dell'EC. I dati saranno inseriti nella receipt (paSendRT)
mapEntry﹡
key﹡
value﹡
paGetPayment versione 2
POST
In questa versione è possibile inserire i metadata in ogni singolo transfer, inoltre è possibile gestire il servizio @e.bollo.
Request Body
<soapenv:Envelope>
<soapenv:Body>
<pafn:paGetPaymentReq>
<idPA>77777777777</idPA>
<idBrokerPA>77777777777</idBrokerPA>
<idStation>77777777777_01</idStation>
<qrCode>
<fiscalCode>77777777777</fiscalCode>
<noticeNumber>311111111112222222</noticeNumber>
</qrCode>
<amount>30.00</amount>
</pafn:paGetPaymentReq>
</soapenv:Body>
</soapenv:Envelope> <soapenv:Envelope>
<soapenv:Header />
<soapenv:Body>
<paf:paGetPaymentRes>
<outcome>OK</outcome>
<data>
<creditorReferenceId>11111111112222222</creditorReferenceId>
<paymentAmount>30.00</paymentAmount>
<dueDate>2021-12-31</dueDate>
<retentionDate>2021-12-31T23:59:59</retentionDate>
<lastPayment>0</lastPayment>
<description>test</description>
<companyName>company EC</companyName>
<officeName>office EC</officeName>
<debtor>
<uniqueIdentifier>
<entityUniqueIdentifierType>F</entityUniqueIdentifierType>
<entityUniqueIdentifierValue>JHNDOE00A01F205N</entityUniqueIdentifierValue>
</uniqueIdentifier>
<fullName>John Doe</fullName>
<streetName>street</streetName>
<civicNumber>12</civicNumber>
<postalCode>89020</postalCode>
<city>city</city>
<stateProvinceRegion>MI</stateProvinceRegion>
<country>IT</country>
<e-mail>john.doe@test.it</e-mail>
</debtor>
<transferList>
<transfer>
<idTransfer>1</idTransfer>
<transferAmount>20.00</transferAmount>
<fiscalCodePA>77777777777</fiscalCodePA>
<IBAN>IT0000000000000000000000000</IBAN>
<remittanceInformation>remittanceInformation1</remittanceInformation>
<transferCategory>0101100IM</transferCategory>
<metadata>
<mapEntry>
<key>keytest</key>
<value>1</value>
</mapEntry>
</metadata>
</transfer>
<transfer>
<idTransfer>2</idTransfer>
<transferAmount>10.00</transferAmount>
<fiscalCodePA>77777777778</fiscalCodePA>
<IBAN>IT0000000000000000000000001</IBAN>
<remittanceInformation>remittanceInformation2</remittanceInformation>
<transferCategory>0201102IM</transferCategory>
</transfer>
</transferList>
<metadata>
<mapEntry>
<key>keytest</key>
<value>1</value>
</mapEntry>
</metadata>
</data>
</paf:paGetPaymentRes>
</soapenv:Body>
</soapenv:Envelope>outcome﹡: il risultato dell'operazione che può contenere i seguenti codici
OK : operazione eseguita con successo
KO : operazione terminata con errore
data: tutti i dettagli del pagamento, da inserire obbligatoriamente in caso di outcome OK
creditorReferenceId﹡: IUV Identificativo Univoco Versamento
paymentAmount﹡: importo, deve essere uguale alle somme di TransferAmount presenti nella TransferList
dueDate﹡: indica la data di scadenza del pagamento secondo il formato ISO 8601 [AAAA]-[MM]-[GG]
retentionDate: timestamp che indica la fine del periodo di ritenzione delle informazioni sul pagamento da parte del Nodo
lastPayment
description﹡: testo libero per descrivere l'oggetto del pagamento
companyName﹡: nome completo dell'EC
officeName: nome completo dell'ufficio dell'EC
debtor﹡: individua il debitore a cui si riferisce la posizione debitoria
uniqueIdentifier﹡
entityUniqueIdentifierType﹡
F : Persona fisica
G : Persona giuridica
entityUniqueIdentifierValue﹡: codice fiscale o partita IVA, nel caso non siano disponibili è possibile utilizzare 'ANONIMO'
fullName﹡: nome completo del debitore
streetName: indirizzo
civicNumber: numero civico
postalCode: CAP
city: citta'
stateProvinceRegion: regione
country: stato
e-mail
transferList﹡: struttura che contiene i dettagli dei transfer, al momento possono essere inseriti fino a 5 transfer, deve essercene almeno 1
transfer﹡
idTransfer﹡: indice della lista (da 1 a 5)
transferAmount﹡: importo in euro
fiscalCodePA﹡: codice fiscale dell'EC
CHOICE*
IBAN: IBAN sul quale sarà effettuato il riversamento
richiestaMarcaDaBollo: i dati della richiesta della marca da bollo
tipoBollo: tipologia del bollo
hashDocumento: contiene l’impronta informatica (digest), nel formato base64, del documento informatico o della segnatura di protocollo cui è associata la marca da bollo digitale
provinciaResidenza: sigla automobilistica della provincia di residenza del soggetto pagatore
remittanceInformation﹡: motivo del pagamento
transferCategory﹡: codice tassonomico, composto da Codice tipo Ente Creditore + Progressivo macro area + Codice tipologia servizio + Motivo Giuridico ( ex. 0101002IM )
metadata: è un campo di archiviazione chiave/valore.
mapEntry﹡
key﹡
value﹡
metadata: è un campo di archiviazione chiave/valore ad uso esclusivo dell'EC. I dati saranno inseriti nella receipt (paSendRT)
mapEntry﹡
key﹡
value﹡
paSendRT
paSendRT versione 1
POST
Request Body
<soapenv:Envelope>
<soapenv:Body>
<pafn:paSendRTReq>
<idPA>77777777777</idPA>
<idBrokerPA>77777777777</idBrokerPA>
<idStation>77777777777_01</idStation>
<receipt>
<receiptId>c110729d258c4ab1b765fe902aae41d6</receiptId>
<noticeNumber>311111111112222222</noticeNumber>
<fiscalCode>77777777777</fiscalCode>
<outcome>OK</outcome>
<creditorReferenceId>11111111112222222</creditorReferenceId>
<paymentAmount>30.00</paymentAmount>
<description>test</description>
<companyName>company EC</companyName>
<officeName>office EC</officeName>
<debtor>
<uniqueIdentifier>
<entityUniqueIdentifierType>F</entityUniqueIdentifierType>
<entityUniqueIdentifierValue>JHNDOE00A01F205N</entityUniqueIdentifierValue>
</uniqueIdentifier>
<fullName>John Doe</fullName>
<streetName>street</streetName>
<civicNumber>12</civicNumber>
<postalCode>89020</postalCode>
<city>city</city>
<stateProvinceRegion>MI</stateProvinceRegion>
<country>IT</country>
<e-mail>john.doe@test.it</e-mail>
</debtor>
<transferList>
<transfer>
<idTransfer>1</idTransfer>
<transferAmount>20.00</transferAmount>
<fiscalCodePA>77777777777</fiscalCodePA>
<IBAN>IT0000000000000000000000000</IBAN>
<remittanceInformation>remittanceInformation1</remittanceInformation>
<transferCategory>0101100IM</transferCategory>
</transfer>
<transfer>
<idTransfer>2</idTransfer>
<transferAmount>10.00</transferAmount>
<fiscalCodePA>77777777778</fiscalCodePA>
<IBAN>IT0000000000000000000000001</IBAN>
<remittanceInformation>remittanceInformation2</remittanceInformation>
<transferCategory>0201102IM</transferCategory>
</transfer>
</transferList>
<idPSP>88888888888</idPSP>
<pspFiscalCode>88888888888</pspFiscalCode>
<pspPartitaIVA>88888888888</pspPartitaIVA>
<PSPCompanyName>PSP name</PSPCompanyName>
<idChannel>88888888888_01</idChannel>
<channelDescription>app</channelDescription>
<payer>
<uniqueIdentifier>
<entityUniqueIdentifierType>F</entityUniqueIdentifierType>
<entityUniqueIdentifierValue>JHNDOE00A01F205N</entityUniqueIdentifierValue>
</uniqueIdentifier>
<fullName>John Doe</fullName>
<streetName>street</streetName>
<civicNumber>12</civicNumber>
<postalCode>89020</postalCode>
<city>city</city>
<stateProvinceRegion>MI</stateProvinceRegion>
<country>IT</country>
<e-mail>john.doe@test.it</e-mail>
</payer>
<paymentMethod>creditCard</paymentMethod>
<fee>2.00</fee>
<paymentDateTime>2021-10-01T17:48:22</paymentDateTime>
<applicationDate>2021-10-01</applicationDate>
<transferDate>2021-10-02</transferDate>
<metadata>
<mapEntry>
<key>keytest</key>
<value>1</value>
</mapEntry>
</metadata>
</receipt>
</pafn:paSendRTReq>
</soapenv:Body>
</soapenv:Envelope><soapenv:Envelope>
<soapenv:Body>
<paf:paSendRTRes>
<outcome>OK</outcome>
</paf:paSendRTRes>
</soapenv:Body>
</soapenv:Envelopeoutcome﹡: il risultato dell'operazione che può contenere i seguenti codici
OK : operazione eseguita con successo
KO : operazione terminata con errore
paSendRT versione 2
POST
In questa versione possono essere inseriti i metadata in ogni singolo transfer della receipt, inoltre sono gestite le informazioni ricavate da Gestione evoluta commissionie il servizio @e.bollo.
Request Body
<soapenv:Envelope>
<soapenv:Body>
<pafn:paSendRTReq>
<idPA>77777777777</idPA>
<idBrokerPA>77777777777</idBrokerPA>
<idStation>77777777777_01</idStation>
<receipt>
<receiptId>c110729d258c4ab1b765fe902aae41d6</receiptId>
<noticeNumber>311111111112222222</noticeNumber>
<fiscalCode>77777777777</fiscalCode>
<outcome>OK</outcome>
<creditorReferenceId>11111111112222222</creditorReferenceId>
<paymentAmount>30.00</paymentAmount>
<description>test</description>
<companyName>company EC</companyName>
<officeName>office EC</officeName>
<debtor>
<uniqueIdentifier>
<entityUniqueIdentifierType>F</entityUniqueIdentifierType>
<entityUniqueIdentifierValue>JHNDOE00A01F205N</entityUniqueIdentifierValue>
</uniqueIdentifier>
<fullName>John Doe</fullName>
<streetName>street</streetName>
<civicNumber>12</civicNumber>
<postalCode>89020</postalCode>
<city>city</city>
<stateProvinceRegion>MI</stateProvinceRegion>
<country>IT</country>
<e-mail>john.doe@test.it</e-mail>
</debtor>
<transferList>
<transfer>
<idTransfer>1</idTransfer>
<transferAmount>20.00</transferAmount>
<fiscalCodePA>77777777777</fiscalCodePA>
<IBAN>IT0000000000000000000000000</IBAN>
<remittanceInformation>remittanceInformation1</remittanceInformation>
<transferCategory>0101100IM</transferCategory>
<metadata>
<mapEntry>
<key>keytest</key>
<value>1</value>
</mapEntry>
</metadata>
</transfer>
<transfer>
<idTransfer>2</idTransfer>
<transferAmount>10.00</transferAmount>
<fiscalCodePA>77777777778</fiscalCodePA>
<IBAN>IT0000000000000000000000001</IBAN>
<remittanceInformation>remittanceInformation2</remittanceInformation>
<transferCategory>0201102IM</transferCategory>
</transfer>
</transferList>
<idPSP>88888888888</idPSP>
<pspFiscalCode>88888888888</pspFiscalCode>
<pspPartitaIVA>88888888888</pspPartitaIVA>
<PSPCompanyName>PSP name</PSPCompanyName>
<idChannel>88888888888_01</idChannel>
<channelDescription>app</channelDescription>
<payer>
<uniqueIdentifier>
<entityUniqueIdentifierType>F</entityUniqueIdentifierType>
<entityUniqueIdentifierValue>JHNDOE00A01F205N</entityUniqueIdentifierValue>
</uniqueIdentifier>
<fullName>John Doe</fullName>
<streetName>street</streetName>
<civicNumber>12</civicNumber>
<postalCode>89020</postalCode>
<city>city</city>
<stateProvinceRegion>MI</stateProvinceRegion>
<country>IT</country>
<e-mail>john.doe@test.it</e-mail>
</payer>
<paymentMethod>creditCard</paymentMethod>
<fee>2.00</fee>
<primaryCiIncurredFee>0.50</primaryCiIncurredFee>
<idBundle>1</idBundle>
<idCiBundle>2</idCiBundle>
<paymentDateTime>2021-10-01T17:48:22</paymentDateTime>
<applicationDate>2021-10-01</applicationDate>
<transferDate>2021-10-02</transferDate>
<metadata>
<mapEntry>
<key>keytest</key>
<value>1</value>
</mapEntry>
</metadata>
</receipt>
</pafn:paSendRTReq>
</soapenv:Body>
</soapenv:Envelope><soapenv:Envelope>
<soapenv:Body>
<paf:paSendRTRes>
<outcome>OK</outcome>
</paf:paSendRTRes>
</soapenv:Body>
</soapenv:Envelope>outcome﹡: il risultato dell'operazione che può contenere i seguenti codici
OK : operazione eseguita con successo
KO : operazione terminata con errore
verifyPaymentNotice
POST
Request Body
<soapenv:Envelope>
<soapenv:Body>
<nod:verifyPaymentNoticeReq>
<idPSP>88888888888</idPSP>
<idBrokerPSP>88888888888</idBrokerPSP>
<idChannel>88888888888_01</idChannel>
<password>**********</password>
<qrCode>
<fiscalCode>77777777777</fiscalCode>
<noticeNumber>311111111112222222</noticeNumber>
</qrCode>
</nod:verifyPaymentNoticeReq>
</soapenv:Body>
</soapenv:Envelope><soapenv:Envelope>
<soapenv:Body>
<nfpsp:verifyPaymentNoticeRes>
<outcome>OK</outcome>
<paymentList>
<paymentOptionDescription>
<amount>30.00</amount>
<options>EQ</options>
<paymentNote>test</paymentNote>
</paymentOptionDescription>
</paymentList>
<paymentDescription>payment</paymentDescription>
<fiscalCodePA>77777777777</fiscalCodePA>
<companyName>company EC</companyName>
<officeName>office EC</officeName>
</nfpsp:verifyPaymentNoticeRes>
</soapenv:Body>
</soapenv:Envelope> outcome﹡: il risultato dell'operazione che può contenere i seguenti codici
OK : operazione eseguita con successo
KO : operazione terminata con errore
paymentList: struttura che contiene i dettagli del pagamento, al momento può contenere una sola paymentOptionDescription, dato valorizzato solo in caso di outcome OK
paymentOptionDescription﹡
amount﹡: importo in euro
options﹡: al momento è valorizzato con EQ
dueDate: data di scadenza del pagamento secondo il formato ISO 8601 [AAAA]-[MM]-[GG]
paymentNote: testo libero per descrivere l'oggetto del pagamento
paymentDescription: testo libero per descrivere l'oggetto del pagamento, dato valorizzato solo in caso di outcome OK
fiscalCodePA: codice fiscale dell'EC, dato valorizzato solo in caso di outcome OK
companyName: nome completo dell'EC, dato valorizzato solo in caso di outcome OK
officeName: nome completo dell'ufficio dell'EC
verificaBollettino
POST
Request Body
<soapenv:Envelope>
<soapenv:Body>
<nod:verificaBollettinoReq>
<idPSP>88888888888</idPSP>
<idBrokerPSP>88888888888</idBrokerPSP>
<idChannel>88888888888_01</idChannel>
<password>**********</password>
<ccPost>012345678912</ccPost>
<noticeNumber>311111111112222222</noticeNumber>
</nod:verificaBollettinoReq>
</soapenv:Body>
</soapenv:Envelope><soapenv:Envelope>
<soapenv:Body>
<nfpsp:verificaBollettinoRes>
<outcome>OK</outcome>
<paymentBollettinoList>
<paymentOptionDescription>
<amount>30.00</amount>
<options>EQ</options>
<dueDate>2021-12-31</dueDate>
<paymentNote>test</paymentNote>
<allCCP>true</allCCP>
</paymentOptionDescription>
</paymentBollettinoList>
<paymentDescription>payment</paymentDescription>
<fiscalCodePA>77777777777</fiscalCodePA>
<noticeNumber>311111111112222222</noticeNumber>
<companyName>company EC</companyName>
<officeName>office EC</officeName>
</nfpsp:verificaBollettinoRes>
</soapenv:Body>
</soapenv:Envelope>outcome﹡: il risultato dell'operazione che può contenere i seguenti codici
OK : operazione eseguita con successo
KO : operazione terminata con errore
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
officeName: nome completo dell'ufficio dell'EC
activatePaymentNotice
activatePaymentNotice versione 1
POST
Request Body
<soapenv:Envelope>
<soapenv:Body>
<nod:activatePaymentNoticeReq>
<idPSP>88888888888</idPSP>
<idBrokerPSP>88888888888</idBrokerPSP>
<idChannel>88888888888_01</idChannel>
<password>**********</password>
<idempotencyKey>70000000001_100149bdWB</idempotencyKey>
<qrCode>
<fiscalCode>77777777777</fiscalCode>
<noticeNumber>311111111112222222</noticeNumber>
</qrCode>
<expirationTime>6000</expirationTime>
<amount>30.00</amount>
</nod:activatePaymentNoticeReq>
</soapenv:Body>
</soapenv:Envelope><soapenv:Envelope>
<soapenv:Body>
<nfpsp:activatePaymentNoticeRes>
<outcome>OK</outcome>
<totalAmount>30.00</totalAmount>
<paymentDescription>test</paymentDescription>
<fiscalCodePA>77777777777</fiscalCodePA>
<companyName>company EC</companyName>
<officeName>office EC</officeName>
<paymentToken>c110729d258c4ab1b765fe902aae41d6</paymentToken>
<transferList>
<transfer>
<idTransfer>1</idTransfer>
<transferAmount>20.00</transferAmount>
<fiscalCodePA>77777777777</fiscalCodePA>
<IBAN>IT0000000000000000000000000</IBAN>
<remittanceInformation>remittanceInformation1</remittanceInformation>
</transfer>
<transfer>
<idTransfer>2</idTransfer>
<transferAmount>10.00</transferAmount>
<fiscalCodePA>77777777778</fiscalCodePA>
<IBAN>IT0000000000000000000000001</IBAN>
<remittanceInformation>remittanceInformation2</remittanceInformation>
</transfer>
</transferList>
<creditorReferenceId>11111111112222222</creditorReferenceId>
</nfpsp:activatePaymentNoticeRes>
</soapenv:Body>
</soapenv:Envelope>outcome﹡: il risultato dell'operazione che può contenere i seguenti codici
OK : operazione eseguita con successo
KO : operazione terminata con errore
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 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
<soapenv:Envelope>
<soapenv:Body>
<nod:activatePaymentNoticeReq>
<idPSP>88888888888</idPSP>
<idBrokerPSP>88888888888</idBrokerPSP>
<idChannel>88888888888_01</idChannel>
<password>**********</password>
<idempotencyKey>70000000001_100149bdWB</idempotencyKey>
<qrCode>
<fiscalCode>77777777777</fiscalCode>
<noticeNumber>311111111112222222</noticeNumber>
</qrCode>
<expirationTime>6000</expirationTime>
<amount>30.00</amount>
</nod:activatePaymentNoticeReq>
</soapenv:Body>
</soapenv:Envelope><soapenv:Envelope>
<soapenv:Body>
<nfpsp:activatePaymentNoticeRes>
<outcome>OK</outcome>
<totalAmount>30.00</totalAmount>
<paymentDescription>test</paymentDescription>
<fiscalCodePA>77777777777</fiscalCodePA>
<companyName>company EC</companyName>
<officeName>office EC</officeName>
<paymentToken>c110729d258c4ab1b765fe902aae41d6</paymentToken>
<transferList>
<transfer>
<idTransfer>1</idTransfer>
<transferAmount>20.00</transferAmount>
<fiscalCodePA>77777777777</fiscalCodePA>
<IBAN>IT0000000000000000000000000</IBAN>
<remittanceInformation>remittanceInformation1</remittanceInformation>
<metadata>
<mapEntry>
<key>keytest1</key>
<value>1</value>
</mapEntry>
</metadata>
</transfer>
<transfer>
<idTransfer>2</idTransfer>
<transferAmount>10.00</transferAmount>
<fiscalCodePA>77777777778</fiscalCodePA>
<IBAN>IT0000000000000000000000001</IBAN>
<remittanceInformation>remittanceInformation2</remittanceInformation>
</transfer>
<metadata>
<mapEntry>
<key>keytest2</key>
<value>2</value>
</mapEntry>
</metadata>
</transferList>
<creditorReferenceId>11111111112222222</creditorReferenceId>
<suggestedUserFee>1.00</suggestedUserFee>
<suggestedPaFee>0.50</suggestedPaFee>
<suggestedIdBundle>1</suggestedIdBundle>
<suggestedIdCiBundle>2</suggestedIdCiBundle>
</nfpsp:activatePaymentNoticeRes>
</soapenv:Body>
</soapenv:Envelope>outcome﹡: il risultato dell'operazione che può contenere i seguenti codici
OK : operazione eseguita con successo
KO : operazione terminata con errore
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
suggestedUserFee: importo della commissione espresso in euro ricavato da Gestione evoluta commissioni
suggestedPaFee: importo della commissione a carico dell'EC espresso in euro ricavato da Gestione evoluta commissioni
suggestedIdBundle: identificativo del pacchetto di Gestione evoluta commissioni
suggestedIdCiBundle: identificativo degli attributi aggiunti dall'EC al pacchetto di Gestione evoluta commissioni
sendPaymentOutcome
sendPaymentOutcome versione 1
POST
Request Body
<soapenv:Envelope>
<soapenv:Body>
<nod:sendPaymentOutcomeReq>
<idPSP>88888888888</idPSP>
<idBrokerPSP>88888888888</idBrokerPSP>
<idChannel>88888888888_01</idChannel>
<password>**********</password>
<idempotencyKey>70000000001_100149bdWB</idempotencyKey>
<paymentToken>c110729d258c4ab1b765fe902aae41d6</paymentToken>
<outcome>OK</outcome>
<details>
<paymentMethod>creditCard</paymentMethod>
<paymentChannel>app</paymentChannel>
<fee>2.00</fee>
<payer>
<uniqueIdentifier>
<entityUniqueIdentifierType>F</entityUniqueIdentifierType>
<entityUniqueIdentifierValue>JHNDOE00A01F205N</entityUniqueIdentifierValue>
</uniqueIdentifier>
<fullName>John Doe</fullName>
<streetName>street</streetName>
<civicNumber>12</civicNumber>
<postalCode>89020</postalCode>
<city>city</city>
<stateProvinceRegion>MI</stateProvinceRegion>
<country>IT</country>
<e-mail>john.doe@test.it</e-mail>
</payer>
<applicationDate>2021-10-01</applicationDate>
<transferDate>2021-10-02</transferDate>
</details>
</nod:sendPaymentOutcomeReq>
</soapenv:Body>
</soapenv:Envelope><soapenv:Envelope>
<soapenv:Body>
<nfpsp:sendPaymentOutcomeRes>
<outcome>OK</outcome>
</nfpsp:sendPaymentOutcomeRes>
</soapenv:Body>
</soapenv:Envelope>outcome﹡: il risultato dell'operazione che può contenere i seguenti codici
OK : operazione eseguita con successo
KO : operazione terminata con errore
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, inoltre sono gestite le informazioni ricavate da Gestione evoluta commissionie il servizio @e.bollo.
Request Body
<soapenv:Envelope>
<soapenv:Body>
<nod:sendPaymentOutcomeReq>
<idPSP>88888888888</idPSP>
<idBrokerPSP>88888888888</idBrokerPSP>
<idChannel>88888888888_01</idChannel>
<password>**********</password>
<idempotencyKey>70000000001_100149bdWB</idempotencyKey>
<paymentTokens>
<paymentToken>d221820d258c4ab1b765fe902aae6d14</paymentToken>
<paymentToken>c110729d258c4ab1b765fe902aae41d6</paymentToken>
</paymentTokens>
<outcome>OK</outcome>
<details>
<paymentMethod>creditCard</paymentMethod>
<paymentChannel>app</paymentChannel>
<fee>2.00</fee>
<primaryCiIncurredFee>0.50</primaryCiIncurredFee>
<idBundle>1</idBundle>
<idCiBundle>2</idCiBundle>
<payer>
<uniqueIdentifier>
<entityUniqueIdentifierType>F</entityUniqueIdentifierType>
<entityUniqueIdentifierValue>JHNDOE00A01F205N</entityUniqueIdentifierValue>
</uniqueIdentifier>
<fullName>John Doe</fullName>
<streetName>street</streetName>
<civicNumber>12</civicNumber>
<postalCode>89020</postalCode>
<city>city</city>
<stateProvinceRegion>MI</stateProvinceRegion>
<country>IT</country>
<e-mail>john.doe@test.it</e-mail>
</payer>
<applicationDate>2021-10-01</applicationDate>
<transferDate>2021-10-02</transferDate>
</details>
</nod:sendPaymentOutcomeReq>
</soapenv:Body>
</soapenv:Envelope><soapenv:Envelope>
<soapenv:Body>
<nfpsp:sendPaymentOutcomeRes>
<outcome>OK</outcome>
</nfpsp:sendPaymentOutcomeRes>
</soapenv:Body>
</soapenv:Envelope>outcome﹡: il risultato dell'operazione che può contenere i seguenti codici
OK : operazione eseguita con successo
KO : operazione terminata con errore
pspNotifyPayment
pspNotifyPayment versione 1
POST
Request Body
<soapenv:Envelope>
<soapenv:Body>
<pspfn:pspNotifyPaymentReq>
<idPSP>88888888888</idPSP>
<idBrokerPSP>88888888888</idBrokerPSP>
<idChannel>88888888888_01</idChannel>
<paymentDescription>test</paymentDescription>
<fiscalCodePA>77777777777</fiscalCodePA>
<companyName>company EC</companyName>
<officeName>office EC</officeName>
<paymentToken>ac6536ab9967401fb6cfa98bef88ccf0</paymentToken>
<creditorReferenceId>11111111112222222</creditorReferenceId>
<debtAmount>30.00</debtAmount>
<transferList>
<transfer>
<idTransfer>1</idTransfer>
<transferAmount>20.00</transferAmount>
<fiscalCodePA>77777777777</fiscalCodePA>
<IBAN>IT0000000000000000000000000</IBAN>
<remittanceInformation>info remittance</remittanceInformation>
</transfer>
<transfer>
<idTransfer>2</idTransfer>
<transferAmount>10.00</transferAmount>
<fiscalCodePA>77777777778</fiscalCodePA>
<IBAN>IT0000000000000000000000001</IBAN>
<remittanceInformation>info remittance</remittanceInformation>
</transfer>
</transferList>
<!-- dati specifici del canale di pagamento -->
</pspfn:pspNotifyPaymentReq>
</soapenv:Body>
</soapenv:Envelope><soapenv:Envelope>
<soapenv:Body>
<psp:pspNotifyPaymentRes>
<outcome>OK</outcome>
</psp