SANP 3.2.2
SANPSACI
Tutto il resto

Operazioni disponibili

Tutte le operazioni indicate sono segregate per codice fiscale dell'ente creditore (organizationfiscalcode). Il dato è recuperato in autonomia dal servizio partendo dalla subscription key utilizzata.

Per questo motivo, non sarà necessario definire /organizations/{organizationfiscalcode}nelle chiamate verso il servizio.

Le chiamate sono quindi da considerasi valide al netto di:

  • base path (dipenderà dall'ambiente UAT/ PROD e maggiori dettagli si troveranno nel dev portal)

  • identificazione dell'EC (eseguita in autonomia da parte del servizio tramite api key)

Gestione posizioni debitorie

Nei seguenti sequence diagram si identifica con l'acronimo GPD il servizio di Gestione Posizioni Debitorie e con APD l'Archivio delle Posizioni Debitorie (base dati).

Per i dettagli https://github.com/pagopa/pagopa-api/tree/SANP3.2.1/openapi.

Creazione di una posizione debitoria

The Organization creates a debt Position.

The Organization creates a debt Position.

POSThttps://api.uat.platform.pagopa.it/gpd/api/v1/organizations/{organizationfiscalcode}/debtpositions
Path parameters
organizationfiscalcode*string

Organization fiscal code, the fiscal code of the Organization.

Header parameters
Body
iupd*string
type*enum
FG
fiscalCode*string
fullName*string
streetNamestring
civicNumberstring
postalCodestring
citystring
provincestring
regionstring
countrystring
emailstring
phonestring
switchToExpiredboolean

feature flag to enable the debt position to expire after the due date

Example: false
companyName*string
officeNamestring
validityDatestring (date-time)
statusenum
DRAFTPUBLISHEDVALIDINVALIDEXPIREDPARTIALLY_PAIDPAIDREPORTED
paymentOptionarray of PaymentOptionModel (object)
Response

Request created.

Headers
Body
iupd*string
type*enum
FG
fiscalCode*string
fullName*string
streetNamestring
civicNumberstring
postalCodestring
citystring
provincestring
regionstring
countrystring
emailstring
phonestring
switchToExpiredboolean

feature flag to enable the debt position to expire after the due date

Example: false
companyName*string
officeNamestring
validityDatestring (date-time)
statusenum
DRAFTPUBLISHEDVALIDINVALIDEXPIREDPARTIALLY_PAIDPAIDREPORTED
paymentOptionarray of PaymentOptionModel (object)
Request
const response = await fetch('https://api.uat.platform.pagopa.it/gpd/api/v1/organizations/{organizationfiscalcode}/debtpositions', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "iupd": "string",
      "type": "F",
      "fiscalCode": "string",
      "fullName": "string",
      "streetName": "string",
      "civicNumber": "string",
      "postalCode": "string",
      "city": "string",
      "province": "string",
      "region": "string",
      "country": "string",
      "email": "string",
      "phone": "string",
      "switchToExpired": false,
      "companyName": "string",
      "officeName": "string",
      "validityDate": "string",
      "status": "DRAFT",
      "paymentOption": [
        {
          "iuv": "string",
          "amount": 0,
          "description": "<p>string</p>",
          "isPartialPayment": true,
          "dueDate": "string",
          "retentionDate": "string",
          "fee": 0,
          "transfer": [
            {
              "idTransfer": "1",
              "amount": 0,
              "remittanceInformation": "string",
              "category": "string",
              "iban": "string",
              "postalIban": "string"
            }
          ],
          "__$markdownParsed": true
        }
      ]
    }),
});
const data = await response.json();
Response
{
  "iupd": "text",
  "type": "F",
  "fiscalCode": "text",
  "fullName": "text",
  "streetName": "text",
  "civicNumber": "text",
  "postalCode": "text",
  "city": "text",
  "province": "text",
  "region": "text",
  "country": "text",
  "email": "text",
  "phone": "text",
  "switchToExpired": false,
  "companyName": "text",
  "officeName": "text",
  "validityDate": "2024-11-24T19:09:45.937Z",
  "status": "DRAFT",
  "paymentOption": [
    {
      "iuv": "text",
      "description": "text",
      "isPartialPayment": false,
      "dueDate": "2024-11-24T19:09:45.937Z",
      "retentionDate": "2024-11-24T19:09:45.937Z",
      "transfer": [
        {
          "idTransfer": "1",
          "remittanceInformation": "text",
          "category": "text",
          "iban": "text",
          "postalIban": "text"
        }
      ]
    }
  ]
}

