API v1

Configurazione tenant

L'admin, dall'interfaccia di configurazione dei pagamenti della Stanza del Cittadino compila la configurazione mediante una form, il cui json schema è servito dall'API /tenants/schema

Lo schema della form sopra riportata è il seguente

{
    "display": "form",
    "components": [
        {
            "label": "UUID del Tenant",
            "placeholder": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "spellcheck": false,
            "attributes": {
                "readonly": "readonly"
            },
            "hidden": true,
            "tableView": false,
            "validate": {
                "required": true
            },
            "key": "id",
            "type": "textfield",
            "input": true
        },
        {
            "label": "Nome dell'ente",
            "placeholder": "Comune di Bugliano",
            "tableView": true,
            "validate": {
                "required": true
            },
            "key": "name",
            "type": "textfield",
            "input": true
        },
        {
            "label": "Codice IPA dell'ente",
            "placeholder": "A000",
            "description": "Codice (tutto maiuscolo) assegnato all'Ente nel registro <a href='http://www.indicepa.gov.it' target='__blank'>indice PA</a>",
            "spellcheck": false,
            "tableView": true,
            "validate": {
                "required": true
            },
            "key": "IPA_code",
            "type": "textfield",
            "input": true
        },
        {
            "label": "Password",
            "placeholder": "************",
            "description": "Password assegnata da MyPay all’Ente",
            "spellcheck": false,
            "tableView": false,
            "validate": {
                "required": true
            },
            "key": "password",
            "type": "textfield",
            "input": true
        },
        {
            "label": "Password carrello dovuti",
            "placeholder": "************",
            "description": "Password assegnata all’ente creditore. Tale password va richiesta all’amministratore dell’ente creditore.<br>ATTENZIONE: questo dato NON coincide con la password (principale) dell’ente.",
            "spellcheck": false,
            "tableView": true,
            "key": "cart_password",
            "type": "textfield",
            "input": true
        },
        {
            "label": "Codice applicazione",
            "spellcheck": false,
            "tableView": true,
            "key": "application_code",
            "type": "textfield",
            "input": true,
            "hidden": true,
            "defaultValue": "SDC"
        },
        {
            "label": "Abilitato",
            "key": "active",
            "type": "checkbox",
            "input": true,
            "hidden": true,
            "defaultValue": true
        },
        {
            "label": "Salva",
            "showValidations": false,
            "tableView": false,
            "key": "submit",
            "type": "button",
            "input": true
        }
    ]
}

Premendo poi il bottone Salva, viene eseguita una POST /tenants servita dal proxy, con payload

{
  "name": "Comune di Bugliano",
  "IPA_code": "P_TN",
  "password": "4CKSILO7FQPZ",
  "cart_password": "",
  "submit": true,
  "id": "60e35f02-1509-408c-b101-3b1a28109329",
  "application_code": "",
  "active": true
}

Per modificare una configurazione esistente, il proxy serve l'API PUT /tenants/{tenant_id} e PATCH /tenants/{tenant_id}

Per eliminare una configurazione esistente, il proxy serve l'API DELETE /tenants/{tenant_id} . In questo caso l'eliminazione è una soft-delete, ovvero la configurazione viene semplicemente disattivata settando il parametro active a false ed eliminando la configurazione dalla memoria ma non dallo storage.

Configurazione servizio

L'admin, dall'interfaccia di configurazione dei pagamenti per un servizio compila la configurazione mediante una form, il cui json schema è servito dall'API /services/schema

Lo schema della form soprariportata è il seguente

{
    "display": "form",
    "components": [
        {
            "label": "UUID del Servizio",
            "placeholder": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "spellcheck": false,
            "attributes": {
                "readonly": "readonly"
            },
            "hidden": true,
            "tableView": false,
            "validate": {
                "required": true
            },
            "key": "id",
            "type": "textfield",
            "input": true
        },
        {
            "label": "UUID del Tenant",
            "placeholder": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "spellcheck": false,
            "attributes": {
                "readonly": "readonly"
            },
            "hidden": true,
            "tableView": false,
            "validate": {
                "required": true
            },
            "key": "tenant_id",
            "type": "textfield",
            "input": true
        },
        {
            "label": "Scegli il tipo di pagamento",
            "widget": "choicesjs",
            "tableView": true,
            "data": {
                "values": [
                    {
                        "label": "PagoPA",
                        "value": "pagopa"
                    },
                    {
                        "label": "Marca da Bollo Digitale",
                        "value": "stamp"
                    },
                    {
                        "label": "PagoPA + Marca da Bollo Digitale",
                        "value": "pagopa_and_stamp"
                    }
                ]
            },
            "validate": {
                "required": true
            },
            "key": "payment_type",
            "type": "select",
            "input": true,
            "defaultValue": "pagopa"
        },
        {
            "label": "Tipo dovuto",
            "placeholder": "TD_CIE",
            "description": "Riferimento alla tipologia del dovuto secondo la classificazione data dal beneficiario.",
            "applyMaskOn": "change",
            "spellcheck": false,
            "tableView": true,
            "validate": {
                "required": true,
                "maxLength": 64
            },
            "key": "management_id",
            "customConditional": "show = data.payment_type == 'pagopa' || data.payment_type == 'pagopa_and_stamp'",
            "type": "textfield",
            "input": true
        },
        {
            "label": "Dati specifici riscossione",
            "placeholder": "9/3300.1",
            "description": "Rappresenta l’indicazione dell’imputazione della specifica entrata ed è così articolato:<br><b>TIPO_CONTABILITA / CODICE_CONTABILITA</b>, dove TIPO_CONTABILITA ha il seguente significato:<ul><li>0 (Capitolo e articolo di Entrata del Bilancio dello Stato)</li><li>1 (Numero della contabilità speciale)</li><li>2 (Codice SIOPE)</li><li>9 (Altro codice ad uso dell’amministrazione)</li></ul>",
            "applyMaskOn": "change",
            "spellcheck": false,
            "tableView": false,
            "defaultValue": "9/3300.1",
            "validate": {
                "required": true,
                "maxLength": 140
            },
            "key": "collection_data",
            "customConditional": "show = data.payment_type == 'pagopa' || data.payment_type == 'pagopa_and_stamp'",
            "type": "textfield",
            "input": true
        },
        {
            "label": "Abilitato",
            "key": "active",
            "type": "checkbox",
            "input": true,
            "hidden": true,
            "defaultValue": true,
            "tableView": false
        },
        {
            "label": "Bilancio",
            "tableView": false,
            "defaultValue": true,
            "key": "split_enable",
            "customConditional": "show = data.payment_type == 'pagopa' || data.payment_type == 'pagopa_and_stamp'",
            "type": "checkbox",
            "input": true
        },
        {
            "label": "Bilancio",
            "reorder": false,
            "addAnotherPosition": "bottom",
            "layoutFixed": false,
            "enableRowGroups": false,
            "initEmpty": true,
            "tableView": false,
            "defaultValue": [
                {
                    "split_id": "",
                    "split_budget_chapter": "",
                    "split_office_code": "",
                    "split_assessment": "",
                    "split_amount": ""
                }
            ],
            "key": "split",
            "conditional": {
                "show": true,
                "when": "split_enable",
                "eq": "true"
            },
            "customConditional": "show = (data.payment_type == 'pagopa' || data.payment_type == 'pagopa_and_stamp') && data.split_enable",
            "type": "datagrid",
            "input": true,
            "components": [
                {
                    "label": "ID",
                    "description": "Identificativo univoco della voce di bilancio. Testo libero",
                    "placeholder": "c_1",
                    "tableView": true,
                    "validate": {
                        "required": true
                    },
                    "key": "split_id",
                    "type": "textfield",
                    "input": true
                },
                {
                    "label": "Capitolo",
                    "placeholder": "Capitolo di bilancio c1",
                    "validate": {
                        "required": true
                    },
                    "tableView": true,
                    "key": "split_budget_chapter",
                    "type": "textfield",
                    "input": true
                },
                {
                    "label": "Ufficio",
                    "placeholder": "Codice ufficio bilancio c1",
                    "tableView": true,
                    "key": "split_office_code",
                    "type": "textfield",
                    "input": true
                },
                {
                    "label": "Accertamento",
                    "placeholder": "Accertamento c1",
                    "tableView": true,
                    "key": "split_assessment",
                    "type": "textfield",
                    "input": true
                },
                {
                    "label": "Importo",
                    "description": "Importo della voce di bilancio. NB: La somma degli importi delle voci DEVE equivalere all'importo totale",
                    "placeholder": "16.00",
                    "validate": {
                        "required": true
                    },
                    "mask": false,
                    "tableView": false,
                    "delimiter": false,
                    "requireDecimal": false,
                    "inputFormat": "plain",
                    "truncateMultipleSpaces": false,
                    "key": "split_amount",
                    "type": "number",
                    "input": true
                }
            ]
        },
        {
            "label": "hidden",
            "calculateValue": "if (!data.split || data.split == 'undefined') {\n  data.split = []\n} else if (typeof data.split==='object' && Object.keys(data.split).length === 0) {\n  data.split = [];\n}\n\nif (!data.stamps || data.stamps == 'undefined') {\n  data.stamps = []\n} else if (typeof data.stamps==='object' && Object.keys(data.stamps).length === 0) {\n  data.stamps = [];\n}\n\nfor (i = 0; i < data.stamps.length; i++) {\n  if (data.stamps[i].id) {\n    data.stamps[i].amount = submission.metadata.selectData.stamps[i].id.label\n  } else {\n    data.stamps[i].amount = \"\"\n  }\n} ",
            "key": "hidden",
            "type": "hidden",
            "input": true,
            "tableView": false
        },
        {
            "label": "Informazioni Pagamento MBD",
            "attrs": [
                {
                    "attr": "",
                    "value": ""
                }
            ],
            "content": "<b>NOTA BENE:</b> Nel caso in cui si venga configurato <b>solamente</b> il pagamento la marca da bollo digitale, il valore dell'importo e/o del campo payment_amount nel modulo saranno ignorati",
            "refreshOnChange": false,
            "key": "stamp_info",
            "conditional": {
                "show": true,
                "when": "payment_type",
                "eq": "stamp"
            },
            "type": "htmlelement",
            "input": false,
            "tableView": false
        },
        {
            "label": "Marca da Bollo Digitale",
            "reorder": false,
            "addAnotherPosition": "bottom",
            "layoutFixed": false,
            "enableRowGroups": false,
            "initEmpty": true,
            "tableView": false,
            "defaultValue": [
                {
                    "id": "01",
                    "amount": "16.00",
                    "collection_data": "9/3300.1"
                }
            ],
            "validate": {
                "maxLength": "5",
                "custom": "valid = !(data.stamps.length > 4 && data.payment_type == 'pagopa_and_stamp') ? true : 'Puoi inserire un massimo di 4 marche da bollo'"
            },
            "key": "stamps",
            "customConditional": "show = data.payment_type == 'stamp' || data.payment_type == 'pagopa_and_stamp'",
            "type": "datagrid",
            "input": true,
            "components": [
                {
                    "label": "Taglio",
                    "widget": "choicesjs",
                    "tableView": true,
                    "data": {
                        "values": [
                            {
                                "label": "16.00",
                                "value": "01"
                            }
                        ]
                    },
                    "template": "<span>{{ item.label }}</span> €",
                    "validate": {
                        "required": true
                    },
                    "key": "id",
                    "type": "select",
                    "input": true
                },
                {
                    "label": "Dati specifici riscossione",
                    "placeholder": "9/3300.1",
                    "description": "Rappresenta l’indicazione dell’imputazione della specifica entrata ed è così articolato:<br><b>TIPO_CONTABILITA / CODICE_CONTABILITA</b>, dove TIPO_CONTABILITA ha il seguente significato:<ul><li>0 (Capitolo e articolo di Entrata del Bilancio dello Stato)</li><li>1 (Numero della contabilità speciale)</li><li>2 (Codice SIOPE)</li><li>9 (Altro codice ad uso dell’amministrazione)</li></ul>",
                    "applyMaskOn": "change",
                    "spellcheck": false,
                    "tableView": false,
                    "defaultValue": "9/3300.1",
                    "validate": {
                        "required": true,
                        "maxLength": 140
                    },
                    "key": "collection_data",
                    "type": "textfield",
                    "input": true
                }
            ]
        },
        {
            "label": "Salva",
            "showValidations": false,
            "tableView": false,
            "key": "submit",
            "type": "button",
            "input": true
        }
    ]
}

