DevPortalPagoPA




Table of contents

Primitive

To manage the errors, refer to Gestione degli errori.

paVerifyPaymentNotice

paVerifyPaymentNotice

POST

Request Body

NameTypeDescription
idPA*Stringfiscal code of the structure that sends the payment request
idBrokerPA*Stringidentifier of the entity that operates as an intermediary for the EC
idStation*StringIdentifier of the EC's station in the pagoPa system
qrCode*Stringit is composed of the fiscalCode and noticeNumber
fiscalCode*Stringfiscal code of the EC
noticeNumber*String[auxDigit][segregationCode][IUVBase][IUVCheckDigit]
1  <soapenv:Envelope>
2    <soapenv:Header />
3    <soapenv:Body>
4      <nod:paVerifyPaymentNoticeReq>
5        <idPA>77777777777</idPA>
6        <idBrokerPA>77777777777</idBrokerPA>
7        <idStation>77777777777_01</idStation>
8        <qrCode>
9          <fiscalCode>77777777777</fiscalCode>
10          <noticeNumber>311111111112222222</noticeNumber>
11        </qrCode>
12      </nod:paVerifyPaymentNoticeReq>
13    </soapenv:Body>
14  </soapenv:Envelope>
15

paGetPayment

paGetPayment version 1

POST

Request Body

NameTypeDescription
idPA*StringFiscal code of the structure that sends the payment request
dueDateStringPayment due date according to the format ISO 8601 [YYYY]-[MM]-[DD]
transferTypeStringPermitted value: POSTAL.
paymentNoteStringPayment description. Set with idCart, if the parameter is set in Payment at the EC’s frontend
amountStringPayment amount in euros.
noticeNumber*String[auxDigit][segregationCode][IUVBase][IUVCheckDigit]
fiscalCode*StringFiscal code of the EC
qrCode*StringIt is composed of the fiscalCode and noticeNumber
idStation*StringIdentifier of the EC's station in the pagoPa system
idBrokerPA*StringIdentifier of the entity that operates as an intermediary for the EC
1<soapenv:Envelope>
2    <soapenv:Body>
3      <pafn:paGetPaymentReq>
4        <idPA>77777777777</idPA>
5        <idBrokerPA>77777777777</idBrokerPA>
6        <idStation>77777777777_01</idStation>
7        <qrCode>
8          <fiscalCode>77777777777</fiscalCode>
9          <noticeNumber>311111111112222222</noticeNumber>
10        </qrCode>
11        <amount>30.00</amount>
12      </pafn:paGetPaymentReq>
13    </soapenv:Body>
14  </soapenv:Envelope>    
15

paGetPayment version 2

POST
In this version, it is possible to enter the metadata in every single transfer, it is also possible to manage the service @e.bollo.

Request Body

NameTypeDescription
idPA*StringFiscal code of the structure that sends the payment request
idBrokerPA*StringIdentifier of the entity that operates as an intermediary for the EC
idStation*StringIdentifier of the EC's station in the pagoPa system
qrCode*StringIt is composed of the fiscalCode and noticeNumber
amount*StringPayment amount in euros
paymentNoteStringPayment description. Set with idCart, if the parameter is set in Payment at the EC’s frontend
transferTypeString
Permitted values
POSTAL
PAGOPA
dueDateStringpayment due date according to the format ISO 8601 [YYYY]-[MM]-[DD]
fiscalCode*Stringfiscal code of the EC
noticeNumber*String[auxDigit][segregationCode][IUVBase][IUVCheckDigit]
1<soapenv:Envelope>
2    <soapenv:Body>
3      <pafn:paGetPaymentReq>
4        <idPA>77777777777</idPA>
5        <idBrokerPA>77777777777</idBrokerPA>
6        <idStation>77777777777_01</idStation>
7        <qrCode>
8          <fiscalCode>77777777777</fiscalCode>
9          <noticeNumber>311111111112222222</noticeNumber>
10        </qrCode>
11        <amount>30.00</amount>
12      </pafn:paGetPaymentReq>
13    </soapenv:Body>
14  </soapenv:Envelope>         
15

paSendRT

paSendRT version 1

POST

Request Body