In fase di creazione della posizione debitoria il servizio effettuerà controlli sui dati in input e controlli di eventuali duplicati.

Tra i controlli dei dati in input si rilevano:

  • obbligatorietà dei dati

  • coerenza date (ad esempio due_date ≥ validity_date)

  • coerenza importi (ad esempio la somma degli importi dei versamenti deve essere uguale all'importo totale)

  • validità della tassonomia

  • validità degli IBAN (devono essere censiti sulla piattaforma pagoPA)

Tra i controlli dei duplicati ci si basa sugli identificativi di pagamento (IUPD e IUV)

Lettura di una lista di posizioni debitorie e di una singola posizione debitoria

Return the list of the organization debt positions.

Return the list of the organization debt positions.

GEThttps://api.uat.platform.pagopa.it/gpd/api/v1/organizations/{organizationfiscalcode}/debtpositions
Path parameters
organizationfiscalcode*string

Organization fiscal code, the fiscal code of the Organization.

Query parameters
Header parameters
Response

Obtained all organization payment positions.

Headers
Body
payment_position_list*array of PaymentPositionModelBaseResponse (object)
page_info*PageInfo (object)
Request
const response = await fetch('https://api.uat.platform.pagopa.it/gpd/api/v1/organizations/{organizationfiscalcode}/debtpositions?due_date_from=2024-11-24&due_date_to=2024-11-24', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "payment_position_list": [
    {
      "iupd": "text",
      "organizationFiscalCode": "text",
      "type": "F",
      "companyName": "text",
      "officeName": "text",
      "insertedDate": "2024-11-24T19:09:45.937Z",
      "publishDate": "2024-11-24T19:09:45.937Z",
      "validityDate": "2024-11-24T19:09:45.937Z",
      "status": "DRAFT",
      "lastUpdatedDate": "2024-11-24T19:09:45.937Z",
      "paymentOption": [
        {
          "iuv": "text",
          "organizationFiscalCode": "text",
          "description": "text",
          "isPartialPayment": false,
          "dueDate": "2024-11-24T19:09:45.937Z",
          "retentionDate": "2024-11-24T19:09:45.937Z",
          "paymentDate": "2024-11-24T19:09:45.937Z",
          "reportingDate": "2024-11-24T19:09:45.937Z",
          "insertedDate": "2024-11-24T19:09:45.937Z",
          "paymentMethod": "text",
          "pspCompany": "text",
          "idReceipt": "text",
          "idFlowReporting": "text",
          "status": "PO_UNPAID",
          "lastUpdatedDate": "2024-11-24T19:09:45.937Z",
          "transfer": [
            {
              "organizationFiscalCode": "text",
              "idTransfer": "text",
              "remittanceInformation": "text",
              "category": "text",
              "iban": "text",
              "postalIban": "text",
              "insertedDate": "2024-11-24T19:09:45.937Z",
              "status": "T_UNREPORTED",
              "lastUpdatedDate": "2024-11-24T19:09:45.937Z"
            }
          ]
        }
      ]
    }
  ],
  "page_info": {}
}

La lettura di una lista di posizioni debitorie prevede sempre una paginazione. E' inoltre possibile filtrare per due_date in modo da limitare i risultati.

Return the details of a specific debt position.

Return the details of a specific debt position.

GEThttps://api.uat.platform.pagopa.it/gpd/api/v1/organizations/{organizationfiscalcode}/debtpositions/{iupd}
Path parameters
organizationfiscalcode*string

Organization fiscal code, the fiscal code of the Organization.

iupd*string

IUPD (Unique identifier of the debt position). Format could be <Organization fiscal code + UUID> this would make it unique within the new PD management system. It's the responsibility of the EC to guarantee uniqueness. The pagoPa system shall verify that this is true and if not, notify the EC.

Header parameters
Response

Obtained debt position details.

Headers
Body
iupdstring
organizationFiscalCodestring
typeenum
FG
companyNamestring
officeNamestring
insertedDatestring (date-time)
publishDatestring (date-time)
validityDatestring (date-time)
statusenum
DRAFTPUBLISHEDVALIDINVALIDEXPIREDPARTIALLY_PAIDPAIDREPORTED
lastUpdatedDatestring (date-time)
paymentOptionarray of PaymentOptionModelResponse (object)
Request
const response = await fetch('https://api.uat.platform.pagopa.it/gpd/api/v1/organizations/{organizationfiscalcode}/debtpositions/{iupd}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "iupd": "text",
  "organizationFiscalCode": "text",
  "type": "F",
  "companyName": "text",
  "officeName": "text",
  "insertedDate": "2024-11-24T19:09:45.937Z",
  "publishDate": "2024-11-24T19:09:45.937Z",
  "validityDate": "2024-11-24T19:09:45.937Z",
  "status": "DRAFT",
  "lastUpdatedDate": "2024-11-24T19:09:45.937Z",
  "paymentOption": [
    {
      "iuv": "text",
      "organizationFiscalCode": "text",
      "description": "text",
      "isPartialPayment": false,
      "dueDate": "2024-11-24T19:09:45.937Z",
      "retentionDate": "2024-11-24T19:09:45.937Z",
      "paymentDate": "2024-11-24T19:09:45.937Z",
      "reportingDate": "2024-11-24T19:09:45.937Z",
      "insertedDate": "2024-11-24T19:09:45.937Z",
      "paymentMethod": "text",
      "pspCompany": "text",
      "idReceipt": "text",
      "idFlowReporting": "text",
      "status": "PO_UNPAID",
      "lastUpdatedDate": "2024-11-24T19:09:45.937Z",
      "transfer": [
        {
          "organizationFiscalCode": "text",
          "idTransfer": "text",
          "remittanceInformation": "text",
          "category": "text",
          "iban": "text",
          "postalIban": "text",
          "insertedDate": "2024-11-24T19:09:45.937Z",
          "status": "T_UNREPORTED",
          "lastUpdatedDate": "2024-11-24T19:09:45.937Z"
        }
      ]
    }
  ]
}

La lettura di una posizione debitoria si basa sull'identificativo in input (IUPD). In caso lo IUPD non sia esistente verrà emesso un errore.

Aggiornamento di una posizione debitoria

The Organization updates a debt position

The Organization updates a debt position

PUThttps://api.uat.platform.pagopa.it/gpd/api/v1/organizations/{organizationfiscalcode}/debtpositions/{iupd}
Path parameters
organizationfiscalcode*string

Organization fiscal code, the fiscal code of the Organization.

iupd*string

IUPD (Unique identifier of the debt position). Format could be <Organization fiscal code + UUID> this would make it unique within the new PD management system. It's the responsibility of the EC to guarantee uniqueness. The pagoPa system shall verify that this is true and if not, notify the EC.

Header parameters
Body
iupd*string
type*enum
FG
fiscalCode*string
fullName*string
streetNamestring
civicNumberstring
postalCodestring
citystring
provincestring
regionstring
countrystring
emailstring
phonestring
switchToExpiredboolean

feature flag to enable the debt position to expire after the due date

Example: false
companyName*string
officeNamestring
validityDatestring (date-time)
statusenum
DRAFTPUBLISHEDVALIDINVALIDEXPIREDPARTIALLY_PAIDPAIDREPORTED
paymentOptionarray of PaymentOptionModel (object)
Response

Request updated.

Headers
Body
iupd*string
type*enum
FG
fiscalCode*string
fullName*string
streetNamestring
civicNumberstring
postalCodestring
citystring
provincestring
regionstring
countrystring
emailstring
phonestring
switchToExpiredboolean

feature flag to enable the debt position to expire after the due date

Example: false
companyName*string
officeNamestring
validityDatestring (date-time)
statusenum
DRAFTPUBLISHEDVALIDINVALIDEXPIREDPARTIALLY_PAIDPAIDREPORTED
paymentOptionarray of PaymentOptionModel (object)
Request
const response = await fetch('https://api.uat.platform.pagopa.it/gpd/api/v1/organizations/{organizationfiscalcode}/debtpositions/{iupd}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "iupd": "string",
      "type": "F",
      "fiscalCode": "string",
      "fullName": "string",
      "streetName": "string",
      "civicNumber": "string",
      "postalCode": "string",
      "city": "string",
      "province": "string",
      "region": "string",
      "country": "string",
      "email": "string",
      "phone": "string",
      "switchToExpired": false,
      "companyName": "string",
      "officeName": "string",
      "validityDate": "string",
      "status": "DRAFT",
      "paymentOption": [
        {
          "iuv": "string",
          "amount": 0,
          "description": "<p>string</p>",
          "isPartialPayment": true,
          "dueDate": "string",
          "retentionDate": "string",
          "fee": 0,
          "transfer": [
            {
              "idTransfer": "1",
              "amount": 0,
              "remittanceInformation": "string",
              "category": "string",
              "iban": "string",
              "postalIban": "string"
            }
          ],
          "__$markdownParsed": true
        }
      ]
    }),
});
const data = await response.json();
Response
{
  "iupd": "text",
  "type": "F",
  "fiscalCode": "text",
  "fullName": "text",
  "streetName": "text",
  "civicNumber": "text",
  "postalCode": "text",
  "city": "text",
  "province": "text",
  "region": "text",
  "country": "text",
  "email": "text",
  "phone": "text",
  "switchToExpired": false,
  "companyName": "text",
  "officeName": "text",
  "validityDate": "2024-11-24T19:09:45.937Z",
  "status": "DRAFT",
  "paymentOption": [
    {
      "iuv": "text",
      "description": "text",
      "isPartialPayment": false,
      "dueDate": "2024-11-24T19:09:45.937Z",
      "retentionDate": "2024-11-24T19:09:45.937Z",
      "transfer": [
        {
          "idTransfer": "1",
          "remittanceInformation": "text",
          "category": "text",
          "iban": "text",
          "postalIban": "text"
        }
      ]
    }
  ]
}