Premendo poi il bottone Salva, viene eseguita una POST /services servita dal proxy, con payload

{
  "payment_type": "pagopa_and_stamp",
  "management_id": "COSAP_TOSAP",
  "collection_data": "9/0301109AP/",
  "split_enable": true,
  "split": [
    {
      "split_id": "c_1",
      "split_budget_chapter": "Cap1",
      "split_office_code": "Uff1",
      "split_assessment": "Acc1",
      "split_amount": 1
    }
  ],
  "hidden": "",
  "submit": true,
  "id": "e64a3bd1-0096-4b8e-8676-e53f7d6b4b9a",
  "tenant_id": "60e35f02-1509-408c-b101-3b1a28109329",
  "active": true,
  "stamps": [
    {
      "id": "01",
      "amount": "16.00",
      "collection_data": "9/3300.1"
    }
  ]
}

Per modificare una configurazione esistente, il proxy serve l'API PUT /services/{service_id} e PATCH /services/{service_id}

Per eliminare una configurazione esistente, il proxy serve l'API DELETE /services/{service_id} . In questo caso l'eliminazione è una soft-delete, ovvero la configurazione viene semplicemente disattivata settando il parametro active a false.

Alberatura configurazioni sullo storage

Le configurazioni di tenant e servizi vengono salvate con la seguente alberatura

{
    "display": "form",
    "components": [
        {
            "label": "UUID del Tenant",
            "placeholder": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "spellcheck": false,
            "attributes": {
                "readonly": "readonly"
            },
            "hidden": true,
            "tableView": false,
            "validate": {
                "required": true
            },
            "key": "id",
            "type": "textfield",
            "input": true
        },
        {
            "label": "Nome dell'ente",
            "placeholder": "Comune di Bugliano",
            "tableView": true,
            "validate": {
                "required": true
            },
            "key": "name",
            "type": "textfield",
            "input": true
        },
        {
            "label": "Codice IPA dell'ente",
            "placeholder": "A000",
            "description": "Codice (tutto maiuscolo) assegnato all'Ente nel registro <a href='http://www.indicepa.gov.it' target='__blank'>indice PA</a>",
            "spellcheck": false,
            "tableView": true,
            "validate": {
                "required": true
            },
            "key": "IPA_code",
            "type": "textfield",
            "input": true
        },
        {
            "label": "Password",
            "placeholder": "************",
            "description": "Password assegnata da MyPay all’Ente",
            "spellcheck": false,
            "tableView": false,
            "validate": {
                "required": true
            },
            "key": "password",
            "type": "textfield",
            "input": true
        },
        {
            "label": "Password carrello dovuti",
            "placeholder": "************",
            "description": "Password assegnata all’ente creditore. Tale password va richiesta all’amministratore dell’ente creditore.<br>ATTENZIONE: questo dato NON coincide con la password (principale) dell’ente.",
            "spellcheck": false,
            "tableView": true,
            "key": "cart_password",
            "type": "textfield",
            "input": true
        },
        {
            "label": "Codice applicazione",
            "spellcheck": false,
            "tableView": true,
            "key": "application_code",
            "type": "textfield",
            "input": true,
            "hidden": true,
            "defaultValue": "SDC"
        },
        {
            "label": "Abilitato",
            "key": "active",
            "type": "checkbox",
            "input": true,
            "hidden": true,
            "defaultValue": true
        },
        {
            "label": "Salva",
            "showValidations": false,
            "tableView": false,
            "key": "submit",
            "type": "button",
            "input": true
        }
    ]
}

{
  "name": "Comune di Bugliano",
  "IPA_code": "P_TN",
  "password": "4CKSILO7FQPZ",
  "cart_password": "",
  "submit": true,
  "id": "60e35f02-1509-408c-b101-3b1a28109329",
  "application_code": "",
  "active": true
}