NameTypeDescription
idPA*Stringfiscal code of the structure that sends the payment request
receiptId*StringUnique identifier of the receipt containing the paymentToken assigned by pagoPa
outcome*Stringthe result of the operation that can contain the codes OK or KO
receipt*Stringthe payment receipt
idStation*StringIdentifier of the EC's station in the pagoPa system
idBrokerPA*Stringidentifier of the entity that operates as an intermediary for the EC
entityUniqueIdentifierType*String
F : Physical person
G : Legal person
uniqueIdentifier*String
debtor*Stringidentifies the debtor to which the debt position refers
officeNameString
companyName*Stringcomplete name of the EC
description*String
paymentAmount*Stringamount expressed in euros
creditorReferenceId*StringIUV: Univocal Payment Identifier
fiscalCode*Stringfiscal code of the EC
noticeNumber*String[auxDigit][segregationCode][IUVBase][IUVCheckDigit]
entityUniqueIdentifierValue*Stringfiscal code or VAT no.
e-mailString
countryString
stateProvinceRegionString
cityString
postalCodeString
civicNumberString
streetNameString
fullName*Stringcomplete name of the debtor
transferCategory*Stringtaxonomic code, composed of Creditor type code + Progressive macro area + Service type code + Legal reason ( ex. 0101002IM )
remittanceInformation*Stringreason for the payment
IBAN*StringIBAN to which the transfer will be made
fiscalCodePA*Stringfiscal code of the EC
transferAmount*Stringamount
idTransfer*Stringindex of the list (from 1 to 5)
transfer*String
transferList*Stringstructure that contains the details of the transfers
channelDescription*String
idChannel*String
PSPCompanyName*String
pspPartitaIVAString
pspFiscalCodeString
idPSP*StringPSP identifier
key*String
mapEntry*
metadataString
transferDateStringtransfer date
applicationDateStringapplication date
paymentDateTimeStringdate and time of the payment
feeStringamount of the commission expressed in euros
paymentMethodString
e-mailString
countryString
stateProvinceRegionString
cityString
postalCodeString
civicNumberString
streetNameString
fullName*Stringcomplete name of the debtor
entityUniqueIdentifierValue*Stringfiscal code or VAT no.
entityUniqueIdentifierType*String
F : Physical person
G : Legal person
uniqueIdentifier*String
payerStringidentifies the payer
value*String
standinBooleantrue: payment took place in Stand in
1  <soapenv:Envelope>
2    <soapenv:Body>
3      <pafn:paSendRTReq>
4        <idPA>77777777777</idPA>
5        <idBrokerPA>77777777777</idBrokerPA>
6        <idStation>77777777777_01</idStation>
7        <receipt>
8          <receiptId>c110729d258c4ab1b765fe902aae41d6</receiptId>
9          <noticeNumber>311111111112222222</noticeNumber>
10          <fiscalCode>77777777777</fiscalCode>
11          <outcome>OK</outcome>
12          <creditorReferenceId>11111111112222222</creditorReferenceId>
13          <paymentAmount>30.00</paymentAmount>
14          <description>test</description>
15          <companyName>company EC</companyName>
16          <officeName>office EC</officeName>
17          <debtor>
18            <uniqueIdentifier>
19              <entityUniqueIdentifierType>F</entityUniqueIdentifierType>
20              <entityUniqueIdentifierValue>JHNDOE00A01F205N</entityUniqueIdentifierValue>
21            </uniqueIdentifier>
22            <fullName>John Doe</fullName>
23            <streetName>street</streetName>
24            <civicNumber>12</civicNumber>
25            <postalCode>89020</postalCode>
26            <city>city</city>
27            <stateProvinceRegion>MI</stateProvinceRegion>
28            <country>IT</country>
29            <e-mail>john.doe@test.it</e-mail>
30          </debtor>
31          <transferList>
32            <transfer>
33              <idTransfer>1</idTransfer>
34              <transferAmount>20.00</transferAmount>
35              <fiscalCodePA>77777777777</fiscalCodePA>
36              <IBAN>IT0000000000000000000000000</IBAN>
37              <remittanceInformation>remittanceInformation1</remittanceInformation>
38              <transferCategory>0101100IM</transferCategory>
39            </transfer>
40            <transfer>
41              <idTransfer>2</idTransfer>
42              <transferAmount>10.00</transferAmount>
43              <fiscalCodePA>77777777778</fiscalCodePA>
44              <IBAN>IT0000000000000000000000001</IBAN>
45              <remittanceInformation>remittanceInformation2</remittanceInformation>
46              <transferCategory>0201102IM</transferCategory>
47            </transfer>
48          </transferList>
49          <idPSP>88888888888</idPSP>
50          <pspFiscalCode>88888888888</pspFiscalCode>
51          <pspPartitaIVA>88888888888</pspPartitaIVA>
52          <PSPCompanyName>PSP name</PSPCompanyName>
53          <idChannel>88888888888_01</idChannel>
54          <channelDescription>app</channelDescription>
55          <payer>
56            <uniqueIdentifier>
57              <entityUniqueIdentifierType>F</entityUniqueIdentifierType>
58              <entityUniqueIdentifierValue>JHNDOE00A01F205N</entityUniqueIdentifierValue>
59            </uniqueIdentifier>
60            <fullName>John Doe</fullName>
61            <streetName>street</streetName>
62            <civicNumber>12</civicNumber>
63            <postalCode>89020</postalCode>
64            <city>city</city>
65            <stateProvinceRegion>MI</stateProvinceRegion>
66            <country>IT</country>
67            <e-mail>john.doe@test.it</e-mail>
68          </payer>
69          <paymentMethod>creditCard</paymentMethod>
70          <fee>2.00</fee>
71          <paymentDateTime>2021-10-01T17:48:22</paymentDateTime>
72          <applicationDate>2021-10-01</applicationDate>
73          <transferDate>2021-10-02</transferDate>
74          <metadata>
75            <mapEntry>
76              <key>keytest</key>
77              <value>1</value>
78            </mapEntry>
79          </metadata>
80          <standin>false</standin>
81        </receipt>
82      </pafn:paSendRTReq>
83    </soapenv:Body>
84  </soapenv:Envelope>
85

paSendRT version 2

POST
In this version the metadata can be inserted in every single transfer of the receipt, furthermore the information obtained from Advanced commission management and the @e.bollo service is managed.

Request Body