In fase di aggiornamento, oltre ai già citati controlli in fase di creazione , si verifica che la posizione sia esistente ed aggiornabile.

In particolare l'aggiornabilità della posizione debitoria dipende dallo stato della posizione stessa (ad esempio se una posizione è già stata pagata non sarà possibile aggiornarla)

Cancellazione di una Posizione Debitoria

The Organization deletes a debt position

The Organization deletes a debt position

DELETEhttps://api.uat.platform.pagopa.it/gpd/api/v1/organizations/{organizationfiscalcode}/debtpositions/{iupd}
Path parameters
organizationfiscalcode*string

Organization fiscal code, the fiscal code of the Organization.

iupd*string

IUPD (Unique identifier of the debt position). Format could be <Organization fiscal code + UUID> this would make it unique within the new PD management system. It's the responsibility of the EC to guarantee uniqueness. The pagoPa system shall verify that this is true and if not, notify the EC.

Header parameters
Response

Operation completed successfully.

Headers
Body
string
Request
const response = await fetch('https://api.uat.platform.pagopa.it/gpd/api/v1/organizations/{organizationfiscalcode}/debtpositions/{iupd}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();
Response
text

La cancellazione di una posizione debitoria prevede controlli sia sull'esistenza (IUPD) che sullo stato (ad esempio, una posizione debitoria non sarà cancellabile se è già stata pagata)

Pubblicazione di una posizione debitoria

The Organization publish a debt Position.

The Organization publish a debt Position.

POSThttps://api.uat.platform.pagopa.it/gpd/api/v1/organizations/{organizationfiscalcode}/debtpositions/{iupd}/publish
Path parameters
organizationfiscalcode*string

Organization fiscal code, the fiscal code of the Organization.

iupd*string

IUPD (Unique identifier of the debt position). Format could be <Organization fiscal code + UUID> this would make it unique within the new PD management system. It's the responsibility of the EC to guarantee uniqueness. The pagoPa system shall verify that this is true and if not, notify the EC.

Header parameters
Response

Request published.

Headers
Body
iupd*string
type*enum
FG
fiscalCode*string
fullName*string
streetNamestring
civicNumberstring
postalCodestring
citystring
provincestring
regionstring
countrystring
emailstring
phonestring
switchToExpiredboolean

feature flag to enable the debt position to expire after the due date

Example: false
companyName*string
officeNamestring
validityDatestring (date-time)
statusenum
DRAFTPUBLISHEDVALIDINVALIDEXPIREDPARTIALLY_PAIDPAIDREPORTED
paymentOptionarray of PaymentOptionModel (object)
Request
const response = await fetch('https://api.uat.platform.pagopa.it/gpd/api/v1/organizations/{organizationfiscalcode}/debtpositions/{iupd}/publish', {
    method: 'POST',
    headers: {},
});
const data = await response.json();
Response
{
  "iupd": "text",
  "type": "F",
  "fiscalCode": "text",
  "fullName": "text",
  "streetName": "text",
  "civicNumber": "text",
  "postalCode": "text",
  "city": "text",
  "province": "text",
  "region": "text",
  "country": "text",
  "email": "text",
  "phone": "text",
  "switchToExpired": false,
  "companyName": "text",
  "officeName": "text",
  "validityDate": "2024-11-24T19:09:45.937Z",
  "status": "DRAFT",
  "paymentOption": [
    {
      "iuv": "text",
      "description": "text",
      "isPartialPayment": false,
      "dueDate": "2024-11-24T19:09:45.937Z",
      "retentionDate": "2024-11-24T19:09:45.937Z",
      "transfer": [
        {
          "idTransfer": "1",
          "remittanceInformation": "text",
          "category": "text",
          "iban": "text",
          "postalIban": "text"
        }
      ]
    }
  ]
}

La pubblicazione della posizione debitoria permette il passaggio dallo stato DRAFT allo stato PUBLISHED.

Una posizione in stato DRAFT (bozza) infatti non permette la normale operatività con la piattaforma pagoPA. Solo quando l'Ente Creditore pubblica la posizione, in coerenza con le date di validità e di scadenza, questa risulta pagabile sulla piattaforma.

Invalidazione di una posizione debitoria

The Organization invalidate a debt Position.

The Organization invalidate a debt Position.

POSThttps://api.uat.platform.pagopa.it/gpd/api/v1/organizations/{organizationfiscalcode}/debtpositions/{iupd}/invalidate
Path parameters
organizationfiscalcode*string

Organization fiscal code, the fiscal code of the Organization.

iupd*string

IUPD (Unique identifier of the debt position). Format could be <Organization fiscal code + UUID> this would make it unique within the new PD management system. It's the responsibility of the EC to guarantee uniqueness. The pagoPa system shall verify that this is true and if not, notify the EC.

Header parameters
Response

Request published.

Headers
Body
iupd*string
type*enum
FG
fiscalCode*string
fullName*string
streetNamestring
civicNumberstring
postalCodestring
citystring
provincestring
regionstring
countrystring
emailstring
phonestring
switchToExpiredboolean

feature flag to enable the debt position to expire after the due date

Example: false
companyName*string
officeNamestring
validityDatestring (date-time)
statusenum
DRAFTPUBLISHEDVALIDINVALIDEXPIREDPARTIALLY_PAIDPAIDREPORTED
paymentOptionarray of PaymentOptionModel (object)
Request
const response = await fetch('https://api.uat.platform.pagopa.it/gpd/api/v1/organizations/{organizationfiscalcode}/debtpositions/{iupd}/invalidate', {
    method: 'POST',
    headers: {},
});
const data = await response.json();
Response
{
  "iupd": "text",
  "type": "F",
  "fiscalCode": "text",
  "fullName": "text",
  "streetName": "text",
  "civicNumber": "text",
  "postalCode": "text",
  "city": "text",
  "province": "text",
  "region": "text",
  "country": "text",
  "email": "text",
  "phone": "text",
  "switchToExpired": false,
  "companyName": "text",
  "officeName": "text",
  "validityDate": "2024-11-24T19:09:45.937Z",
  "status": "DRAFT",
  "paymentOption": [
    {
      "iuv": "text",
      "description": "text",
      "isPartialPayment": false,
      "dueDate": "2024-11-24T19:09:45.937Z",
      "retentionDate": "2024-11-24T19:09:45.937Z",
      "transfer": [
        {
          "idTransfer": "1",
          "remittanceInformation": "text",
          "category": "text",
          "iban": "text",
          "postalIban": "text"
        }
      ]
    }
  ]
}

L'invalidazione di una posizione debitore consiste di fatto in una cancellazione logica. E' possibile solo partendo dagli stati PUBLISHED e VALID.

La funzionalità è utile quando si vuole dare evidenza all'utente, in fase di pagamento, della invalidazione della posizione debitoria.

Gestione pagamenti spontanei

Nei seguenti sequence diagram si identifica con l'acronimo GPS il servizio di Gestione Pagamenti Spontanei.

Si identificano 2 entità:

  • Ente Creditore (adesione al servizio di pagamenti spontanei)

  • Servizio (sottoscrizione ad uno specifico servizio)

Aggiunta di un ente creditore con eventuali sottoscrizioni a servizi

The organization creates a creditor institution with possible enrollments to services.

The organization creates a creditor institution with possible enrollments to services.

POSThttps://api.uat.platform.pagopa.it/gps/spontaneous-payments-service/v1/organizations/{organizationFiscalCode}
Path parameters
organizationFiscalCode*string

The fiscal code of the Organization.

Header parameters
Body
companyName*string
enrollmentsarray of CreateEnrollmentModel (object)
Response

Request created.

Headers
Body
fiscalCode*string
companyName*string
status*enum
ENABLEDDISABLED
enrollmentsarray of EnrollmentModelResponse (object)
Request
const response = await fetch('https://api.uat.platform.pagopa.it/gps/spontaneous-payments-service/v1/organizations/{organizationFiscalCode}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "companyName": "string",
      "enrollments": [
        {
          "serviceId": "string",
          "iban": "string",
          "officeName": "string",
          "segregationCode": "string",
          "remittanceInformation": "string",
          "postalIban": "string"
        }
      ]
    }),
});
const data = await response.json();
Response
{
  "fiscalCode": "text",
  "companyName": "text",
  "status": "ENABLED",
  "enrollments": [
    {
      "serviceId": "text",
      "iban": "text",
      "officeName": "text",
      "segregationCode": "text",
      "remittanceInformation": "text",
      "postalIban": "text"
    }
  ]
}