{
    "display": "form",
    "components": [
        {
            "label": "UUID del Servizio",
            "placeholder": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "spellcheck": false,
            "attributes": {
                "readonly": "readonly"
            },
            "hidden": true,
            "tableView": false,
            "validate": {
                "required": true
            },
            "key": "id",
            "type": "textfield",
            "input": true
        },
        {
            "label": "UUID del Tenant",
            "placeholder": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "spellcheck": false,
            "attributes": {
                "readonly": "readonly"
            },
            "hidden": true,
            "tableView": false,
            "validate": {
                "required": true
            },
            "key": "tenant_id",
            "type": "textfield",
            "input": true
        },
        {
            "label": "Scegli il tipo di pagamento",
            "widget": "choicesjs",
            "tableView": true,
            "data": {
                "values": [
                    {
                        "label": "PagoPA",
                        "value": "pagopa"
                    },
                    {
                        "label": "Marca da Bollo Digitale",
                        "value": "stamp"
                    },
                    {
                        "label": "PagoPA + Marca da Bollo Digitale",
                        "value": "pagopa_and_stamp"
                    }
                ]
            },
            "validate": {
                "required": true
            },
            "key": "payment_type",
            "type": "select",
            "input": true,
            "defaultValue": "pagopa"
        },
        {
            "label": "Tipo dovuto",
            "placeholder": "TD_CIE",
            "description": "Riferimento alla tipologia del dovuto secondo la classificazione data dal beneficiario.",
            "applyMaskOn": "change",
            "spellcheck": false,
            "tableView": true,
            "validate": {
                "required": true,
                "maxLength": 64
            },
            "key": "management_id",
            "customConditional": "show = data.payment_type == 'pagopa' || data.payment_type == 'pagopa_and_stamp'",
            "type": "textfield",
            "input": true
        },
        {
            "label": "Dati specifici riscossione",
            "placeholder": "9/3300.1",
            "description": "Rappresenta l’indicazione dell’imputazione della specifica entrata ed è così articolato:<br><b>TIPO_CONTABILITA / CODICE_CONTABILITA</b>, dove TIPO_CONTABILITA ha il seguente significato:<ul><li>0 (Capitolo e articolo di Entrata del Bilancio dello Stato)</li><li>1 (Numero della contabilità speciale)</li><li>2 (Codice SIOPE)</li><li>9 (Altro codice ad uso dell’amministrazione)</li></ul>",
            "applyMaskOn": "change",
            "spellcheck": false,
            "tableView": false,
            "defaultValue": "9/3300.1",
            "validate": {
                "required": true,
                "maxLength": 140
            },
            "key": "collection_data",
            "customConditional": "show = data.payment_type == 'pagopa' || data.payment_type == 'pagopa_and_stamp'",
            "type": "textfield",
            "input": true
        },
        {
            "label": "Abilitato",
            "key": "active",
            "type": "checkbox",
            "input": true,
            "hidden": true,
            "defaultValue": true,
            "tableView": false
        },
        {
            "label": "Bilancio",
            "tableView": false,
            "defaultValue": true,
            "key": "split_enable",
            "customConditional": "show = data.payment_type == 'pagopa' || data.payment_type == 'pagopa_and_stamp'",
            "type": "checkbox",
            "input": true
        },
        {
            "label": "Bilancio",
            "reorder": false,
            "addAnotherPosition": "bottom",
            "layoutFixed": false,
            "enableRowGroups": false,
            "initEmpty": true,
            "tableView": false,
            "defaultValue": [
                {
                    "split_id": "",
                    "split_budget_chapter": "",
                    "split_office_code": "",
                    "split_assessment": "",
                    "split_amount": ""
                }
            ],
            "key": "split",
            "conditional": {
                "show": true,
                "when": "split_enable",
                "eq": "true"
            },
            "customConditional": "show = (data.payment_type == 'pagopa' || data.payment_type == 'pagopa_and_stamp') && data.split_enable",
            "type": "datagrid",
            "input": true,
            "components": [
                {
                    "label": "ID",
                    "description": "Identificativo univoco della voce di bilancio. Testo libero",
                    "placeholder": "c_1",
                    "tableView": true,
                    "validate": {
                        "required": true
                    },
                    "key": "split_id",
                    "type": "textfield",
                    "input": true
                },
                {
                    "label": "Capitolo",
                    "placeholder": "Capitolo di bilancio c1",
                    "validate": {
                        "required": true
                    },
                    "tableView": true,
                    "key": "split_budget_chapter",
                    "type": "textfield",
                    "input": true
                },
                {
                    "label": "Ufficio",
                    "placeholder": "Codice ufficio bilancio c1",
                    "tableView": true,
                    "key": "split_office_code",
                    "type": "textfield",
                    "input": true
                },
                {
                    "label": "Accertamento",
                    "placeholder": "Accertamento c1",
                    "tableView": true,
                    "key": "split_assessment",
                    "type": "textfield",
                    "input": true
                },
                {
                    "label": "Importo",
                    "description": "Importo della voce di bilancio. NB: La somma degli importi delle voci DEVE equivalere all'importo totale",
                    "placeholder": "16.00",
                    "validate": {
                        "required": true
                    },
                    "mask": false,
                    "tableView": false,
                    "delimiter": false,
                    "requireDecimal": false,
                    "inputFormat": "plain",
                    "truncateMultipleSpaces": false,
                    "key": "split_amount",
                    "type": "number",
                    "input": true
                }
            ]
        },
        {
            "label": "hidden",
            "calculateValue": "if (!data.split || data.split == 'undefined') {\n  data.split = []\n} else if (typeof data.split==='object' && Object.keys(data.split).length === 0) {\n  data.split = [];\n}\n\nif (!data.stamps || data.stamps == 'undefined') {\n  data.stamps = []\n} else if (typeof data.stamps==='object' && Object.keys(data.stamps).length === 0) {\n  data.stamps = [];\n}\n\nfor (i = 0; i < data.stamps.length; i++) {\n  if (data.stamps[i].id) {\n    data.stamps[i].amount = submission.metadata.selectData.stamps[i].id.label\n  } else {\n    data.stamps[i].amount = \"\"\n  }\n} ",
            "key": "hidden",
            "type": "hidden",
            "input": true,
            "tableView": false
        },
        {
            "label": "Informazioni Pagamento MBD",
            "attrs": [
                {
                    "attr": "",
                    "value": ""
                }
            ],
            "content": "<b>NOTA BENE:</b> Nel caso in cui si venga configurato <b>solamente</b> il pagamento la marca da bollo digitale, il valore dell'importo e/o del campo payment_amount nel modulo saranno ignorati",
            "refreshOnChange": false,
            "key": "stamp_info",
            "conditional": {
                "show": true,
                "when": "payment_type",
                "eq": "stamp"
            },
            "type": "htmlelement",
            "input": false,
            "tableView": false
        },
        {
            "label": "Marca da Bollo Digitale",
            "reorder": false,
            "addAnotherPosition": "bottom",
            "layoutFixed": false,
            "enableRowGroups": false,
            "initEmpty": true,
            "tableView": false,
            "defaultValue": [
                {
                    "id": "01",
                    "amount": "16.00",
                    "collection_data": "9/3300.1"
                }
            ],
            "validate": {
                "maxLength": "5",
                "custom": "valid = !(data.stamps.length > 4 && data.payment_type == 'pagopa_and_stamp') ? true : 'Puoi inserire un massimo di 4 marche da bollo'"
            },
            "key": "stamps",
            "customConditional": "show = data.payment_type == 'stamp' || data.payment_type == 'pagopa_and_stamp'",
            "type": "datagrid",
            "input": true,
            "components": [
                {
                    "label": "Taglio",
                    "widget": "choicesjs",
                    "tableView": true,
                    "data": {
                        "values": [
                            {
                                "label": "16.00",
                                "value": "01"
                            }
                        ]
                    },
                    "template": "<span>{{ item.label }}</span> €",
                    "validate": {
                        "required": true
                    },
                    "key": "id",
                    "type": "select",
                    "input": true
                },
                {
                    "label": "Dati specifici riscossione",
                    "placeholder": "9/3300.1",
                    "description": "Rappresenta l’indicazione dell’imputazione della specifica entrata ed è così articolato:<br><b>TIPO_CONTABILITA / CODICE_CONTABILITA</b>, dove TIPO_CONTABILITA ha il seguente significato:<ul><li>0 (Capitolo e articolo di Entrata del Bilancio dello Stato)</li><li>1 (Numero della contabilità speciale)</li><li>2 (Codice SIOPE)</li><li>9 (Altro codice ad uso dell’amministrazione)</li></ul>",
                    "applyMaskOn": "change",
                    "spellcheck": false,
                    "tableView": false,
                    "defaultValue": "9/3300.1",
                    "validate": {
                        "required": true,
                        "maxLength": 140
                    },
                    "key": "collection_data",
                    "type": "textfield",
                    "input": true
                }
            ]
        },
        {
            "label": "Salva",
            "showValidations": false,
            "tableView": false,
            "key": "submit",
            "type": "button",
            "input": true
        }
    ]
}

{
  "payment_type": "pagopa_and_stamp",
  "management_id": "COSAP_TOSAP",
  "collection_data": "9/0301109AP/",
  "split_enable": true,
  "split": [
    {
      "split_id": "c_1",
      "split_budget_chapter": "Cap1",
      "split_office_code": "Uff1",
      "split_assessment": "Acc1",
      "split_amount": 1
    }
  ],
  "hidden": "",
  "submit": true,
  "id": "e64a3bd1-0096-4b8e-8676-e53f7d6b4b9a",
  "tenant_id": "60e35f02-1509-408c-b101-3b1a28109329",
  "active": true,
  "stamps": [
    {
      "id": "01",
      "amount": "16.00",
      "collection_data": "9/3300.1"
    }
  ]
}