NameTypeDescription
idPA*Stringfiscal code of the structure that sends the payment request
receiptId*StringUnique identifier of the receipt containing the paymentToken assigned by pagoPa
outcome*Stringthe result of the operation that can contain the codes OK or KO
receipt*Stringthe payment receipt
idStation*StringIdentifier of the EC's station in the pagoPa system
idBrokerPA*Stringidentifier of the entity that operates as an intermediary for the EC
entityUniqueIdentifierType*String
F : Physical person
G : Legal person
uniqueIdentifier*String
debtor*Stringidentifies the debtor to which the debt position refers
officeNameString
companyName*Stringcomplete name of the EC
description*String
paymentAmount*Stringamount expressed in euros
creditorReferenceId*StringIUV: Univocal Payment Identifier
fiscalCode*Stringfiscal code of the EC
noticeNumber*String[auxDigit][segregationCode][IUVBase][IUVCheckDigit]
entityUniqueIdentifierValue*Stringfiscal code or VAT no.
e-mailString
countryString
stateProvinceRegionString
cityString
postalCodeString
civicNumberString
streetNameString
fullName*Stringcomplete name of the debtor
transferCategory*Stringtaxonomic code, composed of Creditor type code + Progressive macro area + Service type code + Legal reason ( ex. 0101002IM )
remittanceInformation*Stringreason for the payment
IBANStringIBAN to which the transfer will be made
fiscalCodePA*Stringfiscal code of the EC
transferAmount*Stringamount
idTransfer*Stringindex of the list (from 1 to 5)
transfer*String
transferList*Stringstructure that contains the details of the transfers
channelDescription*String
idChannel*String
PSPCompanyName*String
pspPartitaIVAString
pspFiscalCodeString
idPSP*StringPSP identifier
key*String
mapEntry*String
metadataString
transferDateStringtransfer date
applicationDateStringapplication date
paymentDateTimeStringdate and time of the payment
feeStringamount of the commission expressed in euros
paymentMethodString
e-mailString
countryString
stateProvinceRegionString
cityString
postalCodeString
civicNumberString
streetNameString
fullName*Stringcomplete name of the debtor
entityUniqueIdentifierValue*Stringfiscal code or VAT no.
entityUniqueIdentifierType*String
F : Physical person
G : Legal person
uniqueIdentifier*String
payerStringidentifies the payer
value*String
valueString
keyString
mapEntryString
metadataString
idCiBundleStringidentifier of the attributes the EC added to the package Advanced commission management
idBundleStringidentifier of the package Advanced commission management
primaryCiIncurredFeeStringamount of the commission paid to the EC, expressed in euros obtained from Advanced commission management
CHOICE*StringChoice between IBAN and marcaDaBollo
tipoBolloStringType of stamp duty
marcaDaBolloStringThe data of the digital stamp duty
MBDAttachmentStringThe XML document that contains the digital stamp duty, in base64 format.
paymentNoteStringPayment description. Set with idCart, if the parameter is set in Payment at the EC’s frontend
standinBooleantrue: payment took place in Stand in
companyNameStringcomplete name of the EC
1  <soapenv:Envelope>
2    <soapenv:Body>
3      <pafn:paSendRTReq>
4        <idPA>77777777777</idPA>
5        <idBrokerPA>77777777777</idBrokerPA>
6        <idStation>77777777777_01</idStation>
7        <receipt>
8          <receiptId>c110729d258c4ab1b765fe902aae41d6</receiptId>
9          <noticeNumber>311111111112222222</noticeNumber>
10          <fiscalCode>77777777777</fiscalCode>
11          <outcome>OK</outcome>
12          <creditorReferenceId>11111111112222222</creditorReferenceId>
13          <paymentAmount>30.00</paymentAmount>
14          <description>test</description>
15          <companyName>company EC1</companyName>
16          <officeName>office EC</officeName>
17          <debtor>
18            <uniqueIdentifier>
19              <entityUniqueIdentifierType>F</entityUniqueIdentifierType>
20              <entityUniqueIdentifierValue>JHNDOE00A01F205N</entityUniqueIdentifierValue>
21            </uniqueIdentifier>
22            <fullName>John Doe</fullName>
23            <streetName>street</streetName>
24            <civicNumber>12</civicNumber>
25            <postalCode>89020</postalCode>
26            <city>city</city>
27            <stateProvinceRegion>MI</stateProvinceRegion>
28            <country>IT</country>
29            <e-mail>john.doe@test.it</e-mail>
30          </debtor>
31          <transferList>
32            <transfer>
33              <idTransfer>1</idTransfer>
34              <transferAmount>20.00</transferAmount>
35              <fiscalCodePA>77777777777</fiscalCodePA>
36              <companyName>company EC1</companyName>
37              <IBAN>IT0000000000000000000000000</IBAN>
38              <remittanceInformation>remittanceInformation1</remittanceInformation>
39              <transferCategory>0101100IM</transferCategory>
40              <metadata>
41                <mapEntry>
42                  <key>keytest</key>
43                  <value>1</value>
44                </mapEntry>
45              </metadata>            
46            </transfer>
47            <transfer>
48              <idTransfer>2</idTransfer>
49              <transferAmount>10.00</transferAmount>
50              <fiscalCodePA>77777777778</fiscalCodePA>
51              <companyName>company EC2</companyName>
52              <IBAN>IT0000000000000000000000001</IBAN>
53              <remittanceInformation>remittanceInformation2</remittanceInformation>
54              <transferCategory>0201102IM</transferCategory>
55            </transfer>
56          </transferList>
57          <idPSP>88888888888</idPSP>
58          <pspFiscalCode>88888888888</pspFiscalCode>
59          <pspPartitaIVA>88888888888</pspPartitaIVA>
60          <PSPCompanyName>PSP name</PSPCompanyName>
61          <idChannel>88888888888_01</idChannel>
62          <channelDescription>app</channelDescription>
63          <payer>
64            <uniqueIdentifier>
65              <entityUniqueIdentifierType>F</entityUniqueIdentifierType>
66              <entityUniqueIdentifierValue>JHNDOE00A01F205N</entityUniqueIdentifierValue>
67            </uniqueIdentifier>
68            <fullName>John Doe</fullName>
69            <streetName>street</streetName>
70            <civicNumber>12</civicNumber>
71            <postalCode>89020</postalCode>
72            <city>city</city>
73            <stateProvinceRegion>MI</stateProvinceRegion>
74            <country>IT</country>
75            <e-mail>john.doe@test.it</e-mail>
76          </payer>
77          <paymentMethod>creditCard</paymentMethod>
78          <fee>2.00</fee>
79          <primaryCiIncurredFee>0.50</primaryCiIncurredFee>
80          <idBundle>1</idBundle>
81          <idCiBundle>2</idCiBundle>
82          <paymentDateTime>2021-10-01T17:48:22</paymentDateTime>
83          <applicationDate>2021-10-01</applicationDate>
84          <transferDate>2021-10-02</transferDate>
85          <metadata>
86            <mapEntry>
87              <key>keytest</key>
88              <value>1</value>
89            </mapEntry>
90          </metadata>
91          <standin>false</standin>
92        </receipt>
93      </pafn:paSendRTReq>
94    </soapenv:Body>
95  </soapenv:Envelope>
96

verifyPaymentNotice

verifyPaymentNotice

POST

Request Body

NameTypeDescription
idPSP*String
PSP identifier, assigned by PagoPA.
The code is generally represented by the BIC (Bank Identifier Code) of the PSP.
If the BIC is not available, or to manage particular situations, another code can be used providing that it uniquely identifies the PSP.
idBrokerPSP*String
Identifier of the intermediary, assigned by PagoPA.
Identification of the intermediary/broker of the PSP that provides access (channel) to the PSP to provide the service.
Note: the intermediary/broker can also be the PSP.
idChannel*String
Identifier of the channel, identifies a payment service category and is used to perform the transaction.
A channel identifier belongs to a single PSP intermediary/broker and as a result must be unique with respect to the PSP.
qrCode*Stringit is composed of the fiscalCode and noticeNumber.
fiscalCode*Stringfiscal code of the EC.
noticeNumber*String[auxDigit][segregationCode][IUVBase][IUVCheckDigit]
password*StringChannel password, assigned by PagoPA.
1  <soapenv:Envelope>
2    <soapenv:Body>
3      <nod:verifyPaymentNoticeReq>
4        <idPSP>88888888888</idPSP>
5        <idBrokerPSP>88888888888</idBrokerPSP>
6        <idChannel>88888888888_01</idChannel>
7        <password>**********</password>
8        <qrCode>
9          <fiscalCode>77777777777</fiscalCode>
10          <noticeNumber>311111111112222222</noticeNumber>
11        </qrCode>
12      </nod:verifyPaymentNoticeReq>
13    </soapenv:Body>
14  </soapenv:Envelope>
15

verificaBollettino

verificaBollettino

POST

Request Body

NameTypeDescription
idPSP*String
PSP identifier, assigned by PagoPA.
The code is generally represented by the BIC (Bank Identifier Code) of the PSP.
If the BIC is not available, or to manage particular situations, another code can be used providing that it uniquely identifies the PSP.
idBrokerPSP*String
Identifier of the intermediary, assigned by PagoPA.
Identification of the intermediary/broker of the PSP that provides access (channel) to the PSP to provide the service.
Note: the intermediary/broker can also be the PSP.
idChannel*String
Identifier of the channel, identifies a payment service category and is used to perform the transaction.
A channel identifier belongs to a single PSP intermediary/broker and as a result must be unique with respect to the PSP.
ccPost*Stringpostal current account of the EC.
noticeNumber*String[auxDigit][segregationCode][IUVBase][IUVCheckDigit]
password*StringChannel password, assigned by PagoPA.
1  <soapenv:Envelope>
2    <soapenv:Body>
3      <nod:verificaBollettinoReq>
4        <idPSP>88888888888</idPSP>
5        <idBrokerPSP>88888888888</idBrokerPSP>
6        <idChannel>88888888888_01</idChannel>
7        <password>**********</password>
8        <ccPost>012345678912</ccPost>
9        <noticeNumber>311111111112222222</noticeNumber>
10      </nod:verificaBollettinoReq>
11    </soapenv:Body>
12  </soapenv:Envelope>
13