Con questa operazione è possibile aderire tecnicamente al servizio di gestione dei pagamenti spontanei. E' inoltre possibile, già in fase di adesione, definire l'iscrizione ai vari servizi.

Vengono effettuati controlli sintattici e semantici sui campi in input. In particolare, si segnalano controlli sulla bontà delle iscrizioni ai servizi (che devono essere presenti nell'elenco servizi)

Cancellazione di un ente creditore e relative sottoscrizioni

The organization deletes the creditor institution.

The organization deletes the creditor institution.

DELETEhttps://api.uat.platform.pagopa.it/gps/spontaneous-payments-service/v1/organizations/{organizationFiscalCode}
Path parameters
organizationFiscalCode*string

The fiscal code of the Organization.

Header parameters
Response

Request deleted.

Headers
Body
string
Request
const response = await fetch('https://api.uat.platform.pagopa.it/gps/spontaneous-payments-service/v1/organizations/{organizationFiscalCode}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();
Response
text

Questa funzionalità permette la cancellazione di un adesione di un Ente Creditore al servizio di gestione dei pagamenti spontanei. Contestualmente vengono cancellate tutte le sottoscrizioni.

Questa operazione, per potere essere effettuata, deve essere preceduta da un adesione.

Aggiornamento di un Ente Creditore

The organization updates the creditor institution.

The organization updates the creditor institution.

PUThttps://api.uat.platform.pagopa.it/gps/spontaneous-payments-service/v1/organizations/{organizationFiscalCode}
Path parameters
organizationFiscalCode*string

The fiscal code of the Organization.

Header parameters
Body
companyNamestring
statusenum
ENABLEDDISABLED
Response

Request updated.

Headers
Body
fiscalCode*string
companyName*string
status*enum
ENABLEDDISABLED
enrollmentsarray of EnrollmentModelResponse (object)
Request
const response = await fetch('https://api.uat.platform.pagopa.it/gps/spontaneous-payments-service/v1/organizations/{organizationFiscalCode}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "companyName": "string",
      "status": "ENABLED"
    }),
});
const data = await response.json();
Response
{
  "fiscalCode": "text",
  "companyName": "text",
  "status": "ENABLED",
  "enrollments": [
    {
      "serviceId": "text",
      "iban": "text",
      "officeName": "text",
      "segregationCode": "text",
      "remittanceInformation": "text",
      "postalIban": "text"
    }
  ]
}