Configurazione dei pagamenti

Panoramica

La configurazione dei pagamenti avviene interrogando delle API apposite fornite dal proxy di riferimento. Quest'ultimo fornisce inoltre un form come json schema sviluppato con form.io mediante il quale l'utente inserisce tali configurazioni.

Per creare un form utilizzare il seguente builder: https://formio.github.io/formio.js/app/builder

API v2

Aggiornamenti principali rispetto all'API v1

Introduzione di campi "standard"

Con la versione 2 delle API di configurazione sono stati introdotti dei campi da introdurre obbligatoriamente in ogni integrazione.

Tenant

I campi da introdurre obbligatoriamente a livello di configurazione del tenant sono:

id: identificativo univoco del tenant
name: nome del tenant
tax_identification_number: codice fiscale dell'ente

Campo

Tipo

Obbligatorio

Validazione

Configurazione pagamento

I campi da introdurre obbligatoriamente a livello di configurazione del pagamento sono:

payment_type: tipo di pagamento, può assumere i valori pagopa o stamp, serve a distinguere tra un pagamento ordinario (es. TARI) e una marca da bollo digitale. Questa distinzione è necessaria in quanto in alcuni intermediare i metodi di creazione di un pagamento di una marca da bollo digitale differiscono da quelli di creazione di un pagamento ordinario.
remote_collection.id: identificativo della collezione di provenienza della configurazione di pagamento.
remote_collection.type: tipo di collezione di provenienza della configurazione di pagamento, può assumere valori quali application, service o altro.
amount: importo del pagamento configurato.
reason: causale del pagamento configurato
expire_at: data di scadenza del pagamento
receiver.tax_identification_number: codice fiscale del beneficiario del pagamento, da usare in caso di pagamenti multibeneficiario
receiver.name: nome del beneficiario del pagamento, da usare in caso di pagamenti multibeneficiario
collection_data: tassonomia di pagoPA dei pagamenti

Campo

Tipo

Obbligatorio

Validazione

Configurazione tenant

L'admin, dall'interfaccia di configurazione dei pagamenti della Stanza del Cittadino compila la configurazione mediante una form, il cui json schema è servito dall'API /tenants/schema

Lo schema della form sopra riportata è il seguente

{
    "display": "form",
    "components": [
        {
            "label": "UUID del Tenant",
            "placeholder": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "spellcheck": false,
            "attributes": {
                "readonly": "readonly"
            },
            "hidden": true,
            "tableView": false,
            "validate": {
                "required": true
            },
            "key": "id",
            "type": "textfield",
            "input": true
        },
        {
            "label": "Nome dell'ente",
            "placeholder": "Comune di Bugliano",
            "tableView": true,
            "validate": {
                "required": true
            },
            "key": "name",
            "type": "textfield",
            "input": true
        },
        {
            "label": "Codice IPA dell'ente",
            "placeholder": "A000",
            "description": "Codice (tutto maiuscolo) assegnato all'Ente nel registro <a href='http://www.indicepa.gov.it' target='__blank'>indice PA</a>",
            "spellcheck": false,
            "tableView": true,
            "validate": {
                "required": true
            },
            "key": "IPA_code",
            "type": "textfield",
            "input": true
        },
        {
            "label": "Codice fiscale dell'ente",
            "placeholder": "123456789",
            "spellcheck": false,
            "key": "tax_identification_number",
            "type": "textfield",
            "validate": {
                "required": true
            },
            "input": true,
            "tableView": true
        },
        {
            "label": "Password",
            "placeholder": "************",
            "description": "Password assegnata da MyPay all\u2019Ente",
            "spellcheck": false,
            "tableView": false,
            "validate": {
                "required": true
            },
            "key": "password",
            "type": "textfield",
            "input": true
        },
        {
            "label": "Password carrello dovuti",
            "placeholder": "************",
            "description": "Password assegnata all\u2019ente creditore. Tale password va richiesta all\u2019amministratore dell\u2019ente creditore.<br>ATTENZIONE: questo dato NON coincide con la password (principale) dell\u2019ente.",
            "spellcheck": false,
            "tableView": true,
            "key": "cart_password",
            "type": "textfield",
            "input": true
        },
        {
            "label": "Codice applicazione",
            "spellcheck": false,
            "tableView": true,
            "key": "application_code",
            "type": "textfield",
            "input": true,
            "hidden": true,
            "defaultValue": "SDC"
        },
        {
            "label": "Abilitato",
            "key": "active",
            "type": "checkbox",
            "input": true,
            "hidden": true,
            "defaultValue": true
        },
        {
            "label": "Salva",
            "showValidations": false,
            "tableView": false,
            "key": "submit",
            "type": "button",
            "input": true
        }
    ]
}

Premendo poi il bottone Salva, viene eseguita una POST /tenants servita dal proxy, con payload

{
    "name": "Comune di Bugliano",
    "IPA_code": "p_tn",
    "tax_identification_number": "00337460224",
    "password": "4CKSILO7FQPZ",
    "cart_password": "",
    "application_code": "",
    "active": true,
    "enable_checkout": false,
    "id": "60e35f02-1509-408c-b101-3b1a28109329"
}

Per modificare una configurazione esistente, il proxy serve l'API PUT /tenants/{tenant_id} e PATCH /tenants/{tenant_id}

Configurazione pagamento

L'admin, dall'interfaccia di configurazione dei pagamenti per un servizio compila la configurazione mediante una form, il cui json schema è servito dall'API /configs/schema

Lo schema della form soprariportata è il seguente