activatePaymentNotice

activatePaymentNotice version 1

POST

Request Body

NameTypeDescription
idPSP*String
PSP identifier, assigned by PagoPA.
The code is generally represented by the BIC (Bank Identifier Code) of the PSP.
If the BIC is not available, or to manage particular situations, another code can be used providing that it uniquely identifies the PSP.
idBrokerPSP*String
Identifier of the intermediary, assigned by PagoPA.
Identification of the intermediary/broker of the PSP that provides access (channel) to the PSP to provide the service.
Note: the intermediary/broker can also be the PSP.
idChannel*String
Identifier of the channel, identifies a payment service category and is used to perform the transaction.
A channel identifier belongs to a single PSP intermediary/broker and as a result must be unique with respect to the PSP.
qrCode*StringIt is composed of the fiscalCode and noticeNumber
fiscalCode*StringFiscal code of the EC
noticeNumber*String[auxDigit][segregationCode][IUVBase][IUVCheckDigit]
password*StringChannel password, assigned by PagoPA.
idempotencyKeyIdempotency key
expirationTimeString
Token expiration time ( ms ), max 30 minutes.
The duration of the payment token can be set in 2 ways:
- Implicitly by the pagoPA platform, if it is not set in the request to activatePaymentNotice (default value duration = 30 minutes)
- Explicitly by the PSP, if set in the request to activatePaymentNotice
paymentNoteStringFree text for describing the subject of the payment
dueDateStringpayment due date according to the format ISO 8601 [YYYY]-[MM]-[DD]
amount*StringAmount in euros
1  <soapenv:Envelope>
2    <soapenv:Body>
3      <nod:activatePaymentNoticeReq>
4        <idPSP>88888888888</idPSP>
5        <idBrokerPSP>88888888888</idBrokerPSP>
6        <idChannel>88888888888_01</idChannel>
7        <password>**********</password>
8        <idempotencyKey>70000000001_100149bdWB</idempotencyKey>
9        <qrCode>
10          <fiscalCode>77777777777</fiscalCode>
11          <noticeNumber>311111111112222222</noticeNumber>
12        </qrCode>
13        <expirationTime>6000</expirationTime>
14        <amount>30.00</amount>
15      </nod:activatePaymentNoticeReq>
16    </soapenv:Body>
17  </soapenv:Envelope>
18

activatePaymentNotice version 2

POST
In this version it is possible for metadata to transit for every _payment**, and in every single **transfer_** of the response, furthermore the information obtained from** Advanced commission management is managed.

Request Body

NameTypeDescription
idPSP*String
PSP identifier, assigned by PagoPA.
The code is generally represented by the BIC (Bank Identifier Code) of the PSP.
If the BIC is not available, or to manage particular situations, another code can be used providing that it uniquely identifies the PSP.
idBrokerPSP*String
Identifier of the intermediary, assigned by PagoPA.
Identification of the intermediary/broker of the PSP that provides access (channel) to the PSP to provide the service.
Note: the intermediary/broker can also be the PSP.
idChannel*String
Identifier of the channel, identifies a payment service category and is used to perform the transaction.
A channel identifier belongs to a single PSP intermediary/broker and as a result must be unique with respect to the PSP.
qrCode*StringIt is composed of the fiscalCode and noticeNumber
fiscalCode*StringFiscal code of the EC
noticeNumber*String[auxDigit][segregationCode][IUVBase][IUVCheckDigit]
password*StringChannel password, assigned by PagoPA.
idempotencyKeyIdempotency key
expirationTimeString
Token expiration time ( ms ), max 30 minutes.
The duration of the payment token can be set in 2 ways:
- Implicitly by the pagoPA platform, if it is not set in the request to activatePaymentNotice (default value duration = 30 minutes)
- Explicitly by the PSP, if set in the request to activatePaymentNotice
paymentNoteStringFree text for describing the subject of the payment
dueDateStringpayment due date according to the format ISO 8601 [YYYY]-[MM]-[DD]
amount*StringAmount in euros
allCCPStringfor internal use for PagoPA services
String
paymentMethodStringpayment method
touchPointStringtouchpoint used for the payment (e.g. physical POS, ATM, ..)
1  <soapenv:Envelope>
2    <soapenv:Body>
3      <nod:activatePaymentNoticeReq>
4        <idPSP>88888888888</idPSP>
5        <idBrokerPSP>88888888888</idBrokerPSP>
6        <idChannel>88888888888_01</idChannel>
7        <password>**********</password>
8        <idempotencyKey>70000000001_100149bdWB</idempotencyKey>
9        <qrCode>
10          <fiscalCode>77777777777</fiscalCode>
11          <noticeNumber>311111111112222222</noticeNumber>
12        </qrCode>
13        <expirationTime>6000</expirationTime>
14        <amount>30.00</amount>
15      </nod:activatePaymentNoticeReq>
16    </soapenv:Body>
17  </soapenv:Envelope>
18

sendPaymentOutcome

sendPaymentOutcome version 1

POST

Request Body