Con questa funzionalità è possibili aggiornare le proprietà dell'Ente Creditore in merito all'adesione al servizio.

Valgono gli stessi controlli definiti per la creazione dell' adesione, oltre ai controlli legati alla presenza di una precedente adesione.

Lettura dei dati di un ente creditore e sottoscrizioni a servizi

Return all enrollments for a creditor institution.

Return all enrollments for a creditor institution.

GEThttps://api.uat.platform.pagopa.it/gps/spontaneous-payments-service/v1/organizations/{organizationFiscalCode}
Path parameters
organizationFiscalCode*string

The fiscal code of the Organization.

Header parameters
Response

Obtained all enrollments for the creditor institution.

Headers
Body
fiscalCode*string
companyName*string
status*enum
ENABLEDDISABLED
enrollmentsarray of EnrollmentModelResponse (object)
Request
const response = await fetch('https://api.uat.platform.pagopa.it/gps/spontaneous-payments-service/v1/organizations/{organizationFiscalCode}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "fiscalCode": "text",
  "companyName": "text",
  "status": "ENABLED",
  "enrollments": [
    {
      "serviceId": "text",
      "iban": "text",
      "officeName": "text",
      "segregationCode": "text",
      "remittanceInformation": "text",
      "postalIban": "text"
    }
  ]
}