{
    "display": "form",
    "components": [
        {
            "label": "UUID del Tenant",
            "hidden": true,
            "placeholder": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "spellcheck": false,
            "attributes": {
                "readonly": "readonly"
            },
            "validate": {
                "required": true
            },
            "key": "tenant_id",
            "type": "textfield",
            "input": true,
            "tableView": true
        },
        {
            "label": "Container",
            "tableView": false,
            "validateWhenHidden": false,
            "key": "remote_collection",
            "type": "container",
            "input": true,
            "components": [
                {
                    "label": "UUID del Servizio",
                    "placeholder": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                    "applyMaskOn": "change",
                    "hidden": true,
                    "spellcheck": false,
                    "tableView": true,
                    "validate": {
                        "required": true
                    },
                    "validateWhenHidden": false,
                    "key": "id",
                    "attributes": {
                        "readonly": "readonly"
                    },
                    "type": "textfield",
                    "input": true
                }
            ]
        },
        {
            "label": "Tipo di pagamento",
            "widget": "choicesjs",
            "tableView": true,
            "defaultValue": "pagopa",
            "data": {
                "values": [
                    {
                        "label": "PagoPA",
                        "value": "pagopa"
                    },
                    {
                        "label": "Marca da Bollo Digitale",
                        "value": "stamp"
                    }
                ]
            },
            "validate": {
                "required": true
            },
            "key": "payment_type",
            "type": "select",
            "input": true
        },
        {
            "label": "Codice Tributo",
            "placeholder": "AAAAA_AAAAA_AAAAA",
            "description": "Questo codice è fornito dall'ente e comunicato a IRIS (inserire in maiuscolo)",
            "applyMaskOn": "change",
            "tableView": true,
            "validate": {
                "required": true
            },
            "key": "code",
            "conditional": {
                "show": true,
                "when": "payment_type",
                "eq": "pagopa"
            },
            "type": "textfield",
            "input": true
        },
        {
            "label": "Descrizione del servizio",
            "placeholder": "Contributo Pratiche Polizia Municipale",
            "applyMaskOn": "change",
            "tableView": true,
            "validate": {
                "required": true
            },
            "key": "description",
            "conditional": {
                "show": true,
                "when": "payment_type",
                "eq": "pagopa"
            },
            "type": "textfield",
            "input": true
        },
        {
            "label": "Importo",
            "applyMaskOn": "change",
            "mask": false,
            "tableView": false,
            "delimiter": false,
            "requireDecimal": false,
            "inputFormat": "plain",
            "truncateMultipleSpaces": false,
            "validate": {
                "required": true,
                "custom": "valid = (data.payment_type == 'stamp' && data.amount == 16) || (data.payment_type == 'pagopa') ? true : 'In caso di marca da bollo digitale l\\'unico importo permesso è di 16 euro'"
            },
            "validateWhenHidden": false,
            "key": "amount",
            "type": "number",
            "input": true
        },
        {
            "label": "Causale",
            "applyMaskOn": "change",
            "tableView": true,
            "validate": {
                "required": true,
                "maxLength": 60
            },
            "key": "reason",
            "type": "textfield",
            "input": true
        },
        {
            "label": "Scadenza",
            "inputMask": "99/99/9999",
            "applyMaskOn": "change",
            "tableView": true,
            "validate": {
                "required": true
            },
            "key": "expire_at_label",
            "type": "textfield",
            "input": true
        },
        {
            "label": "Scadenza",
            "applyMaskOn": "change",
            "hidden": true,
            "tableView": true,
            "validate": {
                "required": true
            },
            "key": "expire_at",
            "type": "textfield",
            "input": true
        },
        {
            "label": "Categoria",
            "widget": "choicesjs",
            "description": "Selezione dalla Tassonomia di PagoPA dei pagamenti.",
            "tableView": true,
            "dataSrc": "url",
            "data": {
                "url": "https://api.opencityitalia.it/datasets/pagopa",
                "headers": [
                    {
                        "key": "",
                        "value": ""
                    }
                ]
            },
            "dataType": "object",
            "idPath": "",
            "valueProperty": "DATI SPECIFICI DI INCASSO",
            "template": "<span>{{ item[\"NOME MACRO AREA\"] }}: {{ item[\"TIPO SERVIZIO\"] }}</span>",
            "customDefaultValue": "await new Promise(r => setTimeout(r, 1000));",
            "validate": {
                "required": true
            },
            "key": "collection_data",
            "type": "select",
            "disableLimit": false,
            "noRefreshOnScroll": false,
            "input": true
        },
        {
            "label": "Abilitato",
            "hidden": true,
            "defaultValue": true,
            "key": "active",
            "type": "checkbox",
            "input": true,
            "tableView": false
        },
        {
            "label": "Bilancio",
            "tableView": false,
            "defaultValue": true,
            "key": "split_enable",
            "conditional": {
                "show": true,
                "when": "payment_type",
                "eq": "pagopa"
            },
            "type": "checkbox",
            "input": true
        },
        {
            "label": "Bilancio",
            "reorder": false,
            "addAnotherPosition": "bottom",
            "layoutFixed": false,
            "enableRowGroups": false,
            "initEmpty": true,
            "tableView": false,
            "defaultValue": [
                {
                    "split_id": "",
                    "split_type": "",
                    "split_code": "",
                    "split_description": "",
                    "split_budget_chapter": "",
                    "split_assessment": ""
                }
            ],
            "key": "split",
            "customConditional": "show = data.split_enable && data.payment_type == 'pagopa'",
            "type": "datagrid",
            "input": true,
            "components": [
                {
                    "label": "ID",
                    "description": "Identificativo univoco della voce di bilancio. Testo libero",
                    "placeholder": "c_1",
                    "tableView": true,
                    "validate": {
                        "required": true
                    },
                    "key": "split_id",
                    "type": "textfield",
                    "input": true
                },
                {
                    "label": "Tipo",
                    "placeholder": "Tipo c1",
                    "tableView": true,
                    "key": "split_type",
                    "type": "textfield",
                    "input": true
                },
                {
                    "label": "Codice",
                    "placeholder": "Codice c1",
                    "tableView": true,
                    "key": "split_code",
                    "type": "textfield",
                    "input": true
                },
                {
                    "label": "Descrizione",
                    "placeholder": "Descrizione c1",
                    "tableView": true,
                    "key": "split_description",
                    "type": "textfield",
                    "input": true
                },
                {
                    "label": "Importo",
                    "description": "Importo della voce di bilancio. NB: La somma degli importi delle voci DEVE equivalere all'importo totale",
                    "placeholder": "16.00",
                    "validate": {
                        "required": true
                    },
                    "mask": false,
                    "tableView": false,
                    "delimiter": false,
                    "requireDecimal": false,
                    "inputFormat": "plain",
                    "truncateMultipleSpaces": false,
                    "key": "split_amount",
                    "type": "number",
                    "input": true
                },
                {
                    "label": "Capitolo",
                    "placeholder": "Capitolo di bilancio c1",
                    "tableView": true,
                    "key": "split_budget_chapter",
                    "type": "textfield",
                    "input": true
                },
                {
                    "label": "Accertamento",
                    "placeholder": "Accertamento c1",
                    "tableView": true,
                    "key": "split_assessment",
                    "type": "textfield",
                    "input": true
                }
            ]
        },
        {
            "label": "hidden",
            "calculateValue": "if (!data.split || data.split == 'undefined') {\n  data.split = []\n} else if (typeof data.split==='object' && Object.keys(data.split).length === 0) {\n  data.split = [];\n}\n\nlet passedDate = moment(data.expire_at_label, 'DD/MM/YYYY');\nif (!passedDate.isValid()){\n  valid = \"La data inserita non è valida\";\n}\nif (passedDate.isAfter(moment())){\n  valid = \"La data inserita non può essere successiva alla data odierna\";\n}\n\nif (passedDate.isValid()){\n  data.expire_at = new Date(data.expire_at_label).toISOString();\n}",
            "key": "hidden",
            "type": "hidden",
            "input": true,
            "tableView": false
        },
        {
            "label": "Codice ufficio",
            "placeholder": "FSE",
            "description": "Il “codice ufficio” permette di distinguere l’ufficio di regione Toscana competente.",
            "applyMaskOn": "change",
            "tableView": true,
            "validate": {
                "required": true
            },
            "key": "office_code",
            "conditional": {
                "show": true,
                "when": "payment_type",
                "eq": "stamp"
            },
            "type": "textfield",
            "input": true
        },
        {
            "label": "Descrizione ufficio",
            "placeholder": "Fondo Sociale Europeo",
            "description": "Valorizzare con il nome dell’ufficio competente",
            "applyMaskOn": "change",
            "tableView": true,
            "validate": {
                "required": true
            },
            "key": "office_description",
            "conditional": {
                "show": true,
                "when": "payment_type",
                "eq": "stamp"
            },
            "type": "textfield",
            "input": true
        },
        {
            "label": "Codice Riferimento Bollo",
            "placeholder": "TIROCINI",
            "description": "Il “codice riferimento bollo” permette di distinguere il bollo per lo specifico ufficio.",
            "prefix": "BOLLO_",
            "applyMaskOn": "change",
            "tableView": true,
            "validate": {
                "required": true
            },
            "key": "reference_code",
            "conditional": {
                "show": true,
                "when": "payment_type",
                "eq": "stamp"
            },
            "type": "textfield",
            "input": true
        },
        {
            "label": "Note",
            "placeholder": "Pagamento Bollo Tirocinio Avviso: Avviso contributo tirocini non curriculari on line Giovanisì - FSE dal 1 Settembre 2017 per Soggetto Ospitante: CTP SYSTEM SRL",
            "description": "Necessaria per la corretta visualizzazione di ulteriori dettagli sulla ricevuta di pagamento",
            "applyMaskOn": "change",
            "tableView": true,
            "key": "notes",
            "conditional": {
                "show": true,
                "when": "payment_type",
                "eq": "stamp"
            },
            "type": "textfield",
            "input": true
        },
        {
            "label": "Salva",
            "showValidations": false,
            "key": "submit",
            "type": "button",
            "input": true,
            "tableView": false
        }
    ]
}

Premendo poi il bottone Salva, viene eseguita una POST /configs servita dal proxy, con payload

{
  "id": "5ec5668d-fed1-42a2-b648-abe1fe19b87a",
  "tenant_id": "8fdf037e-d8c0-4314-8291-b5fecb5f613a",
  "remote_collection": {
    "id": "d058b207-aedf-4683-b961-6ae146f69773",
    "type": "service"
  },
  "payment_type": "pagopa",
  "code": "CONTR_PRTPM",
  "description": "Contributo Pratiche Polizia Municipale",
  "reason": "Richiesta permesso di occupazione suolo pubblico",
  "split": [
    {
      "split_id": "c_1",
      "split_type": "Tipo c1",
      "split_code": "Codice c1",
      "split_description": "Descrizione d1",
      "split_budget_chapter": "Cap1",
      "split_assessment": "Acc1",
      "split_amount": 16
    }
  ],
  "collection_data": "9/0101102TS/",
  "amount": 16,
  "expire_at": "2024-12-11T23:00:00.000Z"
}

Per ottenere una lista di configurazioni di pagamento (fino a un massimo di 5), il proxy serve l'API GET /configs?config_id=config_id1&config_id=config_id2

Per modificare una configurazione esistente, il proxy serve l'API PUT /configs/{config_id} e PATCH /configs/{config_id}