NameTypeDescription
idPSP*String
PSP identifier, assigned by PagoPA.
The code is generally represented by the BIC (Bank Identifier Code) of the PSP.
If the BIC is not available, or to manage particular situations, another code can be used providing that it uniquely identifies the PSP.
detailsStringDetails of the operation result, to be entered mandatorily in the case of an OK outcome
outcome*String
The result of the operation that can contain the following
OK codes: operation performed successfully
KO : operation completed with an error
paymentToken*StringIt is generated by the system during the phase of payment activation, it is the correlation identifier to be combined to the activation and result of the payment
password*StringChannel password, assigned by PagoPA.
idChannel*String
identifier of the channel, identifies a payment service category and is used to perform the transaction.
A channel identifier belongs to a single PSP intermediary/broker and as a result must be unique with respect to the PSP.
idBrokerPSP*String
identifier of the intermediary, assigned by PagoPA.
Identification of the intermediary/broker of the PSP that provides access (channel) to the PSP to provide the service.
Note: the intermediary/broker can also be the PSP.
payerStringidentifies the payer
fee*Stringamount of the commission payed in euros
paymentChannelString
payment channel
enum: "frontOffice" "atm" "onLine" "app" "other"
paymentMethod*String
payment method
enum: "cash" "creditCard" "bancomat" "other"
transferDate*Stringdate of the transfer to the EC
applicationDate*Stringapplication date of the payment
e-mailString
countryString
stateProvinceRegionString
cityString
postalCodeString
civicNumberString
streetNameString
fullName*Stringcomplete name of the payer
uniqueIdentifier*String
entityUniqueIdentifierValue*Stringfiscal code or VAT no., if they are not available ‘ANONYMOUS’ can be used
entityUniqueIdentifierType*String
F : Physical person
G : Legal person
idempotencyKeyStringIdempotency key.
1  <soapenv:Envelope>
2    <soapenv:Body>
3        <nod:sendPaymentOutcomeReq>
4          <idPSP>88888888888</idPSP>
5          <idBrokerPSP>88888888888</idBrokerPSP>
6          <idChannel>88888888888_01</idChannel>
7          <password>**********</password>
8          <idempotencyKey>70000000001_100149bdWB</idempotencyKey>
9          <paymentToken>c110729d258c4ab1b765fe902aae41d6</paymentToken>
10          <outcome>OK</outcome>
11          <details>
12              <paymentMethod>creditCard</paymentMethod>
13              <paymentChannel>app</paymentChannel>
14              <fee>2.00</fee>
15              <payer>
16                <uniqueIdentifier>
17                    <entityUniqueIdentifierType>F</entityUniqueIdentifierType>
18                    <entityUniqueIdentifierValue>JHNDOE00A01F205N</entityUniqueIdentifierValue>
19                </uniqueIdentifier>
20                <fullName>John Doe</fullName>
21                <streetName>street</streetName>
22                <civicNumber>12</civicNumber>
23                <postalCode>89020</postalCode>
24                <city>city</city>
25                <stateProvinceRegion>MI</stateProvinceRegion>
26                <country>IT</country>
27                <e-mail>john.doe@test.it</e-mail>
28              </payer>
29              <applicationDate>2021-10-01</applicationDate>
30              <transferDate>2021-10-02</transferDate>
31          </details>
32        </nod:sendPaymentOutcomeReq>
33    </soapenv:Body>
34  </soapenv:Envelope>
35

sendPaymentOutcome version 2

POST
Used for the payment activated at the frontend of the EC, with respect to version 1 it is possible to send the outcome of multiple payment tokens at the same time, furthermore the information obtained from Advanced commission management**and the @e.bollo.** service is managed

Request Body

NameTypeDescription
idPSP*String
PSP identifier, assigned by PagoPA.
The code is generally represented by the BIC (Bank Identifier Code) of the PSP.
If the BIC is not available, or to manage particular situations, another code can be used providing that it uniquely identifies the PSP.
detailsStringdetails of the operation result, to be entered mandatorily in the case of an OK outcome
outcome*String
the result of the operation that can contain the following
OK codes: operation performed successfully
KO : operation completed with an error
paymentToken*Stringit is generated by the system during the phase of payment activation, it is the correlation identifier to be combined to the activation and result of the payment.
password*StringChannel password, assigned by PagoPA.
idChannel*String
Identifier of the channel, identifies a payment service category and is used to perform the transaction.
A channel identifier belongs to a single PSP intermediary/broker and as a result must be unique with respect to the PSP.
idBrokerPSP*String
Identifier of the intermediary, assigned by PagoPA.
Identification of the intermediary/broker of the PSP that provides access (channel) to the PSP to provide the service.
Note: the intermediary/broker can also be the PSP.
payerStringidentifies the payer
fee*Stringamount of the commission payed in euros
paymentChannelString
payment channel
enum: "frontOffice" "atm" "onLine" "app" "other"
paymentMethod*String
payment method
enum: "cash" "creditCard" "bancomat" "other"
transferDate*Stringdate of the transfer to the EC
applicationDate*Stringapplication date of the payment
e-mailString
countryString
stateProvinceRegionString
cityString
postalCodeString
civicNumberString
streetNameString
fullName*Stringcomplete name of the payer
uniqueIdentifier*String
entityUniqueIdentifierValue*Stringfiscal code or VAT no., if they are not available ‘ANONYMOUS’ can be used
entityUniqueIdentifierType*String
F : Physical person
G : Legal person
paymentTokens*Stringsequence that contains all the tokens
idempotencyKeyStringIdempotency key
idCiBundleStringidentifier of the attributes the EC added to the package Advanced commission management
idBundleStringidentifier of the package Advanced commission management
primaryCiIncurredFeeStringamount of the commission paid to the EC, expressed in euros obtained from Advanced commission management
marcheDaBolloStringThe list of the digital stamp duties managed in the payment transaction
paymentTokenStringThe paymentToken with which the digital stamp duty request arrived
idTransferStringThe identifier of the transfer that contains the richiestaMarcaDaBollo;
MBDAttachmentStringThe XML document that contains the digital stamp duty, in base64 format
marcaDaBolloStringThe data of every digital stamp duty
1  <soapenv:Envelope>
2    <soapenv:Body>
3        <nod:sendPaymentOutcomeReq>
4          <idPSP>88888888888</idPSP>
5          <idBrokerPSP>88888888888</idBrokerPSP>
6          <idChannel>88888888888_01</idChannel>
7          <password>**********</password>
8          <idempotencyKey>70000000001_100149bdWB</idempotencyKey>
9          <paymentTokens>
10              <paymentToken>d221820d258c4ab1b765fe902aae6d14</paymentToken>
11              <paymentToken>c110729d258c4ab1b765fe902aae41d6</paymentToken>
12          </paymentTokens>
13          <outcome>OK</outcome>
14          <details>
15              <paymentMethod>creditCard</paymentMethod>
16              <paymentChannel>app</paymentChannel>
17              <fee>2.00</fee>
18              <primaryCiIncurredFee>0.50</primaryCiIncurredFee>
19              <idBundle>1</idBundle>
20              <idCiBundle>2</idCiBundle>
21              <payer>
22                <uniqueIdentifier>
23                    <entityUniqueIdentifierType>F</entityUniqueIdentifierType>
24                    <entityUniqueIdentifierValue>JHNDOE00A01F205N</entityUniqueIdentifierValue>
25                </uniqueIdentifier>
26                <fullName>John Doe</fullName>
27                <streetName>street</streetName>
28                <civicNumber>12</civicNumber>
29                <postalCode>89020</postalCode>
30                <city>city</city>
31                <stateProvinceRegion>MI</stateProvinceRegion>
32                <country>IT</country>
33                <e-mail>john.doe@test.it</e-mail>
34              </payer>
35              <applicationDate>2021-10-01</applicationDate>
36              <transferDate>2021-10-02</transferDate>
37          </details>
38        </nod:sendPaymentOutcomeReq>
39    </soapenv:Body>
40  </soapenv:Envelope>
41