Questa funzionalità permette di recuperare, oltre alle proprietà dell'ente creditore, tutte le sottoscrizioni ai servizi.

Sottoscrizione a un servizio

The organization creates an enrollment to a service for the creditor institution.

The organization creates an enrollment to a service for the creditor institution.

POSThttps://api.uat.platform.pagopa.it/gps/spontaneous-payments-service/v1/organizations/{organizationFiscalCode}/services/{serviceId}
Path parameters
organizationFiscalCode*string

The fiscal code of the Organization.

serviceId*string

The service id to enroll.

Header parameters
Body
iban*string
officeNamestring
segregationCode*string
remittanceInformation*string
postalIbanstring
Response

Request created.

Headers
Body
fiscalCode*string
companyName*string
status*enum
ENABLEDDISABLED
enrollmentsarray of EnrollmentModelResponse (object)
Request
const response = await fetch('https://api.uat.platform.pagopa.it/gps/spontaneous-payments-service/v1/organizations/{organizationFiscalCode}/services/{serviceId}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "iban": "string",
      "officeName": "string",
      "segregationCode": "string",
      "remittanceInformation": "string",
      "postalIban": "string"
    }),
});
const data = await response.json();
Response
{
  "fiscalCode": "text",
  "companyName": "text",
  "status": "ENABLED",
  "enrollments": [
    {
      "serviceId": "text",
      "iban": "text",
      "officeName": "text",
      "segregationCode": "text",
      "remittanceInformation": "text",
      "postalIban": "text"
    }
  ]
}

