Table of contents
Primitive
To manage the errors, refer to Gestione degli errori.
For details see https://github.com/pagopa/pagopa-api/tree/SANP3.7.1
paVerifyPaymentNotice
POST
Request Body
| Name | Type | Description |
|---|---|---|
| idPA* | String | fiscal code of the structure that sends the payment request |
| idBrokerPA* | String | identifier of the entity that operates as an intermediary for the EC |
| idStation* | String | Identifier of the EC's station in the pagoPa system |
| qrCode* | String | it is composed of the fiscalCode and noticeNumber |
| fiscalCode* | String | fiscal 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>
151<soapenv:Envelope>
2 <soapenv:Header />
3 <soapenv:Body>
4 <paf:paVerifyPaymentNoticeRes>
5 <outcome>OK</outcome>
6 <paymentList>
7 <paymentOptionDescription>
8 <amount>30.00</amount>
9 <options>EQ</options>
10 <dueDate>2021-12-31</dueDate>
11 <detailDescription>test</detailDescription>
12 <allCCP>false</allCCP>
13 </paymentOptionDescription>
14 </paymentList>
15 <paymentDescription>payment</paymentDescription>
16 <fiscalCodePA>77777777777</fiscalCodePA>
17 <companyName>company EC</companyName>
18 <officeName>office EC</officeName>
19 </paf:paVerifyPaymentNoticeRes>
20 </soapenv:Body>
21</soapenv:Envelope>
22- outcome﹡: the result of the operation that can contain the following codes
- OK : operation performed successfully
- KO : operation completed with an error
- fault: all the details of the error, to be mandatorily entered if the outcome is KO Gestione degli errori
- paymentList: structure that contains details of the payment, at the moment it can contain only one paymentOptionDescription, to be mandatorily inserted in the case of an OK outcome
- paymentOptionDescription﹡
- amount﹡: amount in euros
- options﹡: at the moment it must be set to EQ
- dueDate: payment due date according to the format ISO 8601 [YYYY]-[MM]-[DD]
- detailDescription: free text for describing the subject of the payment
- allCCP﹡: if TRUE this indicates that all bank transfers are associated with postal IBANs
- paymentDescription: free text for describing the subject of the payment, to be entered mandatorily in case of an OK outcome
- fiscalCodePA: fiscal code of the EC, to be entered mandatorily in the case of an OK outcome
- companyName: complete name of the EC, to be entered mandatorily in the case of an OK outcome
- officeName: complete name of the office of the EC
paGetPayment version 1
POST
Request Body
| Name | Type | Description |
|---|---|---|
| idPA* | String | Fiscal code of the structure that sends the payment request |
| dueDate | String | Payment due date according to the format ISO 8601 [YYYY]-[MM]-[DD] |
| transferType | String | Permitted value: POSTAL. |
| paymentNote | String | Payment description. Set with idCart, if the parameter is set in Payment at the EC’s frontend |
| amount | String | Payment amount in euros. |
| noticeNumber* | String | [auxDigit][segregationCode][IUVBase][IUVCheckDigit] |
| fiscalCode* | String | Fiscal code of the EC |
| qrCode* | String | It is composed of the fiscalCode and noticeNumber |
| idStation* | String | Identifier of the EC's station in the pagoPa system |
| idBrokerPA* | String | Identifier 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>
151<soapenv:Envelope>
2 <soapenv:Header />
3 <soapenv:Body>
4 <paf:paGetPaymentRes>
5 <outcome>OK</outcome>
6 <data>
7 <creditorReferenceId>11111111112222222</creditorReferenceId>
8 <paymentAmount>30.00</paymentAmount>
9 <dueDate>2021-12-31</dueDate>
10 <retentionDate>2021-12-31T23:59:59</retentionDate>
11 <lastPayment>0</lastPayment>
12 <description>test</description>
13 <companyName>company EC</companyName>
14 <officeName>office EC</officeName>
15 <debtor>
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 </debtor>
29 <transferList>
30 <transfer>
31 <idTransfer>1</idTransfer>
32 <transferAmount>20.00</transferAmount>
33 <fiscalCodePA>77777777777</fiscalCodePA>
34 <IBAN>IT0000000000000000000000000</IBAN>
35 <remittanceInformation>remittanceInformation1</remittanceInformation>
36 <transferCategory>0101100IM</transferCategory>
37 </transfer>
38 <transfer>
39 <idTransfer>2</idTransfer>
40 <transferAmount>10.00</transferAmount>
41 <fiscalCodePA>77777777778</fiscalCodePA>
42 <IBAN>IT0000000000000000000000001</IBAN>
43 <remittanceInformation>remittanceInformation2</remittanceInformation>
44 <transferCategory>0201102IM</transferCategory>
45 </transfer>
46 </transferList>
47 <metadata>
48 <mapEntry>
49 <key>keytest</key>
50 <value>1</value>
51 </mapEntry>
52 </metadata>
53 </data>
54 </paf:paGetPaymentRes>
55 </soapenv:Body>
56</soapenv:Envelope>
57- outcome﹡: the result of the operation that can contain the following codes
- OK : operation performed successfully
- KO : operation completed with an error
- fault: all the details of the error, to be mandatorily entered if the outcome is KO Gestione degli errori
- data: fall the details of the payment, to be entered mandatorily in case of an OK_outcome_
- creditorReferenceId﹡: IUV: Univocal Payment Identifier;
- paymentAmount﹡: amount, must be equal to the sums of the TransferAmounts present in the TransferList
- dueDate﹡: payment due date according to the format ISO 8601 [YYYY]-[MM]-[DD]
- retentionDate: timestamp that indicates the end of the retention period for the payment information by the Node
- lastPayment
- description: free text for describing the subject of the payment
- companyName: complete name of the EC
- officeName: complete name of the office of the EC
- debtor﹡: identifies the debtor to which the debt position refers
- uniqueIdentifier﹡
- entityUniqueIdentifierType﹡
- F : Physical person
- G : Legal person
- entityUniqueIdentifierValue﹡: fiscal code or VAT no., if they are not available ‘ANONYMOUS’ can be used
- fullName: complete name of the debtor
- streetName: address
- civicNumber: civic number
- postalCode: ZIP CODE
- city: city
- stateProvinceRegion: region
- country: country
- e-mail
- transferList﹡: structure that contains the details of the transfers, currently up to 5 transfers can be entered, there must be at least 1
- transfer﹡
- idTransfer﹡: index of the list (from 1 to 5)
- transferAmount﹡: amount
- fiscalCode: fiscal code of the EC
- IBAN﹡: IBAN to which the transfer will be made
- remittanceInformation﹡: reason for the payment
- transferCategory﹡: taxonomic code, composed of Creditor type code + Progressive macro area + Service type code + Legal reason ( ex. 0101002IM )
- metadata: if is a key archiving field/value used exclusively by the EC. The data will be entered in the receipt (paSendRT)
- mapEntry﹡
- key﹡
- value﹡
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
| Name | Type | Description |
|---|---|---|
| idPA* | String | Fiscal code of the structure that sends the payment request |
| idBrokerPA* | String | Identifier of the entity that operates as an intermediary for the EC |
| idStation* | String | Identifier of the EC's station in the pagoPa system |
| qrCode* | String | It is composed of the fiscalCode and noticeNumber |
| amount* | String | Payment amount in euros |
| paymentNote | String | Payment description. Set with idCart, if the parameter is set in Payment at the EC’s frontend |
| transferType | String | Permitted values POSTAL PAGOPA |
| dueDate | String | payment due date according to the format ISO 8601 [YYYY]-[MM]-[DD] |
| fiscalCode* | String | fiscal 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>
151<soapenv:Envelope>
2 <soapenv:Header />
3 <soapenv:Body>
4 <paf:paGetPaymentRes>
5 <outcome>OK</outcome>
6 <data>
7 <creditorReferenceId>11111111112222222</creditorReferenceId>
8 <paymentAmount>30.00</paymentAmount>
9 <dueDate>2021-12-31</dueDate>
10 <retentionDate>2021-12-31T23:59:59</retentionDate>
11 <lastPayment>0</lastPayment>
12 <description>test</description>
13 <companyName>company EC</companyName>
14 <officeName>office EC</officeName>
15 <debtor>
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 </debtor>
29 <transferList>
30 <transfer>
31 <idTransfer>1</idTransfer>
32 <transferAmount>20.00</transferAmount>
33 <fiscalCodePA>77777777777</fiscalCodePA>
34 <companyName>company EC</companyName>
35 <IBAN>IT0000000000000000000000000</IBAN>
36 <remittanceInformation>remittanceInformation1</remittanceInformation>
37 <transferCategory>0101100IM</transferCategory>
38 <metadata>
39 <mapEntry>
40 <key>keytest</key>
41 <value>1</value>
42 </mapEntry>
43 </metadata>
44 </transfer>
45 <transfer>
46 <idTransfer>2</idTransfer>
47 <transferAmount>10.00</transferAmount>
48 <fiscalCodePA>77777777778</fiscalCodePA>
49 <companyName>company EC</companyName>
50 <IBAN>IT0000000000000000000000001</IBAN>
51 <remittanceInformation>remittanceInformation2</remittanceInformation>
52 <transferCategory>0201102IM</transferCategory>
53 </transfer>
54 </transferList>
55 <metadata>
56 <mapEntry>
57 <key>keytest</key>
58 <value>1</value>
59 </mapEntry>
60 </metadata>
61 </data>
62 </paf:paGetPaymentRes>
63 </soapenv:Body>
64</soapenv:Envelope>
65- outcome﹡: the result of the operation that can contain the following codes
- OK : operation performed successfully
- KO : operation completed with an error
- fault: all the details of the error, to be mandatorily entered if the outcome is KO Gestione degli errori
- data: fall the details of the payment, to be entered mandatorily in case of an OK_outcome_
- creditorReferenceId﹡: IUV: Univocal Payment Identifier;
- paymentAmount﹡: amount, must be equal to the sums of the TransferAmounts present in the TransferList
- dueDate﹡: indicates the payment due date according to the format ISO 8601 [YYYY]-[MM]-[DD]
- retentionDate: timestamp that indicates the end of the retention period for the payment information by the Node
- lastPayment
- description: free text for describing the subject of the payment
- companyName﹡: complete name of the EC
- officeName: complete name of the office of the EC
- debtor﹡: identifies the debtor to which the debt position refers
- uniqueIdentifier﹡
- entityUniqueIdentifierType﹡
- F : Physical person
- G : Legal person
- entityUniqueIdentifierValue﹡: fiscal code or VAT no., if they are not available ‘ANONYMOUS’ can be used
- fullName: complete name of the debtor
- streetName: address
- civicNumber: civic number
- postalCode: ZIP CODE
- city: city
- stateProvinceRegion: region
- country: country
- e-mail
- transferList﹡: structure that contains the details of the transfers, currently up to 5 transfers can be entered, there must be at least 1
- transfer﹡
- idTransfer﹡: index of the list (from 1 to 5)
- transferAmount﹡: amount in euros
- fiscalCode: fiscal code of the EC
- companyName﹡: complete name of the EC
- CHOICE*
- IBAN: IBAN to which the transfer will be made
- richiestaMarcaDaBollo: data for the stamp duty request
- tipoBollo: type of stamp duty
- hashDocumento: contains the digest, in base64 format, of the electronic document or the protocol signature with which the digital stamp duty is associated;
- provinciaResidenza: automotive abbreviation of the province of residency of the paying entity
- remittanceInformation﹡: reason for the payment
- transferCategory﹡: taxonomic code, composed of Creditor type code + Progressive macro area + Service type code + Legal reason ( ex. 0101002IM )
- metadata: if is a key archiving field/value. The data will be entered in the receipt (paSendRT)
- mapEntry﹡
- key﹡
- value﹡
- metadata: if is a key archiving field/value. The data will be entered in the receipt (paSendRT)
- mapEntry﹡
- key﹡
- value﹡
paSendRT version 1
POST
Request Body
| Name | Type | Description |
|---|---|---|
| idPA* | String | fiscal code of the structure that sends the payment request |
| receiptId* | String | Unique identifier of the receipt containing the paymentToken assigned by pagoPa |
| outcome* | String | the result of the operation that can contain the codes OK or KO |
| receipt* | String | the payment receipt |
| idStation* | String | Identifier of the EC's station in the pagoPa system |
| idBrokerPA* | String | identifier of the entity that operates as an intermediary for the EC |
| entityUniqueIdentifierType* | String | F : Physical person G : Legal person |
| uniqueIdentifier* | String | |
| debtor* | String | identifies the debtor to which the debt position refers |
| officeName | String | |
| companyName* | String | complete name of the EC |
| description* | String | |
| paymentAmount* | String | amount expressed in euros |
| creditorReferenceId* | String | IUV: Univocal Payment Identifier |
| fiscalCode* | String | fiscal code of the EC |
| noticeNumber* | String | [auxDigit][segregationCode][IUVBase][IUVCheckDigit] |
| entityUniqueIdentifierValue* | String | fiscal code or VAT no. |
| String | ||
| country | String | |
| stateProvinceRegion | String | |
| city | String | |
| postalCode | String | |
| civicNumber | String | |
| streetName | String | |
| fullName* | String | complete name of the debtor |
| transferCategory* | String | taxonomic code, composed of Creditor type code + Progressive macro area + Service type code + Legal reason ( ex. 0101002IM ) |
| remittanceInformation* | String | reason for the payment |
| IBAN* | String | IBAN to which the transfer will be made |
| fiscalCodePA* | String | fiscal code of the EC |
| transferAmount* | String | amount |
| idTransfer* | String | index of the list (from 1 to 5) |
| transfer* | String | |
| transferList* | String | structure that contains the details of the transfers |
| channelDescription* | String | |
| idChannel* | String | |
| PSPCompanyName* | String | |
| pspPartitaIVA | String | |
| pspFiscalCode | String | |
| idPSP* | String | PSP identifier |
| key* | String | |
| mapEntry* | ||
| metadata | String | |
| transferDate | String | transfer date |
| applicationDate | String | application date |
| paymentDateTime | String | date and time of the payment |
| fee | String | amount of the commission expressed in euros |
| paymentMethod | String | |
| String | ||
| country | String | |
| stateProvinceRegion | String | |
| city | String | |
| postalCode | String | |
| civicNumber | String | |
| streetName | String | |
| fullName* | String | complete name of the debtor |
| entityUniqueIdentifierValue* | String | fiscal code or VAT no. |
| entityUniqueIdentifierType* | String | F : Physical person G : Legal person |
| uniqueIdentifier* | String | |
| payer | String | identifies the payer |
| value* | String | |
| standin | Boolean | true: 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>
851<soapenv:Envelope>
2 <soapenv:Body>
3 <paf:paSendRTRes>
4 <outcome>OK</outcome>
5 </paf:paSendRTRes>
6 </soapenv:Body>
7</soapenv:Envelope
8- outcome﹡: the result of the operation that can contain the following codes
- OK : operation performed successfully
- KO : operation completed with an error
- fault: all the details of the error, to be mandatorily entered if the outcome is KO Gestione degli errori
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
| Name | Type | Description |
|---|---|---|
| idPA* | String | fiscal code of the structure that sends the payment request |
| receiptId* | String | Unique identifier of the receipt containing the paymentToken assigned by pagoPa |
| outcome* | String | the result of the operation that can contain the codes OK or KO |
| receipt* | String | the payment receipt |
| idStation* | String | Identifier of the EC's station in the pagoPa system |
| idBrokerPA* | String | identifier of the entity that operates as an intermediary for the EC |
| entityUniqueIdentifierType* | String | F : Physical person G : Legal person |
| uniqueIdentifier* | String | |
| debtor* | String | identifies the debtor to which the debt position refers |
| officeName | String | |
| companyName* | String | complete name of the EC |
| description* | String | |
| paymentAmount* | String | amount expressed in euros |
| creditorReferenceId* | String | IUV: Univocal Payment Identifier |
| fiscalCode* | String | fiscal code of the EC |
| noticeNumber* | String | [auxDigit][segregationCode][IUVBase][IUVCheckDigit] |
| entityUniqueIdentifierValue* | String | fiscal code or VAT no. |
| String | ||
| country | String | |
| stateProvinceRegion | String | |
| city | String | |
| postalCode | String | |
| civicNumber | String | |
| streetName | String | |
| fullName* | String | complete name of the debtor |
| transferCategory* | String | taxonomic code, composed of Creditor type code + Progressive macro area + Service type code + Legal reason ( ex. 0101002IM ) |
| remittanceInformation* | String | reason for the payment |
| IBAN | String | IBAN to which the transfer will be made |
| fiscalCodePA* | String | fiscal code of the EC |
| transferAmount* | String | amount |
| idTransfer* | String | index of the list (from 1 to 5) |
| transfer* | String | |
| transferList* | String | structure that contains the details of the transfers |
| channelDescription* | String | |
| idChannel* | String | |
| PSPCompanyName* | String | |
| pspPartitaIVA | String | |
| pspFiscalCode | String | |
| idPSP* | String | PSP identifier |
| key* | String | |
| mapEntry* | String | |
| metadata | String | |
| transferDate | String | transfer date |
| applicationDate | String | application date |
| paymentDateTime | String | date and time of the payment |
| fee | String | amount of the commission expressed in euros |
| paymentMethod | String | |
| String | ||
| country | String | |
| stateProvinceRegion | String | |
| city | String | |
| postalCode | String | |
| civicNumber | String | |
| streetName | String | |
| fullName* | String | complete name of the debtor |
| entityUniqueIdentifierValue* | String | fiscal code or VAT no. |
| entityUniqueIdentifierType* | String | F : Physical person G : Legal person |
| uniqueIdentifier* | String | |
| payer | String | identifies the payer |
| value* | String | |
| value | String | |
| key | String | |
| mapEntry | String | |
| metadata | String | |
| idCiBundle | String | identifier of the attributes the EC added to the package Advanced commission management |
| idBundle | String | identifier of the package Advanced commission management |
| primaryCiIncurredFee | String | amount of the commission paid to the EC, expressed in euros obtained from Advanced commission management |
| CHOICE* | String | Choice between IBAN and marcaDaBollo |
| tipoBollo | String | Type of stamp duty |
| marcaDaBollo | String | The data of the digital stamp duty |
| MBDAttachment | String | The XML document that contains the digital stamp duty, in base64 format. |
| paymentNote | String | Payment description. Set with idCart, if the parameter is set in Payment at the EC’s frontend |
| standin | Boolean | true: payment took place in Stand in |
| companyName | String | complete 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>
961<soapenv:Envelope>
2 <soapenv:Body>
3 <paf:paSendRTRes>
4 <outcome>OK</outcome>
5 </paf:paSendRTRes>
6 </soapenv:Body>
7</soapenv:Envelope>
8- outcome﹡: the result of the operation that can contain the following codes
- OK : operation performed successfully
- KO : operation completed with an error
- fault: all the details of the error, to be mandatorily entered if the outcome is KO Gestione degli errori
verifyPaymentNotice
verifyPaymentNotice
POST
Request Body
| Name | Type | Description |
|---|---|---|
| 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* | String | it is composed of the fiscalCode and noticeNumber. |
| fiscalCode* | String | fiscal code of the EC. |
| noticeNumber* | String | [auxDigit][segregationCode][IUVBase][IUVCheckDigit] |
| password* | String | Channel 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>
151<soapenv:Envelope>
2 <soapenv:Body>
3 <nfpsp:verifyPaymentNoticeRes>
4 <outcome>OK</outcome>
5 <paymentList>
6 <paymentOptionDescription>
7 <amount>30.00</amount>
8 <options>EQ</options>
9 <paymentNote>test</paymentNote>
10 </paymentOptionDescription>
11 </paymentList>
12 <paymentDescription>payment</paymentDescription>
13 <fiscalCodePA>77777777777</fiscalCodePA>
14 <companyName>company EC</companyName>
15 <officeName>office EC</officeName>
16 <standin>false</standin>
17 </nfpsp:verifyPaymentNoticeRes>
18 </soapenv:Body>
19</soapenv:Envelope>
20- outcome﹡: the result of the operation that can contain the following codes
- OK : operation performed successfully
- KO : operation completed with an error
- paymentList: structure that contains details of the payment, at the moment it can contain only one paymentOptionDescription, a value is inserted in the case of an OK outcome
- paymentOptionDescription﹡
- amount﹡: amount in euros
- options﹡: at the moment it is set to EQ
- dueDate: payment due date according to the format ISO 8601 [YYYY]-[MM]-[DD]
- paymentNote: free text for describing the subject of the payment
- paymentDescription: free text for describing the subject of the payment, a value is entered only in case of an OK_outcome_
- fiscalCodePA: fiscal code of the EC, a value is entered only in the case of an OK outcome
- companyName: complete name of the EC, a value is entered only in the case of an OK outcome
- officeName: complete name of the office of the EC
- standin: true in case of a payment made in Stand in
verificaBollettino
verificaBollettino
POST
Request Body
| Name | Type | Description |
|---|---|---|
| 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* | String | postal current account of the EC. |
| noticeNumber* | String | [auxDigit][segregationCode][IUVBase][IUVCheckDigit] |
| password* | String | Channel 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>
131<soapenv:Envelope>
2 <soapenv:Body>
3 <nfpsp:verificaBollettinoRes>
4 <outcome>OK</outcome>
5 <paymentBollettinoList>
6 <paymentOptionDescription>
7 <amount>30.00</amount>
8 <options>EQ</options>
9 <dueDate>2021-12-31</dueDate>
10 <paymentNote>test</paymentNote>
11 <allCCP>true</allCCP>
12 </paymentOptionDescription>
13 </paymentBollettinoList>
14 <paymentDescription>payment</paymentDescription>
15 <fiscalCodePA>77777777777</fiscalCodePA>
16 <noticeNumber>311111111112222222</noticeNumber>
17 <companyName>company EC</companyName>
18 <officeName>office EC</officeName>
19 <standin>false</standin>
20 </nfpsp:verificaBollettinoRes>
21 </soapenv:Body>
22</soapenv:Envelope>
23- outcome﹡: the result of the operation that can contain the following codes
- OK : operation performed successfully
- KO : operation completed with an error
- paymentBollettinoList: structure that contains details of the payment, at the moment it can contain only one paymentOptionDescription, a value is inserted in the case of an OK outcome, a value is inserted in the case of an OK outcome
- paymentOptionDescription﹡
- amount﹡: amount in euros
- options﹡: at the moment it is set to EQ
- dueDate: payment due date according to the format ISO 8601 [YYYY]-[MM]-[DD]
- paymentNote: free text for describing the subject of the payment
- allCCP﹡: if TRUE this indicates that all bank transfers are associated with postal IBANs
- paymentDescription: free text for describing the subject of the payment
- fiscalCodePA: fiscal code of the EC, a value is entered only in the case of an OK outcome
- noticeNumber: [auxDigit][segregationCode][IUVBase][IUVCheckDigit], a value is entered only in the case of an OK outcome
- companyName: complete name of the EC, a value is entered only in the case of an OK outcome
- officeName: complete name of the office of the EC
- standin: true in case of a payment made in Stand in
activatePaymentNotice version 1
POST
Request Body
| Name | Type | Description |
|---|---|---|
| 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* | String | It is composed of the fiscalCode and noticeNumber |
| fiscalCode* | String | Fiscal code of the EC |
| noticeNumber* | String | [auxDigit][segregationCode][IUVBase][IUVCheckDigit] |
| password* | String | Channel password, assigned by PagoPA. |
| idempotencyKey | Idempotency key | |
| expirationTime | String | 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 |
| paymentNote | String | Free text for describing the subject of the payment |
| dueDate | String | payment due date according to the format ISO 8601 [YYYY]-[MM]-[DD] |
| amount* | String | Amount 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>
181<soapenv:Envelope>
2 <soapenv:Body>
3 <nfpsp:activatePaymentNoticeRes>
4 <outcome>OK</outcome>
5 <totalAmount>30.00</totalAmount>
6 <paymentDescription>test</paymentDescription>
7 <fiscalCodePA>77777777777</fiscalCodePA>
8 <companyName>company EC</companyName>
9 <officeName>office EC</officeName>
10 <paymentToken>c110729d258c4ab1b765fe902aae41d6</paymentToken>
11 <transferList>
12 <transfer>
13 <idTransfer>1</idTransfer>
14 <transferAmount>20.00</transferAmount>
15 <fiscalCodePA>77777777777</fiscalCodePA>
16 <IBAN>IT0000000000000000000000000</IBAN>
17 <remittanceInformation>remittanceInformation1</remittanceInformation>
18 </transfer>
19 <transfer>
20 <idTransfer>2</idTransfer>
21 <transferAmount>10.00</transferAmount>
22 <fiscalCodePA>77777777778</fiscalCodePA>
23 <IBAN>IT0000000000000000000000001</IBAN>
24 <remittanceInformation>remittanceInformation2</remittanceInformation>
25 </transfer>
26 </transferList>
27 <creditorReferenceId>11111111112222222</creditorReferenceId>
28 <standin>false</standin>
29 </nfpsp:activatePaymentNoticeRes>
30 </soapenv:Body>
31</soapenv:Envelope>
32- outcome﹡: the result of the operation that can contain the following codes
- OK : operation performed successfully
- KO : operation completed with an error
- totalAmount: represents the total of the single transfer amounts, a value entered only in case of an OK outcome
- paymentDescription: free text for describing the subject of the payment, a value is entered only in case of an OK_outcome_
- fiscalCodePA: fiscal code of the EC, a value is entered only in the case of an OK outcome
- companyName: complete name of the EC, a value is entered only in the case of an OK outcome
- officeName: complete name of the office of the EC
- paymentToken: it 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, and a value is entered only in the case of an OK outcome
- transferList: structure that contains details of the payment transfers, at the moment it can contain only a maximum of 5 entered values only in the case of an OK outcome
- transfer﹡
- idTransfer﹡: permitted values from 1 to 5
- transferAmount﹡: amount in euros
- fiscalCodePA﹡: fiscal code of the beneficiary institution
- IBAN﹡: IBAN to which the amount will be transfered
- remittanceInformation: free text for describing the subject of the payment
- creditorReferenceId: IUV Univocal Payment Identifier, a value is entered only in the case of an OK outcome
- standin: true in case of a payment made in Stand in
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
| Name | Type | Description |
|---|---|---|
| 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* | String | It is composed of the fiscalCode and noticeNumber |
| fiscalCode* | String | Fiscal code of the EC |
| noticeNumber* | String | [auxDigit][segregationCode][IUVBase][IUVCheckDigit] |
| password* | String | Channel password, assigned by PagoPA. |
| idempotencyKey | Idempotency key | |
| expirationTime | String | 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 |
| paymentNote | String | Free text for describing the subject of the payment |
| dueDate | String | payment due date according to the format ISO 8601 [YYYY]-[MM]-[DD] |
| amount* | String | Amount in euros |
| allCCP | String | for internal use for PagoPA services |
| String | ||
| paymentMethod | String | payment method |
| touchPoint | String | touchpoint 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>
181<soapenv:Envelope>
2 <soapenv:Body>
3 <nfpsp:activatePaymentNoticeRes>
4 <outcome>OK</outcome>
5 <totalAmount>30.00</totalAmount>
6 <paymentDescription>test</paymentDescription>
7 <fiscalCodePA>77777777777</fiscalCodePA>
8 <companyName>company EC</companyName>
9 <officeName>office EC</officeName>
10 <paymentToken>c110729d258c4ab1b765fe902aae41d6</paymentToken>
11 <transferList>
12 <transfer>
13 <idTransfer>1</idTransfer>
14 <transferAmount>20.00</transferAmount>
15 <fiscalCodePA>77777777777</fiscalCodePA>
16 <companyName>Test EC</companyName>
17 <IBAN>IT0000000000000000000000000</IBAN>
18 <remittanceInformation>remittanceInformation1</remittanceInformation>
19 <transferCategory>0101100IM</transferCategory>
20 <metadata>
21 <mapEntry>
22 <key>keytest1</key>
23 <value>1</value>
24 </mapEntry>
25 </metadata>
26 </transfer>
27 <transfer>
28 <idTransfer>2</idTransfer>
29 <transferAmount>10.00</transferAmount>
30 <fiscalCodePA>77777777778</fiscalCodePA>
31 <companyName>Test EC 2</companyName>
32 <IBAN>IT0000000000000000000000001</IBAN>
33 <remittanceInformation>remittanceInformation2</remittanceInformation>
34 <transferCategory>0201102IM</transferCategory>
35 </transfer>
36 <metadata>
37 <mapEntry>
38 <key>keytest2</key>
39 <value>2</value>
40 </mapEntry>
41 </metadata>
42 </transferList>
43 <creditorReferenceId>11111111112222222</creditorReferenceId>
44 <suggestedUserFee>1.00</suggestedUserFee>
45 <suggestedPaFee>0.50</suggestedPaFee>
46 <suggestedIdBundle>1</suggestedIdBundle>
47 <suggestedIdCiBundle>2</suggestedIdCiBundle>
48 <standin>false</standin>
49 </nfpsp:activatePaymentNoticeRes>
50 </soapenv:Body>
51</soapenv:Envelope>
52- outcome﹡: the result of the operation that can contain the following codes
- OK : operation performed successfully
- KO : operation completed with an error
- totalAmount: represents the total of the single transfer amounts, a value entered only in case of an OK outcome
- paymentDescription: free text for describing the subject of the payment, a value is entered only in case of an OK_outcome_
- fiscalCodePA: fiscal code of the EC, a value is entered only in the case of an OK outcome
- companyName: complete name of the EC, a value is entered only in the case of an OK outcome
- officeName: complete name of the office of the EC
- paymentToken: it 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, and a value is entered only in the case of an OK outcome
- transferList: structure that contains details of the payment transfers, at the moment it can contain only a maximum of 5 entered values only in the case of an OK outcome
- transfer﹡
- idTransfer﹡: permitted values from 1 to 5
- transferAmount﹡: amount in euros
- fiscalCodePA﹡: fiscal code of the beneficiary institution
- companyName: complete name of the EC, a value is entered only in the case of an OK outcome
- IBAN﹡: IBAN to which the amount will be transfered
- remittanceInformation: free text for describing the subject of the payment
- transferCategory﹡: taxonomic code, composed of Creditor type code + Progressive macro area + Service type code + Legal reason ( ex. 0101002IM )
- metadata: if is a key archiving field/value.
- mapEntry﹡
- key﹡
- value﹡
- creditorReferenceId: IUV Univocal Payment Identifier, a value is entered only in the case of an OK outcome
- suggestedUserFee: amount of the commission expressed in euros obtained from Advanced commission management
- suggestedPaFee: amount of the commission paid to the EC, expressed in euros obtained from Advanced commission management
- suggestedIdBundle: identifier of the package Advanced commission management
- suggestedIdCiBundle: identifier of the attributes the EC added to the package Advanced commission management
- standin: true in case of a payment made in Stand in
sendPaymentOutcome version 1
POST
Request Body
| Name | Type | Description |
|---|---|---|
| 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. |
| details | String | Details 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* | String | It 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* | String | Channel 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. |
| payer | String | identifies the payer |
| fee* | String | amount of the commission payed in euros |
| paymentChannel | String | payment channel enum: "frontOffice" "atm" "onLine" "app" "other" |
| paymentMethod* | String | payment method enum: "cash" "creditCard" "bancomat" "other" |
| transferDate* | String | date of the transfer to the EC |
| applicationDate* | String | application date of the payment |
| String | ||
| country | String | |
| stateProvinceRegion | String | |
| city | String | |
| postalCode | String | |
| civicNumber | String | |
| streetName | String | |
| fullName* | String | complete name of the payer |
| uniqueIdentifier* | String | |
| entityUniqueIdentifierValue* | String | fiscal code or VAT no., if they are not available ‘ANONYMOUS’ can be used |
| entityUniqueIdentifierType* | String | F : Physical person G : Legal person |
| idempotencyKey | String | Idempotency 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>
351<soapenv:Envelope>
2 <soapenv:Body>
3 <nfpsp:sendPaymentOutcomeRes>
4 <outcome>OK</outcome>
5 </nfpsp:sendPaymentOutcomeRes>
6 </soapenv:Body>
7</soapenv:Envelope>
8- outcome﹡: the result of the operation that can contain the following codes
- OK : operation performed successfully
- KO : operation completed with an error
- fault: all the details of the error, to be mandatorily entered if the outcome is KO Gestione degli errori
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
| Name | Type | Description |
|---|---|---|
| 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. |
| details | String | details 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* | String | it 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* | String | Channel 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. |
| payer | String | identifies the payer |
| fee* | String | amount of the commission payed in euros |
| paymentChannel | String | payment channel enum: "frontOffice" "atm" "onLine" "app" "other" |
| paymentMethod* | String | payment method enum: "cash" "creditCard" "bancomat" "other" |
| transferDate* | String | date of the transfer to the EC |
| applicationDate* | String | application date of the payment |
| String | ||
| country | String | |
| stateProvinceRegion | String | |
| city | String | |
| postalCode | String | |
| civicNumber | String | |
| streetName | String | |
| fullName* | String | complete name of the payer |
| uniqueIdentifier* | String | |
| entityUniqueIdentifierValue* | String | fiscal code or VAT no., if they are not available ‘ANONYMOUS’ can be used |
| entityUniqueIdentifierType* | String | F : Physical person G : Legal person |
| paymentTokens* | String | sequence that contains all the tokens |
| idempotencyKey | String | Idempotency key |
| idCiBundle | String | identifier of the attributes the EC added to the package Advanced commission management |
| idBundle | String | identifier of the package Advanced commission management |
| primaryCiIncurredFee | String | amount of the commission paid to the EC, expressed in euros obtained from Advanced commission management |
| marcheDaBollo | String | The list of the digital stamp duties managed in the payment transaction |
| paymentToken | String | The paymentToken with which the digital stamp duty request arrived |
| idTransfer | String | The identifier of the transfer that contains the richiestaMarcaDaBollo; |
| MBDAttachment | String | The XML document that contains the digital stamp duty, in base64 format |
| marcaDaBollo | String | The 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>
411<soapenv:Envelope>
2 <soapenv:Body>
3 <nfpsp:sendPaymentOutcomeRes>
4 <outcome>OK</outcome>
5 </nfpsp:sendPaymentOutcomeRes>
6 </soapenv:Body>
7</soapenv:Envelope>
8- outcome﹡: the result of the operation that can contain the following codes
- OK : operation performed successfully
- KO : operation completed with an error
- fault: all the details of the error, to be mandatorily entered if the outcome is KO Gestione degli errori
pspNotifyPayment version 1
POST
Request Body
| Name | Type | Description |
|---|---|---|
| fiscalCodePA* | String | Fiscal code of the EC |
| paymentToken* | String | It 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* | String | IUV: Univocal Payment Identifier. |
| companyName* | String | Complete name of the EC |
| officeName | String | Complete 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* | String | Represents the sum of the amounts of the single transfers. |
| paymentDescription* | String | Free text for describing the subject of the payment. |
| remittanceInformation* | String | Reason for the payment |
| IBAN* | String | IBAN to which the transfer will be made |
| fiscalCodePA* | String | Fiscal code of the EC |
| transferAmount* | String | Amount |
| idTransfer* | String | Index of the list (from 1 to 5). |
| transfer* | String | |
| transferList* | String | Structure that contains details of the payment transfers, at the moment it can contain only a maximum of 5. |
| specific data of the payment channel | String | Structure of the specific data of the utilized payment channel. |
| standin | Boolean | true 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>
331<soapenv:Envelope>
2 <soapenv:Body>
3 <psp:pspNotifyPaymentRes>
4 <outcome>OK</outcome>
5 </psp:pspNotifyPaymentRes>
6 </soapenv:Body>
7</soapenv:Envelope>
8- outcome﹡: the result of the operation that can contain the following codes
- OK : operation performed successfully
- KO : operation completed with an error
- fault: all the details of the error, to be mandatorily entered if the outcome is KO Gestione degli errori
Credit card (discontinued 30/04/2023)
1<creditCardPayment>
2 <rrn>11223344</rrn>
3 <outcomePaymentGateway>00</outcomePaymentGateway>
4 <totalAmount>31.00</totalAmount>
5 <fee>1.00</fee>
6 <timestampOperation>2021-07-09T17:06:03</timestampOperation>
7 <authorizationCode>123456</authorizationCode>
8</creditCardPayment>
9Paypal
1<paypalPayment>
2 <transactionId>11223344</transactionId>
3 <pspTransactionId>00</pspTransactionId>
4 <totalAmount>31.00</totalAmount>
5 <fee>1.00</fee>
6 <timestampOperation>2021-07-09T17:06:03</timestampOperation>
7</paypalPayment>
8Bancomat Pay
1<bancomatpayPayment>
2 <transactionId>11223344</transactionId>
3 <outcomePaymentGateway>00</outcomePaymentGateway>
4 <totalAmount>31.00</totalAmount>
5 <fee>1.00</fee>
6 <timestampOperation>2021-07-09T17:06:03</timestampOperation>
7 <authorizationCode>123456</authorizationCode>
8 <paymentGateway></paymentGateway>
9</bancomatpayPayment>
10Other payment channels
1<additionalPaymentInformations>
2 <metadata>
3 <mapEntry>
4 <key>keytest</key>
5 <value>1</value>
6 </mapEntry>
7 </metadata>
8</additionalPaymentInformations>
9pspNotifyPayment 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
| Name | Type | Description |
|---|---|---|
| fiscalCodePA* | String | Fiscal code of the EC |
| paymentToken* | String | It 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* | String | IUV: Univocal Payment Identifier. |
| companyName* | String | Complete name of the EC |
| officeName | String | Complete 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* | String | Represents the sum of the amounts of the single transfers. |
| paymentDescription* | String | Free text for describing the subject of the payment. |
| remittanceInformation* | String | Reason for the payment |
| IBAN | String | IBAN to which the transfer will be made |
| fiscalCodePA* | String | Fiscal code of the EC |
| transferAmount* | String | Amount |
| idTransfer* | String | Index of the list (from 1 to 5). |
| transfer* | String | |
| transferList* | String | Structure that contains details of the payment transfers, at the moment it can contain only a maximum of 5. |
| payment* | String | |
| paymentList* | String | List of payments |
| additionalPaymentInformation | String | Structure that contains the specific data of the utilized payment channel. |
| mapEntry* | String | |
| key* | String | |
| value* | String | |
| CHOICE* | String | Choice between IBAN and richiestaMarcaDaBollo |
| provinciaResidenza | String | Automotive abbreviation of the province of residency of the paying entity |
| hashDocumento | String | digest, in base64 format, of the electronic document or the protocol signature with which the digital stamp duty is associated |
| tipoBollo | String | Type of stamp duty |
| richiestaMarcaDaBollo | String | The data for the stamp duty request |
| transactionId* | String | Identifier of the payment operation. |
| fee* | String | Amount of the commission. |
| totalAmount* | String | Represents the amount paid by the user, including commission. |
| timestampOperation* | String | Timestamp of the payment operation. |
| IdCiBundle | String | identifier of the attributes the EC added to the package associated with Advanced commission management |
| IdBundle | String | identifier of the package associated with Advanced commission management |
| primaryCiIncurredFee | String | amount of the commission paid to the EC, expressed in euros associated with Advanced commission management |
| standin | Boolean | true if the payment was made in stand in |
| companyName | String | fiscal 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>
611<soapenv:Envelope>
2 <soapenv:Body>
3 <psp:pspNotifyPaymentV2Res>
4 <outcome>OK</outcome>
5 </psp:pspNotifyPaymentV2Res>
6 </soapenv:Body>
7</soapenv:Envelope>
8- outcome﹡: the result of the operation that can contain the following codes
- OK : operation performed successfully
- KO : operation completed with an error
- fault: all the details of the error, to be mandatorily entered if the outcome is KO Gestione degli errori
demandPaymentNotice
demandPaymentNotice
POST
Request Body
| Name | Type | Description |
|---|---|---|
| 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* | String | They 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* | String | Identifier 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* | String | Channel 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>
131<soapenv:Envelope>
2 <soapenv:Body>
3 <ppt:demandPaymentNoticeRes>
4 <outcome>OK</outcome>
5 <qrCode>
6 <fiscalCode>77777777778</fiscalCode>
7 <noticeNumber>311111111112222222</noticeNumber>
8 </qrCode>
9 <paymentList>
10 <paymentOptionDescription>
11 <amount>30.00</amount>
12 <options>EQ</options>
13 <paymentNote>test</paymentNote>
14 </paymentOptionDescription>
15 </paymentList>
16 <paymentDescription>payment</paymentDescription>
17 <fiscalCodePA>77777777777</fiscalCodePA>
18 <companyName>company EC</companyName>
19 <officeName>office EC</officeName>
20 </ppt:demandPaymentNoticeRes>
21 </soapenv:Body>
22</soapenv:Envelope>
23- outcome﹡: the result of the operation that can contain the following codes
- OK : operation performed successfully
- KO : operation completed with an error
- qrCode: it is composed of the fiscalCode and noticeNumber, data entered only the case of an OK outcome
- fiscalCode: fiscal code of the EC
- noticeNumber: [auxDigit][segregationCode][IUVBase][IUVCheckDigit]
- paymentList: structure that contains details of the payment, at the moment it can contain only one paymentOptionDescription, a value is inserted in the case of an OK outcome
- paymentOptionDescription﹡
- amount﹡: amount in euros
- options﹡: at the moment it is set to EQ
- dueDate: payment due date according to the format ISO 8601 [YYYY]-[MM]-[DD]
- paymentNote: free text for describing the subject of the payment
- paymentDescription: free text for describing the subject of the payment, a value is entered only in case of an OK_outcome_
- fiscalCodePA: fiscal code of the EC, a value is entered only in the case of an OK outcome
- companyName: complete name of the EC, a value is entered only in the case of an OK outcome
- officeName: complete name of the office of the EC
paDemandPaymentNotice
paDemandPaymentNotice
POST
Request Body
| Name | Type | Description |
|---|---|---|
| idPA* | String | Fiscal code of the structure that sends the payment request |
| datiSpecificiServizio* | String | They 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* | String | Identifier of the service for which the payment is to be activated. |
| idStation* | String | Identifier of the EC's station in the pagoPa system |
| idBrokerPA* | String | Identifier of the entity that operates as an intermediary for the EC |
| idSoggettoServizio* | String | Identifier 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>
131 <soapenv:Body>
2 <ns5:paDemandPaymentNoticeRes">
3 <outcome>OK</outcome>
4 <qrCode>
5 <fiscalCode>77777777778</fiscalCode>
6 <noticeNumber>311111111112222222</noticeNumber>
7 </qrCode>
8 <paymentList>
9 <paymentOptionDescription>
10 <amount>30.00</amount>
11 <options>EQ</options>
12 <paymentNote>test</paymentNote>
13 </paymentOptionDescription>
14 </paymentList>
15 <paymentDescription>payment</paymentDescription>
16 <fiscalCodePA>77777777777</fiscalCodePA>
17 <companyName>company EC</companyName>
18 <officeName>office EC</officeName>
19 </ns5:paDemandPaymentNoticeRes>
20 </soapenv:Body>
21</soapenv:Envelope>
22- outcome﹡: the result of the operation that can contain the following codes
- OK : operation performed successfully
- KO : operation completed with an error
- qrCode: it is composed of the fiscalCode and noticeNumber, data entered only the case of an OK outcome
- fiscalCode: fiscal code of the EC
- noticeNumber: [auxDigit][segregationCode][IUVBase][IUVCheckDigit]
- paymentList: structure that contains details of the payment, at the moment it can contain only one paymentOptionDescription, a value is inserted in the case of an OK outcome
- paymentOptionDescription﹡
- amount﹡: amount in euros
- options﹡: at the moment it is set to EQ
- dueDate: payment due date according to the format ISO 8601 [YYYY]-[MM]-[DD]
- paymentNote: free text for describing the subject of the payment
- paymentDescription: free text for describing the subject of the payment, a value is entered only in case of an OK_outcome_
- fiscalCodePA: fiscal code of the EC, a value is entered only in the case of an OK outcome
- companyName: complete name of the EC, a value is entered only in the case of an OK outcome
- officeName: complete name of the office of the EC
nodoInviaFlussoRendicontazione
nodoInviaFlussoRendicontazione
POST
Request Body
| Name | Type | Description |
|---|---|---|
| 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* | String | Contains the transfer flow in base64 format. |
| dataOraFlusso* | String | Date and time of the reporting flow. |
| identificativoFlusso* | String | Identifier of the reporting flow |
| identificativoDominio* | String | Fiscal code of the EC |
| password* | String | Channel 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>
151<soapenv:Envelope>
2 <soapenv:Body>
3 <ppt:nodoInviaFlussoRendicontazioneRisposta>
4 <esito>OK</esito>
5 </ppt:nodoInviaFlussoRendicontazioneRisposta>
6 </soapenv:Body>
7</soapenv:Envelope>
8- outcome﹡: the result of the operation that can contain the following codes
- OK : operation performed successfully
- KO : operation completed with an error
nodoChiediElencoFlussiRendicontazione
nodoChiediElencoFlussiRendicontazione
POST
Request Body
| Name | Type | Description |
|---|---|---|
| identificativoIntermediarioPA* | String | Identifier of the entity that operates as an intermediary for the EC |
| 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. |
| identificativoDominio | String | Fiscal code of the EC |
| password* | String | Station password, assigned by PagoPA. |
| identificativoStazioneIntermediarioPA* | String | Identifier 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>
121<soapenv:Envelope>
2 <soapenv:Body>
3 <nodoChiediElencoFlussiRendicontazioneResponse>
4 <esito>OK</esito>
5 <elencoFlussiRendicontazione>
6 <totRestituiti>1</totRestituiti>
7 <idRendicontazione>
8 <identificativoFlusso>2021-11-2188888888888-AABB648200001295</identificativoFlusso>
9 <dataOraFlusso>2021-11-22T00:37:32</dataOraFlusso>
10 </idRendicontazione>
11 </elencoFlussiRendicontazione>
12 </nodoChiediElencoFlussiRendicontazioneResponse>
13 </soapenv:Body>
14</soapenv:Envelope>
15- outcome﹡: the result of the operation that can contain the following codes
- OK : operation performed successfully
- KO : operation completed with an error
- elencoFlussiRendicontazione: list of the transfer flows, a value is entered only in case of an OK outcome
- totRestituiti: number of flows present in the list
- idRendicontazione
- identificativoFlusso: identifier of the reporting flow
- dataOraFlusso: date and time of the reporting flow
nodoChiediFlussoRendicontazione
nodoChiediFlussoRendicontazione
POST
Request Body
| Name | Type | Description |
|---|---|---|
| identificativoIntermediarioPA* | String | Identifier of the entity that operates as an intermediary for the EC |
| identificativoFlusso* | String | Identifier of the reporting flow |
| 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. |
| identificativoDominio | String | Fiscal code of the EC |
| password* | String | Station password, assigned by PagoPA. |
| identificativoStazioneIntermediarioPA* | String | Identifier 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>
131<soapenv:Envelope>
2 <soapenv:Body>
3 <nodoChiediFlussoRendicontazioneResponse>
4 <esito>OK</esito>
5 <xmlRendicontazione>Transfer flow base64 encoded</xmlRendicontazione>
6 </nodoChiediFlussoRendicontazioneResponse>
7 </soapenv:Body>
8</soapenv:Envelope>
9- outcome﹡: the result of the operation that can contain the following codes
- OK : operation performed successfully
- KO : operation completed with an error
- xmlRendicontazione: contains the transfer flow in base64 format, a value is entered only in case of an OK outcome
nodoChiediCatalogoServizi
nodoChiediCatalogoServizi version 2
POST
Request Body
| Name | Type | Description |
|---|---|---|
| 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. |
| identificativoDominio | String | Fiscal code of the EC |
| password* | String | Channel 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. |
| category | String | Filter based on the service category. |
| commission | String | Filter 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>
141<soapenv:Envelope>
2 <soapenv:Body>
3 <nodoChiediCatalogoServizi>
4 <esito>OK</esito>
5 <xmlCatalogoServizi>Service catalog base64 encoded</xmlCatalogoServizi>
6 </nodoChiediCatalogoServizi>
7 </soapenv:Body>
8</soapenv:Envelope>
9- outcome﹡: the result of the operation that can contain the following codes
- OK : operation performed successfully
- KO : operation completed with an error
- xmlCatalogoServizi: contains the service catalog in base64 format, a value is entered only in case of an OK outcome
nodoChiediTemplateInformativaPSP
nodoChiediTemplateInformativaPSP
POST
Request Body
| Name | Type | Description |
|---|---|---|
| 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* | String | Channel 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>
111<soapenv:Envelope>
2 <soapenv:Body>
3 <nodoChiediTemplateInformativaPSP>
4 <esito>OK</esito>
5 <xmlTemplateInformativa>Information template base64 encoded</xmlTemplateInformativa>
6 </nodoChiediTemplateInformativaPSP>
7 </soapenv:Body>
8</soapenv:Envelope>
9- outcome﹡: the result of the operation that can contain the following codes
- OK : operation performed successfully
- KO : operation completed with an error
- xmlTemplateInformativa: template of the information in base64 format, a value is entered only in case of an OK outcome
EC Checkout API
post
Parameters
New APIs - Reporting Flow Management
For the EC:
get
get
get
get
For the PSPs:
getOrganizationReceipt
Recovery of the receipt via the IUR code
Recovery of the receipt via the IUV codes
paCreatePosition
On this page
Tell us what you think
For clarifications on implementation specifications, such as SACI and SANP, you can open an issue on GitHub