pspNotifyPayment

pspNotifyPayment version 1

POST

Request Body

NameTypeDescription
fiscalCodePA*StringFiscal code of the EC
paymentToken*StringIt is generated by the system during the phase of payment activation, it is the correlation identifier to be combined to the activation and result of the payment
idPSP*String
PSP identifier, assigned by PagoPA.
The code is generally represented by the BIC (Bank Identifier Code) of the PSP.
If the BIC is not available, or to manage particular situations, another code can be used providing that it uniquely identifies the PSP.
idChannel*String
Identifier of the channel, identifies a payment service category and is used to perform the transaction.
A channel identifier belongs to a single PSP intermediary/broker and as a result must be unique with respect to the PSP.
creditorReferenceId*StringIUV: Univocal Payment Identifier.
companyName*StringComplete name of the EC
officeNameStringComplete name of the office of the EC
idBrokerPSP*String
Identifier of the intermediary, assigned by PagoPA.
Identification of the intermediary/broker of the PSP that provides access (channel) to the PSP to provide the service.
Note: the intermediary/broker can also be the PSP.
debtAmount*StringRepresents the sum of the amounts of the single transfers.
paymentDescription*StringFree text for describing the subject of the payment.
remittanceInformation*StringReason for the payment
IBAN*StringIBAN to which the transfer will be made
fiscalCodePA*StringFiscal code of the EC
transferAmount*StringAmount
idTransfer*StringIndex of the list (from 1 to 5).
transfer*String
transferList*StringStructure that contains details of the payment transfers, at the moment it can contain only a maximum of 5.
specific data of the payment channelStringStructure of the specific data of the utilized payment channel.
standinBooleantrue if the payment was made in stand in
1    <soapenv:Envelope>
2      <soapenv:Body>
3          <pspfn:pspNotifyPaymentReq>
4            <idPSP>88888888888</idPSP>
5            <idBrokerPSP>88888888888</idBrokerPSP>
6            <idChannel>88888888888_01</idChannel>
7            <paymentDescription>test</paymentDescription>
8            <fiscalCodePA>77777777777</fiscalCodePA>
9            <companyName>company EC</companyName>
10            <officeName>office EC</officeName>                        
11            <paymentToken>ac6536ab9967401fb6cfa98bef88ccf0</paymentToken>
12            <creditorReferenceId>11111111112222222</creditorReferenceId>
13            <debtAmount>30.00</debtAmount>
14            <transferList>
15                <transfer>
16                  <idTransfer>1</idTransfer>
17                  <transferAmount>20.00</transferAmount>
18                  <fiscalCodePA>77777777777</fiscalCodePA>
19                  <IBAN>IT0000000000000000000000000</IBAN>
20                  <remittanceInformation>remittance info</remittanceInformation>
21                </transfer>
22                <transfer>
23                  <idTransfer>2</idTransfer>
24                  <transferAmount>10.00</transferAmount>
25                  <fiscalCodePA>77777777778</fiscalCodePA>
26                  <IBAN>IT0000000000000000000000001</IBAN>
27                  <remittanceInformation>remittance info</remittanceInformation>
28                </transfer>
29            </transferList><!-- dati specifici del canale di pagamento --><standin>false</standin>
30          </pspfn:pspNotifyPaymentReq>
31      </soapenv:Body>
32    </soapenv:Envelope>
33

pspNotifyPayment version 2

POST
**Used for the payment activated at the frontend of the EC, with respect to the previous version of pspNotifyPayment it is possible to send the PSP a _payment_ list, furthermore the specific information for the utilized payment is entered in the _additionalPaymentInformation_ section, which contains a list of metadata. It is also possible to enter the metadata for each _payment_ and in every single _transfer_ and to manage the @e.bollo.** service.

Request Body

NameTypeDescription
fiscalCodePA*StringFiscal code of the EC
paymentToken*StringIt is generated by the system during the phase of payment activation, it is the correlation identifier to be combined to the activation and result of the payment
idPSP*String
PSP identifier, assigned by PagoPA.
The code is generally represented by the BIC (Bank Identifier Code) of the PSP.
If the BIC is not available, or to manage particular situations, another code can be used providing that it uniquely identifies the PSP.
idChannel*String
Identifier of the channel, identifies a payment service category and is used to perform the transaction.
A channel identifier belongs to a single PSP intermediary/broker and as a result must be unique with respect to the PSP.
creditorReferenceId*StringIUV: Univocal Payment Identifier.
companyName*StringComplete name of the EC
officeNameStringComplete name of the office of the EC
idBrokerPSP*String
Identifier of the intermediary, assigned by PagoPA.
Identification of the intermediary/broker of the PSP that provides access (channel) to the PSP to provide the service.
Note: the intermediary/broker can also be the PSP.
debtAmount*StringRepresents the sum of the amounts of the single transfers.
paymentDescription*StringFree text for describing the subject of the payment.
remittanceInformation*StringReason for the payment
IBANStringIBAN to which the transfer will be made
fiscalCodePA*StringFiscal code of the EC
transferAmount*StringAmount
idTransfer*StringIndex of the list (from 1 to 5).
transfer*String
transferList*StringStructure that contains details of the payment transfers, at the moment it can contain only a maximum of 5.
payment*String
paymentList*StringList of payments
additionalPaymentInformationStringStructure that contains the specific data of the utilized payment channel.
mapEntry*String
key*String
value*String
CHOICE*StringChoice between IBAN and richiestaMarcaDaBollo
provinciaResidenzaStringAutomotive abbreviation of the province of residency of the paying entity
hashDocumentoStringdigest, in base64 format, of the electronic document or the protocol signature with which the digital stamp duty is associated
tipoBolloStringType of stamp duty
richiestaMarcaDaBolloStringThe data for the stamp duty request
transactionId*StringIdentifier of the payment operation.
fee*StringAmount of the commission.
totalAmount*StringRepresents the amount paid by the user, including commission.
timestampOperation*StringTimestamp of the payment operation.
IdCiBundleStringidentifier of the attributes the EC added to the package associated with Advanced commission management
IdBundleStringidentifier of the package associated with Advanced commission management
primaryCiIncurredFeeStringamount of the commission paid to the EC, expressed in euros associated with Advanced commission management
standinBooleantrue if the payment was made in stand in
companyNameStringfiscal code of the EC
1      <soapenv:Body>
2          <pspfn:pspNotifyPaymentV2>
3            <idPSP>CIPBITMM</idPSP>
4            <idBrokerPSP>13212880150</idBrokerPSP>
5            <idChannel>13212880150_02</idChannel>
6            <transactionId>99910087308786</transactionId>
7            <totalAmount>31.00</totalAmount>
8            <fee>1.00</fee>
9            <timestampOperation>2033-04-23T18:25:43Z</timestampOperation>
10            <paymentList>
11              <payment>
12                <paymentDescription>test</paymentDescription>
13                <fiscalCodePA>77777777777</fiscalCodePA>
14                <companyName>company EC</companyName>
15                <officeName>office EC</officeName>                        
16                <paymentToken>ac6536ab9967401fb6cfa98bef88ccf0</paymentToken>
17                <creditorReferenceId>11111111112222222</creditorReferenceId>
18                <debtAmount>30.00</debtAmount>
19                <transferList>
20                  <transfer>
21                    <idTransfer>1</idTransfer>
22                    <transferAmount>20.00</transferAmount>
23                    <fiscalCodePA>77777777777</fiscalCodePA>
24                    <companyName>company EC1</companyName>
25                    <IBAN>IT0000000000000000000000000</IBAN>
26                    <remittanceInformation>remittance info</remittanceInformation>
27                    <metadata>
28                      <mapEntry>
29                        <key>yyyy</key>
30                        <value>abcde</value>
31                      </mapEntry> 
32                    </metadata>
33                  </transfer>
34                  <transfer>
35                    <idTransfer>2</idTransfer>
36                    <transferAmount>10.00</transferAmount>
37                    <fiscalCodePA>77777777778</fiscalCodePA>
38                    <companyName>company EC2</companyName>
39                    <IBAN>IT0000000000000000000000001</IBAN>
40                    <remittanceInformation>remittance info</remittanceInformation>
41                  </transfer>
42                </transferList> 
43                <metadata>
44                  <mapEntry>
45                    <key>zzzz</key>
46                    <value>g2f3</value>
47                  </mapEntry> 
48                </metadata>
49              </payment>
50            </paymentList>                       
51            <additionalPaymentInformations>
52              <mapEntry>
53                <key>xxxx</key>
54                <value>1234546</value>
55              </mapEntry> 
56            </additionalPaymentInformations>
57            <standin>false</standin>
58          </pspfn:pspNotifyPaymentV2>
59      </soapenv:Body>
60    </soapenv:Envelope>    
61