Per eliminare una configurazione esistente, il proxy serve l'API DELETE /configs/{config_id} . In questo caso l'eliminazione è una soft-delete, ovvero la configurazione viene semplicemente disattivata settando il parametro active a false.

Swagger di esempio

Options Tenant Schema

OPTIONShttps://api.qa.stanzadelcittadino.it/payment-proxy/iris-v3/tenants/schema

Response

Successful Response

Body

any

Request

Get Tenant Configuration

GEThttps://api.qa.stanzadelcittadino.it/payment-proxy/iris-v3/tenants/{tenant_id}

Path parameters

tenant_id*Tenant Id

Example: "b212c4b4-db26-4404-8c7c-47dab99dd2e6"

Response

Successful Response

Body

tax_identification_number*Tax Identification Number

nameName

code*Code

e2e_codeE2E Code

sil_id*Sil Id

receiver_codeReceiver Code

e2e_receiver_codeE2E Receiver Code

receiver_sil_idReceiver Sil Id

password*Password

cert*Cert

application_codeApplication Code

active*Active

stamp_codeStamp Code

stamp_passwordStamp Password

id*Id

Request

Response

Update Tenant Configuration

PUThttps://api.qa.stanzadelcittadino.it/payment-proxy/iris-v3/tenants/{tenant_id}

Path parameters

tenant_id*Tenant Id

Example: "b212c4b4-db26-4404-8c7c-47dab99dd2e6"

Body

tax_identification_number*Tax Identification Number

nameName

code*Code

e2e_codeE2E Code

sil_id*Sil Id

receiver_codeReceiver Code

e2e_receiver_codeE2E Receiver Code

receiver_sil_idReceiver Sil Id

password*Password

cert*Cert

application_codeApplication Code

active*Active

stamp_codeStamp Code

stamp_passwordStamp Password

Response

Successful Response

Body

any

Request

Response

Delete Tenant

DELETEhttps://api.qa.stanzadelcittadino.it/payment-proxy/iris-v3/tenants/{tenant_id}

Path parameters

tenant_id*Tenant Id

Example: "b212c4b4-db26-4404-8c7c-47dab99dd2e6"

Response

Successful Response

Request

Response

Options Tenant Id

OPTIONShttps://api.qa.stanzadelcittadino.it/payment-proxy/iris-v3/tenants/{tenant_id}

Response

Successful Response

Body

any

Request

Update Existing Tenant Configuration

PATCHhttps://api.qa.stanzadelcittadino.it/payment-proxy/iris-v3/tenants/{tenant_id}

Path parameters

tenant_id*Tenant Id

Example: "b212c4b4-db26-4404-8c7c-47dab99dd2e6"

Body

New Configuration

Response

Successful Response

Body

any

Request

Response

Save Tenant Configuration

POSThttps://api.qa.stanzadelcittadino.it/payment-proxy/iris-v3/tenants

Body

tax_identification_number*Tax Identification Number

nameName

code*Code

e2e_codeE2E Code

sil_id*Sil Id

receiver_codeReceiver Code

e2e_receiver_codeE2E Receiver Code

receiver_sil_idReceiver Sil Id

password*Password

cert*Cert

application_codeApplication Code

active*Active

stamp_codeStamp Code

stamp_passwordStamp Password

id*Id

Response

Successful Response

Body

any

Request

Response

Options Tenants

OPTIONShttps://api.qa.stanzadelcittadino.it/payment-proxy/iris-v3/tenants

Response

Successful Response

Body

any

Request

Get Config Form Schema

GEThttps://api.qa.stanzadelcittadino.it/payment-proxy/iris-v3/configs/schema

Response

Successful Response

Body

any

Request

Options Config Schema

OPTIONShttps://api.qa.stanzadelcittadino.it/payment-proxy/iris-v3/configs/schema

Response

Successful Response

Body

any

Request

Get Payment Configurations List

GEThttps://api.qa.stanzadelcittadino.it/payment-proxy/iris-v3/configs

Query parameters

config_idsConfig Ids

Lista id delle configurazioni di pagamento

itemsstring (uuid)

Response

Successful Response

Body

tenant_id*Tenant Id

payment_typePayment Type

codeCode

descriptionDescription

amount*Amount

reasonReason

expire_at*Expire At

collection_data*Collection Data

active*Active

splitSplit

split_id*Split Id

split_typeSplit Type

split_codeSplit Code

split_descriptionSplit Description

split_amount*Split Amount

split_budget_chapterSplit Budget Chapter

split_assessmentSplit Assessment

office_codeOffice Code

office_descriptionOffice Description

reference_codeReference Code

notesNotes

remote_collection*RemoteCollection

id*Id

typeType

id*Id

Request

Response

Save Payment Configuration

POSThttps://api.qa.stanzadelcittadino.it/payment-proxy/iris-v3/configs

Body

tenant_id*Tenant Id

payment_typePayment Type

codeCode

descriptionDescription

amount*Amount

reasonReason

expire_at*Expire At

collection_data*Collection Data

active*Active

splitSplit

split_id*Split Id

split_typeSplit Type

split_codeSplit Code

split_descriptionSplit Description

split_amount*Split Amount

split_budget_chapterSplit Budget Chapter

split_assessmentSplit Assessment

office_codeOffice Code

office_descriptionOffice Description

reference_codeReference Code

notesNotes

remote_collection*RemoteCollection

id*Id

typeType

Response

Successful Response

Body

any

Request

Response

Options Configs

OPTIONShttps://api.qa.stanzadelcittadino.it/payment-proxy/iris-v3/configs

Response

Successful Response

Body

any

Request

Get Payment Configuration

GEThttps://api.qa.stanzadelcittadino.it/payment-proxy/iris-v3/configs/{config_id}

Path parameters

config_id*Config Id

Example: "23d57b65-5eb9-4f0a-a507-fbcf3057b248"

Response

Successful Response

Body

tenant_id*Tenant Id

payment_typePayment Type

codeCode

descriptionDescription

amount*Amount

reasonReason

expire_at*Expire At

collection_data*Collection Data

active*Active

splitSplit

split_id*Split Id

split_typeSplit Type

split_codeSplit Code

split_descriptionSplit Description

split_amount*Split Amount

split_budget_chapterSplit Budget Chapter

split_assessmentSplit Assessment

office_codeOffice Code

office_descriptionOffice Description

reference_codeReference Code

notesNotes

remote_collection*RemoteCollection

id*Id

typeType

id*Id

Request

Response

Update Payment Configuration

PUThttps://api.qa.stanzadelcittadino.it/payment-proxy/iris-v3/configs/{config_id}

Path parameters

config_id*Config Id

Example: "23d57b65-5eb9-4f0a-a507-fbcf3057b248"

Body

tenant_id*Tenant Id

payment_typePayment Type

codeCode

descriptionDescription

amount*Amount

reasonReason

expire_at*Expire At

collection_data*Collection Data

active*Active

splitSplit

split_id*Split Id

split_typeSplit Type

split_codeSplit Code

split_descriptionSplit Description

split_amount*Split Amount

split_budget_chapterSplit Budget Chapter

split_assessmentSplit Assessment

office_codeOffice Code

office_descriptionOffice Description

reference_codeReference Code

notesNotes

remote_collection*RemoteCollection

id*Id

typeType

Response

Successful Response

Body

any

Request

Response

Delete Config

DELETEhttps://api.qa.stanzadelcittadino.it/payment-proxy/iris-v3/configs/{config_id}

Path parameters

config_id*Config Id

Example: "23d57b65-5eb9-4f0a-a507-fbcf3057b248"

Response

Successful Response

Request

Response

Options Config Id

OPTIONShttps://api.qa.stanzadelcittadino.it/payment-proxy/iris-v3/configs/{config_id}

Response

Successful Response

Body

any

Request

Update Existing Payment Configuration

PATCHhttps://api.qa.stanzadelcittadino.it/payment-proxy/iris-v3/configs/{config_id}

Path parameters

config_id*Config Id

Example: "23d57b65-5eb9-4f0a-a507-fbcf3057b248"

Body

New Configuration

Response

Successful Response

Body

any

Request

Response

Get Tenant Form Schema

GEThttps://api.qa.stanzadelcittadino.it/payment-proxy/iris-v3/tenants/schema

Response

Successful Response

Body

any

Request

Campo

Tipo

Obbligatorio

Validazione

Identificativo univoco

Non vuoto, massimo 255 caratteri

tax_identification_number

Codice fiscale valido

Valori: pagopa, stamp

remote_collection.id

Identificativo univoco

remote_collection.type

Response

Update Existing Tenant Configuration

PATCHhttps://api.qa.stanzadelcittadino.it/payment-proxy/iris-v3/tenants/{tenant_id}

Path parameters

