SANP 3.7.1
SANPSACI
Tutto il resto

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.7.1

paVerifyPaymentNotice

POST

Request Body

NameTypeDescription

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]

  <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>

paGetPayment

paGetPayment versione 1

POST

Request Body

NameTypeDescription

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.

<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>

paGetPayment versione 2

POST

In questa versione è possibile inserire i metadata in ogni singolo transfer, inoltre è possibile gestire il servizio @e.bollo.

Request Body

NameTypeDescription

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]

<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>

paSendRT

paSendRT versione 1

POST

Request Body

NameTypeDescription

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

e-mail

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

e-mail

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

  <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>
          <standin>false</standin>
        </receipt>
      </pafn:paSendRTReq>
    </soapenv:Body>
  </soapenv:Envelope>

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

NameTypeDescription

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

e-mail

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

e-mail

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

  <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 EC1</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>
              <companyName>company EC1</companyName>
              <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>
              <companyName>company EC2</companyName>
              <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>
          <standin>false</standin>
        </receipt>
      </pafn:paSendRTReq>
    </soapenv:Body>
  </soapenv:Envelope>

verifyPaymentNotice

POST

Request Body

NameTypeDescription

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.

  <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>

verificaBollettino

POST

Request Body

NameTypeDescription

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.

  <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>

activatePaymentNotice

activatePaymentNotice versione 1

POST

Request Body

NameTypeDescription

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

  <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>

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

NameTypeDescription

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, ..)

  <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>

sendPaymentOutcome

sendPaymentOutcome versione 1

POST

Request Body

NameTypeDescription

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

e-mail

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.

  <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>

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

NameTypeDescription

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

e-mail

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

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

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

  <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>

pspNotifyPayment

pspNotifyPayment versione 1

POST

Request Body

NameTypeDescription

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

    <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 -->
            
            <standin>false</standin>
          </pspfn:pspNotifyPaymentReq>
      </soapenv:Body>
    </soapenv:Envelope>

pspNotifyPayment versione 2

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.

Request Body

NameTypeDescription

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

identificativo degli attributi aggiunti dall'EC al pacchetto associato a Gestione evoluta commissioni

IdBundle

String

identificativo del pacchetto associato a Gestione evoluta commissioni

primaryCiIncurredFee

String

importo della commissione a carico dell'EC espresso in euro associato a Gestione evoluta commissioni

standin

Boolean

true se pagamento eseguito in standin

companyName

String

codice fiscale dell'EC

      <soapenv:Body>
          <pspfn:pspNotifyPaymentV2>
            <idPSP>CIPBITMM</idPSP>
            <idBrokerPSP>13212880150</idBrokerPSP>
            <idChannel>13212880150_02</idChannel>
            <transactionId>99910087308786</transactionId>
            <totalAmount>31.00</totalAmount>
            <fee>1.00</fee>
            <timestampOperation>2033-04-23T18:25:43Z</timestampOperation>
            <paymentList>
              <payment>
                <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>
                    <companyName>company EC1</companyName>
                    <IBAN>IT0000000000000000000000000</IBAN>
                    <remittanceInformation>info remittance</remittanceInformation>
                    <metadata>
                      <mapEntry>
                        <key>yyyy</key>
                        <value>abcde</value>
                      </mapEntry> 
                    </metadata>
                  </transfer>
                  <transfer>
                    <idTransfer>2</idTransfer>
                    <transferAmount>10.00</transferAmount>
                    <fiscalCodePA>77777777778</fiscalCodePA>
                    <companyName>company EC2</companyName>
                    <IBAN>IT0000000000000000000000001</IBAN>
                    <remittanceInformation>info remittance</remittanceInformation>
                  </transfer>
                </transferList> 
                <metadata>
                  <mapEntry>
                    <key>zzzz</key>
                    <value>g2f3</value>
                  </mapEntry> 
                </metadata>
              </payment>
            </paymentList>                       
            <additionalPaymentInformations>
              <mapEntry>
                <key>xxxx</key>
                <value>1234546</value>
              </mapEntry> 
            </additionalPaymentInformations>
            <standin>false</standin>
          </pspfn:pspNotifyPaymentV2>
      </soapenv:Body>
    </soapenv:Envelope>

demandPaymentNotice

POST

Request Body

NameTypeDescription

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

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 https://github.com/pagopa/pagopa-api .

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.

<soap:Envelope>
  <soap:Body>
    <ns3:demandPaymentNoticeReq>
      <idPSP>88888888888</idPSP>
      <idBrokerPSP>88888888888</idBrokerPSP>
      <idChannel>88888888888_01</idChannel>
      <password>**********</password>
      <idSoggettoServizio>00003</idServizio>
      <datiSpecificiServizio>Dati del servizio base64 encoded</datiSpecificiServizio>
    </ns3:demandPaymentNoticeReq>
  </soap:Body>
