PagoPA · Schema

PaymentPositionModel

CompanyPaymentsGovernmentPublic SectorDigital IdentityInteroperabilityNotificationsItaly

Properties

Name	Type	Description
iupd	string
type	string
payStandIn	boolean	feature flag to enable a debt position in stand-in mode
fiscalCode	string
fullName	string
streetName	string
civicNumber	string
postalCode	string
city	string
province	string
region	string
country	string
email	string
phone	string
switchToExpired	boolean	feature flag to enable the debt position to expire after the due date
companyName	string
officeName	string
validityDate	string
paymentDate	string
status	string
paymentOption	array

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/pagopa/main/json-schema/pagopa-payment-position-model-schema.json",
  "title": "PaymentPositionModel",
  "x-generated": "2026-10-09",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/pagopa-gpd-aca-openapi.yml#/components/schemas/PaymentPositionModel",
  "required": [
    "companyName",
    "fiscalCode",
    "fullName",
    "iupd",
    "switchToExpired",
    "type"
  ],
  "type": "object",
  "properties": {
    "iupd": {
      "type": "string"
    },
    "type": {
      "enum": [
        "F",
        "G"
      ],
      "type": "string"
    },
    "payStandIn": {
      "type": "boolean",
      "description": "feature flag to enable a debt position in stand-in mode",
      "default": "true"
    },
    "fiscalCode": {
      "type": "string"
    },
    "fullName": {
      "type": "string"
    },
    "streetName": {
      "type": "string"
    },
    "civicNumber": {
      "type": "string"
    },
    "postalCode": {
      "type": "string"
    },
    "city": {
      "type": "string"
    },
    "province": {
      "type": "string"
    },
    "region": {
      "type": "string"
    },
    "country": {
      "pattern": "[A-Z]{2}",
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "phone": {
      "type": "string"
    },
    "switchToExpired": {
      "type": "boolean",
      "description": "feature flag to enable the debt position to expire after the due date",
      "default": "false"
    },
    "companyName": {
      "maxLength": 140,
      "minLength": 0,
      "type": "string"
    },
    "officeName": {
      "maxLength": 140,
      "minLength": 0,
      "type": "string"
    },
    "validityDate": {
      "type": "string",
      "format": "date-time"
    },
    "paymentDate": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "status": {
      "enum": [
        "DRAFT",
        "PUBLISHED",
        "VALID",
        "INVALID",
        "EXPIRED",
        "PARTIALLY_PAID",
        "PAID",
        "REPORTED"
      ],
      "type": "string",
      "readOnly": true
    },
    "paymentOption": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/PaymentOptionModel"
      }
    }
  },
  "$defs": {
    "PaymentOptionMetadataModel": {
      "required": [
        "key",
        "value"
      ],
      "type": "object",
      "properties": {
        "key": {
          "maxLength": 140,
          "minLength": 0,
          "type": "string"
        },
        "value": {
          "maxLength": 140,
          "minLength": 0,
          "type": "string"
        }
      }
    },
    "PaymentOptionModel": {
      "required": [
        "amount",
        "description",
        "dueDate",
        "isPartialPayment",
        "iuv"
      ],
      "type": "object",
      "properties": {
        "nav": {
          "type": "string"
        },
        "iuv": {
          "type": "string"
        },
        "amount": {
          "minimum": 1.0,
          "type": "integer",
          "format": "int64"
        },
        "description": {
          "maxLength": 140,
          "minLength": 0,
          "type": "string"
        },
        "isPartialPayment": {
          "type": "boolean"
        },
        "dueDate": {
          "type": "string",
          "format": "date-time"
        },
        "retentionDate": {
          "type": "string",
          "format": "date-time"
        },
        "fee": {
          "type": "integer",
          "format": "int64",
          "readOnly": true
        },
        "notificationFee": {
          "type": "integer",
          "format": "int64",
          "readOnly": true
        },
        "transfer": {
          "maxItems": 5,
          "minItems": 1,
          "type": "array",
          "items": {
            "$ref": "#/$defs/TransferModel"
          }
        },
        "paymentOptionMetadata": {
          "maxItems": 10,
          "minItems": 0,
          "uniqueItems": true,
          "type": "array",
          "items": {
            "$ref": "#/$defs/PaymentOptionMetadataModel"
          },
          "description": "It can be added a maximum of 10 key-value pairs for metadata. Metadata keys must be unique within the same payment option."
        }
      }
    },
    "Stamp": {
      "required": [
        "hashDocument",
        "provincialResidence",
        "stampType"
      ],
      "type": "object",
      "properties": {
        "hashDocument": {
          "maxLength": 72,
          "minLength": 0,
          "type": "string",
          "description": "Document hash type is stBase64Binary72 as described in https://github.com/pagopa/pagopa-api."
        },
        "stampType": {
          "maxLength": 2,
          "minLength": 2,
          "type": "string",
          "description": "The type of the stamp"
        },
        "provincialResidence": {
          "pattern": "[A-Z]{2}",
          "type": "string",
          "description": "The provincial of the residence"
        }
      }
    },
    "TransferMetadataModel": {
      "required": [
        "key",
        "value"
      ],
      "type": "object",
      "properties": {
        "key": {
          "maxLength": 140,
          "minLength": 0,
          "type": "string"
        },
        "value": {
          "maxLength": 140,
          "minLength": 0,
          "type": "string"
        }
      }
    },
    "TransferModel": {
      "required": [
        "amount",
        "category",
        "idTransfer",
        "remittanceInformation"
      ],
      "type": "object",
      "properties": {
        "idTransfer": {
          "enum": [
            "1",
            "2",
            "3",
            "4",
            "5"
          ],
          "type": "string"
        },
        "amount": {
          "minimum": 1.0,
          "type": "integer",
          "format": "int64"
        },
        "organizationFiscalCode": {
          "type": "string",
          "description": "Fiscal code related to the organization targeted by this transfer."
        },
        "remittanceInformation": {
          "maxLength": 140,
          "minLength": 0,
          "type": "string"
        },
        "category": {
          "type": "string"
        },
        "iban": {
          "maxLength": 35,
          "minLength": 1,
          "pattern": "^[A-Za-z0-9]{1,35}$",
          "type": "string",
          "description": "mutual exclusive with stamp"
        },
        "postalIban": {
          "maxLength": 35,
          "minLength": 1,
          "pattern": "^$|^[A-Za-z0-9]{1,35}$",
          "type": "string",
          "description": "optional - can be combined with iban but not with stamp"
        },
        "stamp": {
          "$ref": "#/$defs/Stamp"
        },
        "companyName": {
          "maxLength": 140,
          "minLength": 0,
          "type": "string"
        },
        "transferMetadata": {
          "maxItems": 10,
          "minItems": 0,
          "uniqueItems": true,
          "type": "array",
          "items": {
            "$ref": "#/$defs/TransferMetadataModel"
          },
          "description": "It can be added a maximum of 10 key-value pairs for metadata. Metadata keys must be unique within the same transfer."
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this

find_json_schemasBrowse and filter every JSON Schema in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This JSON Schema

curl "https://apis.io/api/v1/json-schemas/pagopa-payment-position-model"

All schemas

curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.