tenant_id*Tenant Id

Example: "b212c4b4-db26-4404-8c7c-47dab99dd2e6"

Body

New Configuration

Response

Successful Response

Body

any

Request

Response

Delete Tenant

DELETEhttps://api.qa.stanzadelcittadino.it/payment-proxy/iris-v3/tenants/{tenant_id}

Path parameters

tenant_id*Tenant Id

Example: "b212c4b4-db26-4404-8c7c-47dab99dd2e6"

Response

Successful Response

Request

Response

Update Existing Payment Configuration

PATCHhttps://api.qa.stanzadelcittadino.it/payment-proxy/iris-v3/configs/{config_id}

Path parameters

config_id*Config Id

Example: "23d57b65-5eb9-4f0a-a507-fbcf3057b248"

Body

New Configuration

Response

Successful Response

Body

any

Request

Response

Get Tenant Configuration

GEThttps://api.qa.stanzadelcittadino.it/payment-proxy/iris-v3/tenants/{tenant_id}

Path parameters

tenant_id*Tenant Id

Example: "b212c4b4-db26-4404-8c7c-47dab99dd2e6"

Response

Successful Response

Body

tax_identification_number*Tax Identification Number

nameName

code*Code

e2e_codeE2E Code

sil_id*Sil Id

receiver_codeReceiver Code

e2e_receiver_codeE2E Receiver Code

receiver_sil_idReceiver Sil Id

password*Password

cert*Cert

application_codeApplication Code

active*Active

stamp_codeStamp Code

stamp_passwordStamp Password

id*Id

Request

Response

Update Tenant Configuration

PUThttps://api.qa.stanzadelcittadino.it/payment-proxy/iris-v3/tenants/{tenant_id}

Path parameters

tenant_id*Tenant Id

Example: "b212c4b4-db26-4404-8c7c-47dab99dd2e6"

Body

tax_identification_number*Tax Identification Number

nameName

code*Code

e2e_codeE2E Code

sil_id*Sil Id

receiver_codeReceiver Code

e2e_receiver_codeE2E Receiver Code

receiver_sil_idReceiver Sil Id

password*Password

cert*Cert

application_codeApplication Code

active*Active

stamp_codeStamp Code

stamp_passwordStamp Password

Response

Successful Response

Body

any

Request

Response

Save Tenant Configuration

POSThttps://api.qa.stanzadelcittadino.it/payment-proxy/iris-v3/tenants

Body

tax_identification_number*Tax Identification Number

nameName

code*Code

e2e_codeE2E Code

sil_id*Sil Id

receiver_codeReceiver Code

e2e_receiver_codeE2E Receiver Code

receiver_sil_idReceiver Sil Id

password*Password

cert*Cert

application_codeApplication Code

active*Active

stamp_codeStamp Code

stamp_passwordStamp Password

id*Id

Response

Successful Response

Body

any

Request

Response

Update Payment Configuration

PUThttps://api.qa.stanzadelcittadino.it/payment-proxy/iris-v3/configs/{config_id}

Path parameters

config_id*Config Id

Example: "23d57b65-5eb9-4f0a-a507-fbcf3057b248"

Body

tenant_id*Tenant Id

payment_typePayment Type

codeCode

descriptionDescription

amount*Amount

reasonReason

expire_at*Expire At

collection_data*Collection Data

active*Active

splitSplit

split_id*Split Id

split_typeSplit Type

split_codeSplit Code

split_descriptionSplit Description

split_amount*Split Amount

split_budget_chapterSplit Budget Chapter

split_assessmentSplit Assessment

office_codeOffice Code

office_descriptionOffice Description

reference_codeReference Code

notesNotes

remote_collection*RemoteCollection

id*Id

typeType

Response

Successful Response

Body

any

Request

Response

Get Payment Configurations List

GEThttps://api.qa.stanzadelcittadino.it/payment-proxy/iris-v3/configs

Query parameters

config_idsConfig Ids

Lista id delle configurazioni di pagamento

itemsstring (uuid)

Response

Successful Response

Body

tenant_id*Tenant Id

payment_typePayment Type

codeCode

descriptionDescription

amount*Amount

reasonReason

expire_at*Expire At

collection_data*Collection Data

active*Active

splitSplit

split_id*Split Id

split_typeSplit Type

split_codeSplit Code

split_descriptionSplit Description

split_amount*Split Amount

split_budget_chapterSplit Budget Chapter

split_assessmentSplit Assessment

office_codeOffice Code

office_descriptionOffice Description

reference_codeReference Code

notesNotes

remote_collection*RemoteCollection

id*Id

typeType

id*Id

Request

Response

Get Payment Configuration

GEThttps://api.qa.stanzadelcittadino.it/payment-proxy/iris-v3/configs/{config_id}

Path parameters

config_id*Config Id

Example: "23d57b65-5eb9-4f0a-a507-fbcf3057b248"

Response

Successful Response

Body

tenant_id*Tenant Id

payment_typePayment Type

codeCode

descriptionDescription

amount*Amount

reasonReason

expire_at*Expire At

collection_data*Collection Data

active*Active

splitSplit

split_id*Split Id

split_typeSplit Type

split_codeSplit Code

split_descriptionSplit Description

split_amount*Split Amount

split_budget_chapterSplit Budget Chapter

split_assessmentSplit Assessment

office_codeOffice Code

office_descriptionOffice Description

reference_codeReference Code

notesNotes

remote_collection*RemoteCollection

id*Id

typeType

id*Id

Request

Response

Save Payment Configuration

POSThttps://api.qa.stanzadelcittadino.it/payment-proxy/iris-v3/configs

Body

tenant_id*Tenant Id

payment_typePayment Type

codeCode

descriptionDescription

amount*Amount

reasonReason

expire_at*Expire At

collection_data*Collection Data

active*Active

splitSplit

split_id*Split Id

split_typeSplit Type

split_codeSplit Code

split_descriptionSplit Description

split_amount*Split Amount

split_budget_chapterSplit Budget Chapter

split_assessmentSplit Assessment

office_codeOffice Code

office_descriptionOffice Description

reference_codeReference Code

notesNotes

remote_collection*RemoteCollection

id*Id

typeType

Response

Successful Response

Body

any

Request

Response

const response = await fetch('https://api.qa.stanzadelcittadino.it/payment-proxy/iris-v3/tenants/{tenant_id}', {
    method: 'OPTIONS',
    headers: {},
});
const data = await response.json();

const response = await fetch('https://api.qa.stanzadelcittadino.it/payment-proxy/iris-v3/tenants', {
    method: 'OPTIONS',
    headers: {},
});
const data = await response.json();

const response = await fetch('https://api.qa.stanzadelcittadino.it/payment-proxy/iris-v3/configs/schema', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

const response = await fetch('https://api.qa.stanzadelcittadino.it/payment-proxy/iris-v3/configs/schema', {
    method: 'OPTIONS',
    headers: {},
});
const data = await response.json();

const response = await fetch('https://api.qa.stanzadelcittadino.it/payment-proxy/iris-v3/configs', {
    method: 'OPTIONS',
    headers: {},
});
const data = await response.json();

const response = await fetch('https://api.qa.stanzadelcittadino.it/payment-proxy/iris-v3/configs/{config_id}', {
    method: 'OPTIONS',
    headers: {},
});
const data = await response.json();

const response = await fetch('https://api.qa.stanzadelcittadino.it/payment-proxy/iris-v3/tenants/schema', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

const response = await fetch('https://api.qa.stanzadelcittadino.it/payment-proxy/iris-v3/tenants/schema', {
    method: 'OPTIONS',
    headers: {},
});
const data = await response.json();

const response = await fetch('https://api.qa.stanzadelcittadino.it/payment-proxy/iris-v3/configs/{config_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

const response = await fetch('https://api.qa.stanzadelcittadino.it/payment-proxy/iris-v3/tenants/{tenant_id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "tax_identification_number": "1234567891"
    }),
});
const data = await response.json();

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

const response = await fetch('https://api.qa.stanzadelcittadino.it/payment-proxy/iris-v3/tenants/{tenant_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

const response = await fetch('https://api.qa.stanzadelcittadino.it/payment-proxy/iris-v3/configs/{config_id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "payment_type": "pagopa",
      "code": "CONTR_PRTPM",
      "description": "<p>Abbonamento aree di sosta</p>",
      "active": true,
      "split": [
        {
          "split_id": "c_1",
          "split_type": "Tipo c1",
          "split_code": "Codice c1",
          "split_description": "Descrizione c1",
          "split_amount": 0.5,
          "split_budget_chapter": "Capitolo di bilancio c1",
          "split_assessment": "Accertamento c1"
        }
      ],
      "amount": 1,
      "reason": "test",
      "expire_at": "2024-12-12T12:00:00:00.000Z",
      "collection_data": "9/0101100IM/",
      "office_code": "FSE",
      "office_description": "Fondo Sociale Europeo",
      "reference_code": "BOLLO_TIROCINI",
      "notes": "",
      "remote_collection": {
        "id": "3e68161e-9abb-43ac-99e6-39b0ece65b40",
        "type": "service"
      },
      "__$markdownParsed": true
    }),
});
const data = await response.json();

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

