DevPortalPagoPA

Table of contents

đź“„ Input trace specifications

In order to trigger the massive loading process for the debt positions, regardless of the selected method it is necessary to create a file in “”JSON”” format according to the specifications provided below in the document.

REST creation and update file trace

The template for the JSON file to be produced for massive loading via REST API is provided below:
1{
2    "paymentPositions": [
3      {
4        "iupd": "string",
5        "aca": false,
6        "payStandIn": false,
7        "type": "F",
8        "fiscalCode": "string",
9        "fullName": "string",
10        "streetName": "string",
11        "civicNumber": "string",
12        "postalCode": "string",
13        "city": "string",
14        "province": "string",
15        "region": "string",
16        "country": "IT",
17        "email": "string",
18        "phone": "string",
19        "switchToExpired": false,
20        "companyName": "string",
21        "officeName": "string",
22        "validityDate": "YYYY-MM-DDThh:mm:ss.SSSZ",
23        "paymentOption": [
24          {
25            "iuv": "string",
26            "amount": 0,
27            "description": "string",
28            "isPartialPayment": true,
29            "dueDate": "YYYY-MM-DDThh:mm:ss.SSSZ",
30            "retentionDate": "YYYY-MM-DDThh:mm:ss.SSSZ",
31            "fee": 0,
32            "transfer": [
33              {
34                "idTransfer": "1",
35                "amount": 0,
36                "organizationFiscalCode": "00000000000",
37                "remittanceInformation": "string",
38                "category": "string",
39                "iban": "IT0000000000000000000000000",
40                "postalIban": "IT0000000000000000000000000",
41                "stamp": {
42                  "hashDocument": "string",
43                  "stampType": "st",
44                  "provincialResidence": "RM"
45                },
46                "transferMetadata": [
47                  {
48                    "key": "string",
49                    "value": "string"
50                  }
51                ]
52              }
53            ],
54            "paymentOptionMetadata": [
55              {
56                "key": "string",
57                "value": "string"
58              }
59            ]
60          }
61        ]
62      }
63    ]
64  }
65

SFTP creation and update file trace

The template for the JSON file to be produced for massive loading via SFTP is provided below:
1{
2    "operation": "CREATE|UPDATE",
3    "paymentPositions": [
4      {
5        "iupd": "string",
6        "aca": false,
7        "payStandIn": false,
8        "type": "F",
9        "fiscalCode": "string",
10        "fullName": "string",
11        "streetName": "string",
12        "civicNumber": "string",
13        "postalCode": "string",
14        "city": "string",
15        "province": "string",
16        "region": "string",
17        "country": "IT",
18        "email": "string",
19        "phone": "string",
20        "switchToExpired": false,
21        "companyName": "string",
22        "officeName": "string",
23        "validityDate": "YYYY-MM-DDThh:mm:ss.SSSZ",
24        "paymentOption": [
25          {
26            "iuv": "string",
27            "amount": 0,
28            "description": "string",
29            "isPartialPayment": true,
30            "dueDate": "YYYY-MM-DDThh:mm:ss.SSSZ",
31            "retentionDate": "YYYY-MM-DDThh:mm:ss.SSSZ",
32            "fee": 0,
33            "transfer": [
34              {
35                "idTransfer": "1",
36                "amount": 0,
37                "organizationFiscalCode": "00000000000",
38                "remittanceInformation": "string",
39                "category": "string",
40                "iban": "IT0000000000000000000000000",
41                "postalIban": "IT0000000000000000000000000",
42                "stamp": {
43                  "hashDocument": "string",
44                  "stampType": "st",
45                  "provincialResidence": "RM"
46                },
47                "transferMetadata": [
48                  {
49                    "key": "string",
50                    "value": "string"
51                  }
52                ]
53              }
54            ],
55            "paymentOptionMetadata": [
56              {
57                "key": "string",
58                "value": "string"
59              }
60            ]
61          }
62        ]
63      }
64    ]
65  }
66
It is an array of debt positions, the fields were already described in the Available operations section of the SANP.

REST deletion file trace

The template for the JSON file to be produced for massive deletion via the REST API is provided below:
1{
2  "paymentPositionIUPDs": [
3    "IUPD-string"
4  ]
5}
6

SFTP deletion file trace

The template for the JSON file to be produced for massive deletion via SFTP is provided below:
1{
2    "operation": "DELETE",
3    "paymentPositionIUPDs": [
4        "IUPD-string"
5    ]
6}
7

File specifications

The file trace is common to both loading methods API and SFTP, however particular specifications have been defined below for both of them.

SFTP (Secure File Transfer Protocol)

  • file format -> JSON
  • file dimensions -> max 100MB (circa 100K PD)
  • nomenclature -> there are no constraints regarding file nomenclature, however the name must be univocal, it is not possible to load two files with the same name

API

  • file format -> ZIP (only one JSON file in the archive)
  • file dimensions -> max 5MB (approx. 100K PD)
  • nomenclature -> there are no constraints

On this page

REST creation and update file trace

SFTP creation and update file trace

REST deletion file trace

SFTP deletion file trace

File specifications

SFTP (Secure File Transfer Protocol)

API

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