demandPaymentNotice

demandPaymentNotice

POST

Request Body

NameTypeDescription
idPSP*String
PSP identifier, assigned by PagoPA.
The code is generally represented by the BIC (Bank Identifier Code) of the PSP.
If the BIC is not available, or to manage particular situations, another code can be used providing that it uniquely identifies the PSP.
datiSpecificiServizio*StringThey are recorded in the service catalog, which is the repository that contains the list of generalized services activated by the ECs, sent in base64 format. The structure to insert is defined by the XSD scheme, whose name is indicated in the xsdRiferimento element of the Service Catalog and can be consulted at https://github.com/pagopa/pagopa-api .
idSoggettoServizio*StringIdentifier of the association between the service and EC for which the payment is to be activated. Corresponds to the tag elencoSoggettiEroganti.soggettoErogante.idSoggettoServizio of the Service Catalog.
password*StringChannel password, assigned by PagoPA.
idChannel*String
Identifier of the channel, identifies a payment service category and is used to perform the transaction.
A channel identifier belongs to a single PSP intermediary/broker and as a result must be unique with respect to the PSP.
idBrokerPSP*String
Identifier of the intermediary, assigned by PagoPA.
Identification of the intermediary/broker of the PSP that provides access (channel) to the PSP to provide the service.
Note: the intermediary/broker can also be the PSP.
1<soap:Envelope>
2  <soap:Body>
3    <ns3:demandPaymentNoticeReq>
4      <idPSP>88888888888</idPSP>
5      <idBrokerPSP>88888888888</idBrokerPSP>
6      <idChannel>88888888888_01</idChannel>
7      <password>**********</password>
8      <idSoggettoServizio>00003</idServizio>
9      <datiSpecificiServizio>Service data base64 encoded</datiSpecificiServizio>
10    </ns3:demandPaymentNoticeReq>
11  </soap:Body>
12</soap:Envelope>
13

paDemandPaymentNotice

paDemandPaymentNotice

POST

Request Body

NameTypeDescription
idPA*StringFiscal code of the structure that sends the payment request
datiSpecificiServizio*StringThey are recorded in the service catalog, which is the repository that contains the list of generalized services activated by the ECs, sent in base64 format.
idServizio*StringIdentifier of the service for which the payment is to be activated.
idStation*StringIdentifier of the EC's station in the pagoPa system
idBrokerPA*StringIdentifier of the entity that operates as an intermediary for the EC
idSoggettoServizio*StringIdentifier of the association between the service and EC for which the payment is to be activated. Corresponds to the tag elencoSoggettiEroganti.soggettoErogante.idSoggettoServizio of the Service Catalog.
1<soapenv:Envelope>
2  <soapenv:Body>
3    <ppt:paDemandPaymentNoticeReq>
4      <idPA>77777777777</idPA>
5      <idBrokerPA>77777777777</idBrokerPA>
6      <idStation>77777777777_01</idStation>
7      <idServizio>00002</idServizio>
8      <idSoggettoServizio>00003</idSoggettoServizio>       
9      <datiSpecificiServizio>Service data base64 encoded</datiSpecificiServizio>
10    </ppt:paDemandPaymentNoticeReq>
11  </soapenv:Body>
12</soapenv:Envelope>
13

nodoInviaFlussoRendicontazione

nodoInviaFlussoRendicontazione

POST

Request Body

NameTypeDescription
identificativoPSP*String
PSP identifier, assigned by PagoPA.
The code is generally represented by the BIC (Bank Identifier Code) of the PSP.
If the BIC is not available, or to manage particular situations, another code can be used providing that it uniquely identifies the PSP.
xmlRendicontazione*StringContains the transfer flow in base64 format.
dataOraFlusso*StringDate and time of the reporting flow.
identificativoFlusso*StringIdentifier of the reporting flow
identificativoDominio*StringFiscal code of the EC
password*StringChannel password, assigned by PagoPA.
identificativoCanale*String
Identifier of the channel, identifies a payment service category and is used to perform the transaction.
A channel identifier belongs to a single PSP intermediary/broker and as a result must be unique with respect to the PSP.
identificativoIntermediarioPSP*String
Identifier of the intermediary, assigned by PagoPA.
Identification of the intermediary/broker of the PSP that provides access (channel) to the PSP to provide the service.
Note: the intermediary/broker can also be the PSP.
1<soap:Envelope>
2    <soap:Body>
3        <ns5:nodoInviaFlussoRendicontazione>
4            <identificativoPSP>88888888888</identificativoPSP>
5            <identificativoIntermediarioPSP>88888888888</identificativoIntermediarioPSP>
6            <identificativoCanale>88888888888_01</identificativoCanale>
7            <password>**********</password>
8            <identificativoDominio>77777777777</identificativoDominio>
9            <identificativoFlusso>2021-11-2188888888888-AABB648200001295</identificativoFlusso>
10            <dataOraFlusso>2021-11-22T00:37:32</dataOraFlusso>
11            <xmlRendicontazione>Transfer flow base64 encoded</xmlRendicontazione>
12        </ns5:nodoInviaFlussoRendicontazione>
13    </soap:Body>
14</soap:Envelope>
15