Con questa operazione è possibile aggiungere una sottoscrizione ad un servizio.

Vengono effettuati controlli in merito all'identificativo del servizio aggiunto (deve essere esistente e non deve essere già presente un sottoscrizione) oltre ai controlli sintattici e semantici sulle proprietà dell'adesione (IBAN, causale versamento, etc).

Lettura di una sottoscrizione a un servizio

Return the single enrollment to a service.

Return the single enrollment to a service.

GEThttps://api.uat.platform.pagopa.it/gps/spontaneous-payments-service/v1/organizations/{organizationFiscalCode}/services/{serviceId}
Path parameters
organizationFiscalCode*string

The fiscal code of the Organization.

serviceId*string

The service id to enroll.

Header parameters
Response

Obtained single enrollment.

Headers
Body
serviceId*string
iban*string
officeNamestring
segregationCode*string
remittanceInformation*string
postalIbanstring
Request
const response = await fetch('https://api.uat.platform.pagopa.it/gps/spontaneous-payments-service/v1/organizations/{organizationFiscalCode}/services/{serviceId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "serviceId": "text",
  "iban": "text",
  "officeName": "text",
  "segregationCode": "text",
  "remittanceInformation": "text",
  "postalIban": "text"
}

Con questa operazione è possibile recuperare le proprietà di una determinata sottoscrizione ad un servizio.