</soap:Envelope>

paDemandPaymentNotice

POST

Request Body

NameTypeDescription

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.

<soapenv:Envelope>
  <soapenv:Body>
    <ppt:paDemandPaymentNoticeReq>
      <idPA>77777777777</idPA>
      <idBrokerPA>77777777777</idBrokerPA>
      <idStation>77777777777_01</idStation>
      <idServizio>00002</idServizio>
      <idSoggettoServizio>00003</idSoggettoServizio>       
      <datiSpecificiServizio>Dati del servizio base64 encoded</datiSpecificiServizio>
    </ppt:paDemandPaymentNoticeReq>
  </soapenv:Body>
</soapenv:Envelope>

nodoInviaFlussoRendicontazione

POST

Request Body

NameTypeDescription

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.

<soap:Envelope>
    <soap:Body>
        <ns5:nodoInviaFlussoRendicontazione>
            <identificativoPSP>88888888888</identificativoPSP>
            <identificativoIntermediarioPSP>88888888888</identificativoIntermediarioPSP>
            <identificativoCanale>88888888888_01</identificativoCanale>
            <password>**********</password>
            <identificativoDominio>77777777777</identificativoDominio>
            <identificativoFlusso>2021-11-2188888888888-AABB648200001295</identificativoFlusso>
            <dataOraFlusso>2021-11-22T00:37:32</dataOraFlusso>
            <xmlRendicontazione>Flusso di riversamento base64 encoded</xmlRendicontazione>
        </ns5:nodoInviaFlussoRendicontazione>
    </soap:Body>
</soap:Envelope>

nodoChiediElencoFlussiRendicontazione

POST

Request Body

NameTypeDescription

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.

<soap:Envelope>
    <soap:Body>
        <ns5:nodoChiediElencoFlussiRendicontazione>
            <identificativoIntermediarioPA>77777777777</identificativoIntermediarioPA>
            <identificativoStazioneIntermediarioPA>77777777777_01</identificativoStazioneIntermediarioPA>
            <password>**********</password>
            <identificativoDominio>77777777777</identificativoDominio>
            <identificativoPSP>88888888888</identificativoPSP>
        </ns5:nodoChiediElencoFlussiRendicontazione>
    </soap:Body>
</soap:Envelope>

nodoChiediFlussoRendicontazione

POST

Request Body

NameTypeDescription

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.

<soap:Envelope>
    <soap:Body>
        <nodoChiediElencoFlussiRendicontazione>
            <identificativoIntermediarioPA>77777777777</identificativoIntermediarioPA>
            <identificativoStazioneIntermediarioPA>77777777777_01</identificativoStazioneIntermediarioPA>
            <password>**********</password>
            <identificativoDominio>77777777777</identificativoDominio>
            <identificativoPSP>88888888888</identificativoPSP>
            <identificativoFlusso>2021-11-2188888888888-AABB648200001295</identificativoFlusso>
        </nodoChiediElencoFlussiRendicontazione>
    </soap:Body>
</soap:Envelope>

nodoChiediCatalogoServizi

nodoChiediCatalogoServizi versione 2

POST

Request Body

NameTypeDescription

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.

<soap:Envelope>
    <soap:Body>
        <ns5:nodoChiediCatalogoServizi>
            <identificativoPSP>88888888888</identificativoPSP>
            <identificativoIntermediarioPSP>88888888888</identificativoIntermediarioPSP>
            <identificativoCanale>88888888888_01</identificativoCanale>
            <password>**********</password>
            <identificativoDominio>77777777777</identificativoDominio>
            <categoria>Donazioni</categoria>
            <commissione>N</commissione>
        </ns5:nodoChiediCatalogoServizi>
    </soap:Body>
</soap:Envelope>

nodoChiediTemplateInformativaPSP

POST

Request Body

NameTypeDescription

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.

<soap:Envelope>
    <soap:Body>
        <ns5:nodoChiediTemplateInformativaPSP>
            <identificativoPSP>88888888888</identificativoPSP>
            <identificativoIntermediarioPSP>88888888888</identificativoIntermediarioPSP>
            <identificativoCanale>88888888888_01</identificativoCanale>
            <password>**********</password>
        </ns5:nodoChiediTemplateInformativaPSP>
    </soap:Body>
</soap:Envelope>

EC Checkout API

Nuove API - Gestione Flussi di Rendicontazione

Per gli EC:

Per i PSP:

getOrganizationReceipt

Recupero della ricevuta mediante il codice IUR

Recupero della ricevuta mediante i codici IUV

paCreatePosition

PreviousGestione evoluta commissioniNextFunzionalità deprecate

Last updated