const response = await fetch('https://api.qa.stanzadelcittadino.it/payment-proxy/iris-v3/tenants/{tenant_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "tax_identification_number": "01234567891",
  "name": "Comune di Bugliano",
  "code": "CBugliano",
  "e2e_code": "CBugliano",
  "receiver_code": "RTIRIS",
  "e2e_receiver_code": "RTIRIS",
  "receiver_sil_id": "SIL_IRIS_ITR",
  "sil_id": "SIL_CBUGLIANO_OPEN",
  "password": "PASSWORD",
  "cert": "-----BEGIN CERTIFICATE REQUEST-----MIIB9TCCAWACAQAwgbgxGTAXBgNVBAoMEFF1b1ZhZGlzIExpbWl0ZWQxHDAaBgNVBAsME0RvY3VtZW50IERlcGFydG1lbnQxOTA3BgNVBAMMMFdoeSBhcmUgeW91IGRl-----END CERTIFICATE REQUEST-----",
  "application_code": "",
  "active": true,
  "id": "b212c4b4-db26-4404-8c7c-47dab99dd2e6"
}

const response = await fetch('https://api.qa.stanzadelcittadino.it/payment-proxy/iris-v3/tenants/{tenant_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "tax_identification_number": "01234567891",
      "name": "Comune di Bugliano",
      "code": "CBugliano",
      "e2e_code": "CBugliano",
      "receiver_code": "RTIRIS",
      "e2e_receiver_code": "RTIRIS",
      "receiver_sil_id": "SIL_IRIS_ITR",
      "password": "PASSWORD",
      "stamp_code": "CBugliano_SIL_E_BOLLO",
      "stamp_password": "PASSWORD",
      "sil_id": "SIL_CBUGLIANO_OPEN",
      "cert": "-----BEGIN CERTIFICATE REQUEST-----MIIB9TCCAWACAQAwgbgxGTAXBgNVBAoMEFF1b1ZhZGlzIExpbWl0ZWQxHDAaBgNVBAsME0RvY3VtZW50IERlcGFydG1lbnQxOTA3BgNVBAMMMFdoeSBhcmUgeW91IGRl-----END CERTIFICATE REQUEST-----",
      "application_code": "",
      "active": true
    }),
});
const data = await response.json();

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

const response = await fetch('https://api.qa.stanzadelcittadino.it/payment-proxy/iris-v3/tenants', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "tax_identification_number": "01234567891",
      "name": "Comune di Bugliano",
      "code": "CBugliano",
      "e2e_code": "CBugliano",
      "receiver_code": "RTIRIS",
      "e2e_receiver_code": "RTIRIS",
      "receiver_sil_id": "SIL_IRIS_ITR",
      "sil_id": "SIL_CBUGLIANO_OPEN",
      "password": "PASSWORD",
      "cert": "-----BEGIN CERTIFICATE REQUEST-----MIIB9TCCAWACAQAwgbgxGTAXBgNVBAoMEFF1b1ZhZGlzIExpbWl0ZWQxHDAaBgNVBAsME0RvY3VtZW50IERlcGFydG1lbnQxOTA3BgNVBAMMMFdoeSBhcmUgeW91IGRl-----END CERTIFICATE REQUEST-----",
      "application_code": "",
      "active": true,
      "id": "b212c4b4-db26-4404-8c7c-47dab99dd2e6"
    }),
});
const data = await response.json();

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

const response = await fetch('https://api.qa.stanzadelcittadino.it/payment-proxy/iris-v3/configs/{config_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "tenant_id": "b212c4b4-db26-4404-8c7c-47dab99dd2e6",
      "payment_type": "pagopa",
      "code": "CONTR_PRTPM",
      "description": "<p>Abbonamento aree di sosta</p>",
      "active": true,
      "split": [
        {
          "split_id": "c_1",
          "split_type": "Tipo c1",
          "split_code": "Codice c1",
          "split_description": "Descrizione c1",
          "split_amount": 0.5,
          "split_budget_chapter": "Capitolo di bilancio c1",
          "split_assessment": "Accertamento c1"
        }
      ],
      "amount": 1,
      "reason": "test",
      "expire_at": "2024-12-12T12:00:00:00.000Z",
      "collection_data": "9/0101100IM/",
      "office_code": "FSE",
      "office_description": "Fondo Sociale Europeo",
      "reference_code": "BOLLO_TIROCINI",
      "notes": "",
      "remote_collection": {
        "id": "3e68161e-9abb-43ac-99e6-39b0ece65b40",
        "type": "service"
      },
      "__$markdownParsed": true
    }),
});
const data = await response.json();

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

const response = await fetch('https://api.qa.stanzadelcittadino.it/payment-proxy/iris-v3/configs', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

[
  {
    "tenant_id": "b212c4b4-db26-4404-8c7c-47dab99dd2e6",
    "payment_type": "pagopa",
    "code": "CONTR_PRTPM",
    "description": "<p>Abbonamento aree di sosta</p>",
    "active": true,
    "split": [
      {
        "split_id": "c_1",
        "split_type": "Tipo c1",
        "split_code": "Codice c1",
        "split_description": "Descrizione c1",
        "split_amount": 0.5,
        "split_budget_chapter": "Capitolo di bilancio c1",
        "split_assessment": "Accertamento c1"
      }
    ],
    "amount": 1,
    "reason": "test",
    "expire_at": "2024-12-12T12:00:00:00.000Z",
    "collection_data": "9/0101100IM/",
    "office_code": "FSE",
    "office_description": "Fondo Sociale Europeo",
    "reference_code": "BOLLO_TIROCINI",
    "notes": "",
    "remote_collection": {
      "id": "23d57b65-5eb9-4f0a-a507-fbcf3057b248",
      "type": "service"
    },
    "__$markdownParsed": true
  }
]

const response = await fetch('https://api.qa.stanzadelcittadino.it/payment-proxy/iris-v3/configs/{config_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "tenant_id": "b212c4b4-db26-4404-8c7c-47dab99dd2e6",
  "payment_type": "pagopa",
  "code": "CONTR_PRTPM",
  "description": "<p>Abbonamento aree di sosta</p>",
  "active": true,
  "split": [
    {
      "split_id": "c_1",
      "split_type": "Tipo c1",
      "split_code": "Codice c1",
      "split_description": "Descrizione c1",
      "split_amount": 0.5,
      "split_budget_chapter": "Capitolo di bilancio c1",
      "split_assessment": "Accertamento c1"
    }
  ],
  "amount": 1,
  "reason": "test",
  "expire_at": "2024-12-12T12:00:00:00.000Z",
  "collection_data": "9/0101100IM/",
  "office_code": "FSE",
  "office_description": "Fondo Sociale Europeo",
  "reference_code": "BOLLO_TIROCINI",
  "notes": "",
  "remote_collection": {
    "id": "23d57b65-5eb9-4f0a-a507-fbcf3057b248",
    "type": "service"
  },
  "__$markdownParsed": true
}

const response = await fetch('https://api.qa.stanzadelcittadino.it/payment-proxy/iris-v3/configs', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "tenant_id": "b212c4b4-db26-4404-8c7c-47dab99dd2e6",
      "payment_type": "pagopa",
      "code": "CONTR_PRTPM",
      "description": "<p>Abbonamento aree di sosta</p>",
      "active": true,
      "split": [
        {
          "split_id": "c_1",
          "split_type": "Tipo c1",
          "split_code": "Codice c1",
          "split_description": "Descrizione c1",
          "split_amount": 0.5,
          "split_budget_chapter": "Capitolo di bilancio c1",
          "split_assessment": "Accertamento c1"
        }
      ],
      "amount": 1,
      "reason": "test",
      "expire_at": "2024-12-12T12:00:00:00.000Z",
      "collection_data": "9/0101100IM/",
      "office_code": "FSE",
      "office_description": "Fondo Sociale Europeo",
      "reference_code": "BOLLO_TIROCINI",
      "notes": "",
      "remote_collection": {
        "id": "3e68161e-9abb-43ac-99e6-39b0ece65b40",
        "type": "service"
      },
      "__$markdownParsed": true
    }),
});
const data = await response.json();

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}