Aggiornamento di una sottoscrizione a un servizio

The organization updates an enrollment to a service for the creditor institution.

The organization updates an enrollment to a service for the creditor institution.

PUThttps://api.uat.platform.pagopa.it/gps/spontaneous-payments-service/v1/organizations/{organizationFiscalCode}/services/{serviceId}
Path parameters
organizationFiscalCode*string

The fiscal code of the Organization.

serviceId*string

The service id to enroll.

Header parameters
Body
iban*string
officeNamestring
segregationCode*string
remittanceInformation*string
postalIbanstring
Response

Request updated.

Headers
Body
fiscalCode*string
companyName*string
status*enum
ENABLEDDISABLED
enrollmentsarray of EnrollmentModelResponse (object)
Request
const response = await fetch('https://api.uat.platform.pagopa.it/gps/spontaneous-payments-service/v1/organizations/{organizationFiscalCode}/services/{serviceId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "iban": "string",
      "officeName": "string",
      "segregationCode": "string",
      "remittanceInformation": "string",
      "postalIban": "string"
    }),
});
const data = await response.json();
Response
{
  "fiscalCode": "text",
  "companyName": "text",
  "status": "ENABLED",
  "enrollments": [
    {
      "serviceId": "text",
      "iban": "text",
      "officeName": "text",
      "segregationCode": "text",
      "remittanceInformation": "text",
      "postalIban": "text"
    }
  ]
}

Con questa operazione è possibile aggiornare le proprietà di una sottoscrizione precedentemente aggiunta.

Non è possibile cambiare il servizio con questa operazione.

Cancellazione di una sottoscrizione a un servizio

The organization deletes the enrollment to service for the creditor institution.

The organization deletes the enrollment to service for the creditor institution.

DELETEhttps://api.uat.platform.pagopa.it/gps/spontaneous-payments-service/v1/organizations/{organizationFiscalCode}/services/{serviceId}
Path parameters
organizationFiscalCode*string

The fiscal code of the Organization.

serviceId*string

The service id to enroll.

Header parameters
Response

Request deleted.

Headers
Body
string
Request
const response = await fetch('https://api.uat.platform.pagopa.it/gps/spontaneous-payments-service/v1/organizations/{organizationFiscalCode}/services/{serviceId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();
Response
text

Con questa operazione è possibile cancellare la sottoscrizione ad un servizio precedentemente aggiunto.

Flussi di rendicontazione

Sono messe a disposizione delle funzionalità di lettura dei flussi di rendicontazione:

  • Lista di flussi di rendicontazione per un Ente Creditore

  • Dettaglio del flusso di rendicontazione

getFlowList

getFlowList

GEThttps://api.uat.platform.pagopa.it/gpd-reporting/api/v1/organizations/{organizationId}/reportings
Path parameters
organizationId*string
Response

Successful response

Body
flowIdstring
Example: "2022-01-12PPAYITR1XXX-S079177254"
flowDatestring
Example: "2022-01-12T00:31:05"
Request
const response = await fetch('https://api.uat.platform.pagopa.it/gpd-reporting/api/v1/organizations/{organizationId}/reportings', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
[
  {
    "flowId": "2022-01-12PPAYITR1XXX-S079177254",
    "flowDate": "2022-01-12T00:31:05"
  }
]

getFlow

getFlow

GEThttps://api.uat.platform.pagopa.it/gpd-reporting/api/v1/organizations/{organizationId}/reportings/{flowId}/date/{date}
Path parameters
organizationId*string
flowId*string
date*string
Response

Successful response

Body
string (binary)

Flow XML

Request
const response = await fetch('https://api.uat.platform.pagopa.it/gpd-reporting/api/v1/organizations/{organizationId}/reportings/{flowId}/date/{date}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
binary

PreviousStati della posizione debitoriaNextEnte Creditore

Last updated