nodoChiediElencoFlussiRendicontazione

nodoChiediElencoFlussiRendicontazione

POST

Request Body

NameTypeDescription
identificativoIntermediarioPA*StringIdentifier of the entity that operates as an intermediary for the EC
identificativoPSPString
PSP identifier, assigned by PagoPA.
The code is generally represented by the BIC (Bank Identifier Code) of the PSP.
If the BIC is not available, or to manage particular situations, another code can be used providing that it uniquely identifies the PSP.
identificativoDominioStringFiscal code of the EC
password*StringStation password, assigned by PagoPA.
identificativoStazioneIntermediarioPA*StringIdentifier of the EC's station in the pagoPa system
1<soap:Envelope>
2    <soap:Body>
3        <ns5:nodoChiediElencoFlussiRendicontazione>
4            <identificativoIntermediarioPA>77777777777</identificativoIntermediarioPA>
5            <identificativoStazioneIntermediarioPA>77777777777_01</identificativoStazioneIntermediarioPA>
6            <password>**********</password>
7            <identificativoDominio>77777777777</identificativoDominio>
8            <identificativoPSP>88888888888</identificativoPSP>
9        </ns5:nodoChiediElencoFlussiRendicontazione>
10    </soap:Body>
11</soap:Envelope>
12

nodoChiediFlussoRendicontazione

nodoChiediFlussoRendicontazione

POST

Request Body

NameTypeDescription
identificativoIntermediarioPA*StringIdentifier of the entity that operates as an intermediary for the EC
identificativoFlusso*StringIdentifier of the reporting flow
identificativoPSPString
PSP identifier, assigned by PagoPA.
The code is generally represented by the BIC (Bank Identifier Code) of the PSP.
If the BIC is not available, or to manage particular situations, another code can be used providing that it uniquely identifies the PSP.
identificativoDominioStringFiscal code of the EC
password*StringStation password, assigned by PagoPA.
identificativoStazioneIntermediarioPA*StringIdentifier of the EC's station in the pagoPa system
1<soap:Envelope>
2    <soap:Body>
3        <nodoChiediElencoFlussiRendicontazione>
4            <identificativoIntermediarioPA>77777777777</identificativoIntermediarioPA>
5            <identificativoStazioneIntermediarioPA>77777777777_01</identificativoStazioneIntermediarioPA>
6            <password>**********</password>
7            <identificativoDominio>77777777777</identificativoDominio>
8            <identificativoPSP>88888888888</identificativoPSP>
9            <identificativoFlusso>2021-11-2188888888888-AABB648200001295</identificativoFlusso>
10        </nodoChiediElencoFlussiRendicontazione>
11    </soap:Body>
12</soap:Envelope>
13

nodoChiediCatalogoServizi

nodoChiediCatalogoServizi version 2

POST

Request Body

NameTypeDescription
identificativoPSP*String
PSP identifier, assigned by PagoPA.
The code is generally represented by the BIC (Bank Identifier Code) of the PSP.
If the BIC is not available, or to manage particular situations, another code can be used providing that it uniquely identifies the PSP.
identificativoDominioStringFiscal code of the EC
password*StringChannel password, assigned by PagoPA.
identificativoCanale*String
Identifier of the channel, identifies a payment service category and is used to perform the transaction.
A channel identifier belongs to a single PSP intermediary/broker and as a result must be unique with respect to the PSP.
identificativoIntermediarioPSP*String
Identifier of the intermediary, assigned by PagoPA.
Identification of the intermediary/broker of the PSP that provides access (channel) to the PSP to provide the service.
Note: the intermediary/broker can also be the PSP.
categoryStringFilter based on the service category.
commissionStringFilter based on the recommendation whether or not to apply the commissions entered by the EC that created the service.
1<soap:Envelope>
2    <soap:Body>
3        <ns5:nodoChiediCatalogoServizi>
4            <identificativoPSP>88888888888</identificativoPSP>
5            <identificativoIntermediarioPSP>88888888888</identificativoIntermediarioPSP>
6            <identificativoCanale>88888888888_01</identificativoCanale>
7            <password>**********</password>
8            <identificativoDominio>77777777777</identificativoDominio>
9            <categoria>Donations</categoria>
10            <commissione>N</commissione>
11        </ns5:nodoChiediCatalogoServizi>
12    </soap:Body>
13</soap:Envelope>
14

nodoChiediTemplateInformativaPSP

nodoChiediTemplateInformativaPSP

POST

Request Body

NameTypeDescription
identificativoPSP*String
PSP identifier, assigned by PagoPA.
The code is generally represented by the BIC (Bank Identifier Code) of the PSP.
If the BIC is not available, or to manage particular situations, another code can be used providing that it uniquely identifies the PSP.
identificativoIntermediarioPSP*String
Identifier of the intermediary, assigned by PagoPA.
Identification of the intermediary/broker of the PSP that provides access (channel) to the PSP to provide the service.
Note: the intermediary/broker can also be the PSP.
identificativoCanale*String
Identifier of the channel, identifies a payment service category and is used to perform the transaction.
A channel identifier belongs to a single PSP intermediary/broker and as a result must be unique with respect to the PSP.
password*StringChannel password, assigned by PagoPA.
1<soap:Envelope>
2    <soap:Body>
3        <ns5:nodoChiediTemplateInformativaPSP>
4            <identificativoPSP>88888888888</identificativoPSP>
5            <identificativoIntermediarioPSP>88888888888</identificativoIntermediarioPSP>
6            <identificativoCanale>88888888888_01</identificativoCanale>
7            <password>**********</password>
8        </ns5:nodoChiediTemplateInformativaPSP>
9    </soap:Body>
10</soap:Envelope>
11

EC Checkout API

New APIs - Reporting Flow Management

For the EC:
For the PSPs:

getOrganizationReceipt

Recovery of the receipt via the IUR code
Recovery of the receipt via the IUV codes

paCreatePosition

Need help?

Open a ticket using the dedicated function within your Reserved Area

Tell us what you think

For clarifications on implementation specifications, such as SACI and SANP, you can open an issue on GitHub