LogoLogo
SANPSACITutto il resto
SANP 3.3.1
SANP 3.3.1
  • ⬅️Torna a pagoPA.gov.it
  • Specifiche attuative del nodo dei pagamenti SPC
    • Premessa
    • Changelog
    • Glossario
    • Roadmap
    • Documentazione
    • Funzionamento generale
      • Ruoli
      • Ciclo di vita di un pagamento
      • Processi di pagamento
      • Rendicontazione e Cashflow
      • Overview delle componenti
      • Sicurezza e conservazione
      • L’adesione alla piattaforma pagoPA
      • Utilizzo del marchio pagoPA
    • Erogazione e Livelli di servizio
    • Modello dati
  • Casi d'uso
    • Pagamento di un avviso presso PSP
    • Pagamento spontaneo presso PSP
      • Catalogo dei servizi
      • Bollo auto
    • Pagamento presso frontend dell'EC
    • Pagamento da Touchpoint PagoPA
      • Checkout
      • App IO
  • Ente Creditore
    • Adesione
    • Modalità d'integrazione
      • Integrazione tramite API sincrone
      • Integrazione tramite API asincrone
      • Integrazione touch point dell’EC con Checkout
      • Best practice
    • Generazione dell’Identificativo Univoco di Versamento
    • Tassonomia dei servizi di incasso
    • Tributi multi-beneficiario
    • Attestazione di pagamento
    • Riconciliazione contabile
    • Servizio @e.bollo
    • Stampa avvisi pagoPA
    • Processo di avvio in Esercizio
  • Prestatore di Servizi di Pagamento
    • Adesione
    • Modalità di integrazione
      • Integrazione tramite API
      • Catalogo Dati Informativi
      • Offrire sistemi di pagamento su touch point di PagoPA S.p.A.
      • Gestione strumenti di pagamento
      • Best practice
    • Commissioni
    • Attestazione di pagamento
    • Processo di avvio in Esercizio
  • Esperienza per il Cittadino
    • App IO
      • Carte
      • PayPal
    • Checkout
  • Appendici
    • Connettività
    • Indicatori di qualità per i soggetti aderenti
      • Livelli di Servizio Enti Creditori
      • Livelli di Servizio PSP
    • Giornale degli eventi
    • Generazione e stampa degli avvisi
    • Gestione evoluta commissioni
    • Primitive
    • Funzionalità deprecate
    • Adesione ai servizi con subscription key
    • Posizioni Debitorie
      • Modello Dati
      • Stati della posizione debitoria
      • Operazioni disponibili
    • POS Fisici
  • FAQ
    • Ente Creditore
    • PSP
    • Intermediario tecnologico
Powered by GitBook
On this page
  1. Appendici
  2. Posizioni Debitorie

Operazioni disponibili

PreviousStati della posizione debitoriaNextPOS Fisici

Last updated 2 years ago

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 .

Creazione di una posizione debitoria

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

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.

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

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

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

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

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

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

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

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

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

Sottoscrizione a un servizio

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

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

Aggiornamento di una sottoscrizione a un servizio

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

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

https://github.com/pagopa/pagopa-api/tree/SANP3.3.1/openapi

The organization deletes the creditor institution.

delete

The organization deletes the creditor institution.

Authorizations
Path parameters
organizationFiscalCodestringRequired

The fiscal code of the Organization.

Header parameters
X-Request-IdstringOptional

This header identifies the call, if not passed it is self-generated. This ID is returned in the response.

Responses
200
Request deleted.
application/json
Responsestring
401
Wrong or missing function key.
404
Not found the creditor institution.
application/json
500
Service unavailable.
application/json
delete
DELETE /gps/spontaneous-payments-service/v1/organizations/{organizationFiscalCode} HTTP/1.1
Host: api.uat.platform.pagopa.it
Ocp-Apim-Subscription-Key: YOUR_API_KEY
Accept: */*
string

Return all enrollments for a creditor institution.

get

Return all enrollments for a creditor institution.

Authorizations
Path parameters
organizationFiscalCodestringRequired

The fiscal code of the Organization.

Header parameters
X-Request-IdstringOptional

This header identifies the call, if not passed it is self-generated. This ID is returned in the response.

Responses
200
Obtained all enrollments for the creditor institution.
application/json
401
Wrong or missing function key.
404
Not found the creditor institution.
application/json
422
Unprocessable request.
application/json
500
Service unavailable.
application/json
get
GET /gps/spontaneous-payments-service/v1/organizations/{organizationFiscalCode} HTTP/1.1
Host: api.uat.platform.pagopa.it
Ocp-Apim-Subscription-Key: YOUR_API_KEY
Accept: */*
{
  "fiscalCode": "string",
  "companyName": "string",
  "status": "ENABLED",
  "enrollments": [
    {
      "serviceId": "string",
      "iban": "string",
      "officeName": "string",
      "segregationCode": "string",
      "remittanceInformation": "string",
      "postalIban": "string"
    }
  ]
}

Return the single enrollment to a service.

get

Return the single enrollment to a service.

Authorizations
Path parameters
organizationFiscalCodestringRequired

The fiscal code of the Organization.

serviceIdstringRequired

The service id to enroll.

Header parameters
X-Request-IdstringOptional

This header identifies the call, if not passed it is self-generated. This ID is returned in the response.

Responses
200
Obtained single enrollment.
application/json
401
Wrong or missing function key.
404
Not found the enroll service.
application/json
422
Unprocessable request.
application/json
500
Service unavailable.
application/json
get
GET /gps/spontaneous-payments-service/v1/organizations/{organizationFiscalCode}/services/{serviceId} HTTP/1.1
Host: api.uat.platform.pagopa.it
Ocp-Apim-Subscription-Key: YOUR_API_KEY
Accept: */*
{
  "serviceId": "string",
  "iban": "string",
  "officeName": "string",
  "segregationCode": "string",
  "remittanceInformation": "string",
  "postalIban": "string"
}

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

delete

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

Authorizations
Path parameters
organizationFiscalCodestringRequired

The fiscal code of the Organization.

serviceIdstringRequired

The service id to enroll.

Header parameters
X-Request-IdstringOptional

This header identifies the call, if not passed it is self-generated. This ID is returned in the response.

Responses
200
Request deleted.
application/json
Responsestring
401
Wrong or missing function key.
404
Not found the creditor institution or the enroll service.
application/json
422
Unprocessable request.
application/json
500
Service unavailable.
application/json
delete
DELETE /gps/spontaneous-payments-service/v1/organizations/{organizationFiscalCode}/services/{serviceId} HTTP/1.1
Host: api.uat.platform.pagopa.it
Ocp-Apim-Subscription-Key: YOUR_API_KEY
Accept: */*
string

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

post

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

Authorizations
Path parameters
organizationFiscalCodestringRequired

The fiscal code of the Organization.

Header parameters
X-Request-IdstringOptional

This header identifies the call, if not passed it is self-generated. This ID is returned in the response.

Body
companyNamestringRequired
Responses
201
Request created.
application/json
400
Malformed request.
application/json
401
Wrong or missing function key.
409
The organization to create already exists.
application/json
422
Unprocessable request.
application/json
500
Service unavailable.
application/json
post
POST /gps/spontaneous-payments-service/v1/organizations/{organizationFiscalCode} HTTP/1.1
Host: api.uat.platform.pagopa.it
Ocp-Apim-Subscription-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 183

{
  "companyName": "string",
  "enrollments": [
    {
      "serviceId": "string",
      "iban": "string",
      "officeName": "string",
      "segregationCode": "string",
      "remittanceInformation": "string",
      "postalIban": "string"
    }
  ]
}
{
  "fiscalCode": "string",
  "companyName": "string",
  "status": "ENABLED",
  "enrollments": [
    {
      "serviceId": "string",
      "iban": "string",
      "officeName": "string",
      "segregationCode": "string",
      "remittanceInformation": "string",
      "postalIban": "string"
    }
  ]
}

The organization updates the creditor institution.

put

The organization updates the creditor institution.

Authorizations
Path parameters
organizationFiscalCodestringRequired

The fiscal code of the Organization.

Header parameters
X-Request-IdstringOptional

This header identifies the call, if not passed it is self-generated. This ID is returned in the response.

Body
companyNamestringOptional
statusstring · enumOptionalPossible values:
Responses
200
Request updated.
application/json
400
Malformed request.
application/json
401
Wrong or missing function key.
404
Not found the creditor institution.
application/json
500
Service unavailable.
application/json
put
PUT /gps/spontaneous-payments-service/v1/organizations/{organizationFiscalCode} HTTP/1.1
Host: api.uat.platform.pagopa.it
Ocp-Apim-Subscription-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "companyName": "string",
  "status": "ENABLED"
}
{
  "fiscalCode": "string",
  "companyName": "string",
  "status": "ENABLED",
  "enrollments": [
    {
      "serviceId": "string",
      "iban": "string",
      "officeName": "string",
      "segregationCode": "string",
      "remittanceInformation": "string",
      "postalIban": "string"
    }
  ]
}

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

post

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

Authorizations
Path parameters
organizationFiscalCodestringRequired

The fiscal code of the Organization.

serviceIdstringRequired

The service id to enroll.

Header parameters
X-Request-IdstringOptional

This header identifies the call, if not passed it is self-generated. This ID is returned in the response.

Body
ibanstringRequired
officeNamestringOptional
segregationCodestringRequired
remittanceInformationstringRequired
postalIbanstringOptional
Responses
201
Request created.
application/json
400
Malformed request.
application/json
401
Wrong or missing function key.
404
Not found the creditor institution or the enroll service.
application/json
409
The enrollment to the service already exists.
application/json
422
Unprocessable request.
application/json
500
Service unavailable.
application/json
post
POST /gps/spontaneous-payments-service/v1/organizations/{organizationFiscalCode}/services/{serviceId} HTTP/1.1
Host: api.uat.platform.pagopa.it
Ocp-Apim-Subscription-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 121

{
  "iban": "string",
  "officeName": "string",
  "segregationCode": "string",
  "remittanceInformation": "string",
  "postalIban": "string"
}
{
  "fiscalCode": "string",
  "companyName": "string",
  "status": "ENABLED",
  "enrollments": [
    {
      "serviceId": "string",
      "iban": "string",
      "officeName": "string",
      "segregationCode": "string",
      "remittanceInformation": "string",
      "postalIban": "string"
    }
  ]
}

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

put

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

Authorizations
Path parameters
organizationFiscalCodestringRequired

The fiscal code of the Organization.

serviceIdstringRequired

The service id to enroll.

Header parameters
X-Request-IdstringOptional

This header identifies the call, if not passed it is self-generated. This ID is returned in the response.

Body
ibanstringRequired
officeNamestringOptional
segregationCodestringRequired
remittanceInformationstringRequired
postalIbanstringOptional
Responses
200
Request updated.
application/json
400
Malformed request.
application/json
401
Wrong or missing function key.
404
Not found the creditor institution or the enroll service.
application/json
422
Unprocessable request.
application/json
500
Service unavailable.
application/json
put
PUT /gps/spontaneous-payments-service/v1/organizations/{organizationFiscalCode}/services/{serviceId} HTTP/1.1
Host: api.uat.platform.pagopa.it
Ocp-Apim-Subscription-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 121

{
  "iban": "string",
  "officeName": "string",
  "segregationCode": "string",
  "remittanceInformation": "string",
  "postalIban": "string"
}
{
  "fiscalCode": "string",
  "companyName": "string",
  "status": "ENABLED",
  "enrollments": [
    {
      "serviceId": "string",
      "iban": "string",
      "officeName": "string",
      "segregationCode": "string",
      "remittanceInformation": "string",
      "postalIban": "string"
    }
  ]
}
  • Gestione posizioni debitorie
  • Creazione di una posizione debitoria
  • POSTThe Organization creates a debt Position.
  • Lettura di una lista di posizioni debitorie e di una singola posizione debitoria
  • GETReturn the list of the organization debt positions.
  • GETReturn the details of a specific debt position.
  • Aggiornamento di una posizione debitoria
  • PUTThe Organization updates a debt position
  • Cancellazione di una Posizione Debitoria
  • DELETEThe Organization deletes a debt position
  • Pubblicazione di una posizione debitoria
  • POSTThe Organization publish a debt Position.
  • Invalidazione di una posizione debitoria
  • POSTThe Organization invalidate a debt Position.
  • Gestione pagamenti spontanei
  • Aggiunta di un ente creditore con eventuali sottoscrizioni a servizi
  • POSTThe organization creates a creditor institution with possible enrollments to services.
  • Cancellazione di un ente creditore e relative sottoscrizioni
  • DELETEThe organization deletes the creditor institution.
  • Aggiornamento di un Ente Creditore
  • PUTThe organization updates the creditor institution.
  • Lettura dei dati di un ente creditore e sottoscrizioni a servizi
  • GETReturn all enrollments for a creditor institution.
  • Sottoscrizione a un servizio
  • POSTThe organization creates an enrollment to a service for the creditor institution.
  • Lettura di una sottoscrizione a un servizio
  • GETReturn the single enrollment to a service.
  • Aggiornamento di una sottoscrizione a un servizio
  • PUTThe organization updates an enrollment to a service for the creditor institution.
  • Cancellazione di una sottoscrizione a un servizio
  • DELETEThe organization deletes the enrollment to service for the creditor institution.
  • Flussi di rendicontazione
  • GETgetFlowList
  • GETgetFlow

getFlowList

get

getFlowList

Authorizations
Path parameters
organizationIdstringRequiredExample: {"value":null}
Responses
200
Successful response
application/json
400
Error response
application/json
get

getFlow

get

getFlow

Authorizations
Path parameters
organizationIdstringRequiredExample: {"value":null}
flowIdstringRequiredExample: {"value":null}
datestringRequiredExample: {"value":null}
Responses
200
Successful response
application/xml
Responsestring · binary

Flow XML

404
Not Found
application/json
get

Return the list of the organization debt positions.

get

Return the list of the organization debt positions.

Authorizations
Path parameters
organizationfiscalcodestringRequired

Organization fiscal code, the fiscal code of the Organization.

Query parameters
pageinteger · int32Required

Format - int32. Page number. Page value starts from 0

due_date_fromstring · dateRequired

Format - date (as full-date in RFC3339). Filter from due_date (if provided use the format yyyy-MM-dd)

due_date_tostring · dateRequired

Format - date (as full-date in RFC3339). Filter to due_date (if provided use the format yyyy-MM-dd)

limitinteger · int32Optional

Format - int32. Number of elements on one page. Default = 50

Default: 50
orderbystring · enumOptional

Order by INSERTED_DATE, COMPANY_NAME, IUPD or STATUS

Default: COMPANY_NAMEPossible values:
orderingstring · enumOptional

Direction of ordering

Default: DESCPossible values:
Header parameters
X-Request-IdstringOptional

This header identifies the call, if not passed it is self-generated. This ID is returned in the response.

Responses
200
Obtained all organization payment positions.
application/json
400
Malformed request.
application/json
401
Wrong or missing function key.
429
Too many requests.
500
Service unavailable.
application/json
get

Return the details of a specific debt position.

get

Return the details of a specific debt position.

Authorizations
Path parameters
organizationfiscalcodestringRequired

Organization fiscal code, the fiscal code of the Organization.

iupdstringRequired

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
X-Request-IdstringOptional

This header identifies the call, if not passed it is self-generated. This ID is returned in the response.

Responses
200
Obtained debt position details.
application/json
401
Wrong or missing function key.
404
No debt position found.
application/json
500
Service unavailable.
application/json
get

The Organization deletes a debt position

delete

The Organization deletes a debt position

Authorizations
Path parameters
organizationfiscalcodestringRequired

Organization fiscal code, the fiscal code of the Organization.

iupdstringRequired

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
X-Request-IdstringOptional

This header identifies the call, if not passed it is self-generated. This ID is returned in the response.

Responses
200
Operation completed successfully.
application/json
Responsestring
401
Wrong or missing function key.
404
No debt position position found.
application/json
409
Conflict: existing related payment found.
application/json
500
Service unavailable.
application/json
delete

The Organization publish a debt Position.

post

The Organization publish a debt Position.

Authorizations
Path parameters
organizationfiscalcodestringRequired

Organization fiscal code, the fiscal code of the Organization.

iupdstringRequired

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
X-Request-IdstringOptional

This header identifies the call, if not passed it is self-generated. This ID is returned in the response.

Responses
200
Request published.
application/json
401
Wrong or missing function key.
404
No debt position found.
application/json
409
Conflict: debt position is not in publishable state.
application/json
500
Service unavailable.
application/json
post

The Organization invalidate a debt Position.

post

The Organization invalidate a debt Position.

Authorizations
Path parameters
organizationfiscalcodestringRequired

Organization fiscal code, the fiscal code of the Organization.

iupdstringRequired

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
X-Request-IdstringOptional

This header identifies the call, if not passed it is self-generated. This ID is returned in the response.

Responses
200
Request published.
application/json
401
Wrong or missing function key.
404
No debt position found.
application/json
409
Conflict: debt position is not in invalidable state.
application/json
500
Service unavailable.
application/json
post
GET /gpd-reporting/api/v1/organizations/{organizationId}/reportings HTTP/1.1
Host: api.uat.platform.pagopa.it
Ocp-Apim-Subscription-Key: YOUR_API_KEY
Accept: */*
[
  {
    "flowId": "2022-07-15PSPXXXXXXXX-0000000001",
    "flowDate": "2022-07-15T00:31:05.0000000+00:00"
  }
]
GET /gpd-reporting/api/v1/organizations/{organizationId}/reportings/{flowId}/date/{date} HTTP/1.1
Host: api.uat.platform.pagopa.it
Ocp-Apim-Subscription-Key: YOUR_API_KEY
Accept: */*
<Organizations-organizationId-Reportings-flowId-Date-date-Get200ApplicationXmlResponse>string</Organizations-organizationId-Reportings-flowId-Date-date-Get200ApplicationXmlResponse>

The Organization creates a debt Position.

post

The Organization creates a debt Position.

Authorizations
Path parameters
organizationfiscalcodestringRequired

Organization fiscal code, the fiscal code of the Organization.

Header parameters
X-Request-IdstringOptional

This header identifies the call, if not passed it is self-generated. This ID is returned in the response.

Body
iupdstringRequired
typestring · enumRequiredPossible values:
fiscalCodestringRequired
fullNamestringRequired
streetNamestringOptional
civicNumberstringOptional
postalCodestringOptional
citystringOptional
provincestringOptional
regionstringOptional
countrystringOptional
emailstringOptional
phonestringOptional
switchToExpiredbooleanOptional

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

Default: falseExample: false
companyNamestringRequired
officeNamestringOptional
validityDatestring · date-timeOptional
statusstring · enumRead-onlyOptionalPossible values:
Responses
201
Request created.
application/json
400
Malformed request.
application/json
401
Wrong or missing function key.
409
Conflict: duplicate debt position found.
application/json
500
Service unavailable.
application/json
post
POST /gpd/api/v1/organizations/{organizationfiscalcode}/debtpositions HTTP/1.1
Host: api.uat.platform.pagopa.it
Ocp-Apim-Subscription-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 633

{
  "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": "string",
      "isPartialPayment": true,
      "dueDate": "string",
      "retentionDate": "string",
      "fee": 0,
      "transfer": [
        {
          "idTransfer": "1",
          "amount": 0,
          "remittanceInformation": "string",
          "category": "string",
          "iban": "string",
          "postalIban": "string"
        }
      ]
    }
  ]
}
{
  "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": "string",
      "isPartialPayment": true,
      "dueDate": "string",
      "retentionDate": "string",
      "fee": 0,
      "transfer": [
        {
          "idTransfer": "1",
          "amount": 0,
          "remittanceInformation": "string",
          "category": "string",
          "iban": "string",
          "postalIban": "string"
        }
      ]
    }
  ]
}
GET /gpd/api/v1/organizations/{organizationfiscalcode}/debtpositions HTTP/1.1
Host: api.uat.platform.pagopa.it
Ocp-Apim-Subscription-Key: YOUR_API_KEY
Accept: */*
{
  "payment_position_list": [
    {
      "iupd": "string",
      "organizationFiscalCode": "string",
      "type": "F",
      "companyName": "string",
      "officeName": "string",
      "insertedDate": "string",
      "publishDate": "string",
      "validityDate": "string",
      "status": "DRAFT",
      "lastUpdatedDate": "string",
      "paymentOption": [
        {
          "iuv": "string",
          "organizationFiscalCode": "string",
          "amount": 0,
          "description": "string",
          "isPartialPayment": true,
          "dueDate": "string",
          "retentionDate": "string",
          "paymentDate": "string",
          "reportingDate": "string",
          "insertedDate": "string",
          "paymentMethod": "string",
          "fee": 0,
          "pspCompany": "string",
          "idReceipt": "string",
          "idFlowReporting": "string",
          "status": "PO_UNPAID",
          "lastUpdatedDate": "string",
          "transfer": [
            {
              "organizationFiscalCode": "string",
              "idTransfer": "string",
              "amount": 0,
              "remittanceInformation": "string",
              "category": "string",
              "iban": "string",
              "postalIban": "string",
              "insertedDate": "string",
              "status": "T_UNREPORTED",
              "lastUpdatedDate": "string"
            }
          ]
        }
      ]
    }
  ],
  "page_info": {
    "page": 0,
    "limit": 0,
    "items_found": 0,
    "total_pages": 0
  }
}
GET /gpd/api/v1/organizations/{organizationfiscalcode}/debtpositions/{iupd} HTTP/1.1
Host: api.uat.platform.pagopa.it
Ocp-Apim-Subscription-Key: YOUR_API_KEY
Accept: */*
{
  "iupd": "string",
  "organizationFiscalCode": "string",
  "type": "F",
  "companyName": "string",
  "officeName": "string",
  "insertedDate": "string",
  "publishDate": "string",
  "validityDate": "string",
  "status": "DRAFT",
  "lastUpdatedDate": "string",
  "paymentOption": [
    {
      "iuv": "string",
      "organizationFiscalCode": "string",
      "amount": 0,
      "description": "string",
      "isPartialPayment": true,
      "dueDate": "string",
      "retentionDate": "string",
      "paymentDate": "string",
      "reportingDate": "string",
      "insertedDate": "string",
      "paymentMethod": "string",
      "fee": 0,
      "pspCompany": "string",
      "idReceipt": "string",
      "idFlowReporting": "string",
      "status": "PO_UNPAID",
      "lastUpdatedDate": "string",
      "transfer": [
        {
          "organizationFiscalCode": "string",
          "idTransfer": "string",
          "amount": 0,
          "remittanceInformation": "string",
          "category": "string",
          "iban": "string",
          "postalIban": "string",
          "insertedDate": "string",
          "status": "T_UNREPORTED",
          "lastUpdatedDate": "string"
        }
      ]
    }
  ]
}

The Organization updates a debt position

put

The Organization updates a debt position

Authorizations
Path parameters
organizationfiscalcodestringRequired

Organization fiscal code, the fiscal code of the Organization.

iupdstringRequired

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
X-Request-IdstringOptional

This header identifies the call, if not passed it is self-generated. This ID is returned in the response.

Body
iupdstringRequired
typestring · enumRequiredPossible values:
fiscalCodestringRequired
fullNamestringRequired
streetNamestringOptional
civicNumberstringOptional
postalCodestringOptional
citystringOptional
provincestringOptional
regionstringOptional
countrystringOptional
emailstringOptional
phonestringOptional
switchToExpiredbooleanOptional

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

Default: falseExample: false
companyNamestringRequired
officeNamestringOptional
validityDatestring · date-timeOptional
statusstring · enumRead-onlyOptionalPossible values:
Responses
200
Request updated.
application/json
400
Malformed request.
application/json
401
Wrong or missing function key.
404
No debt position found.
application/json
409
Conflict: existing related payment found.
application/json
500
Service unavailable.
application/json
put
PUT /gpd/api/v1/organizations/{organizationfiscalcode}/debtpositions/{iupd} HTTP/1.1
Host: api.uat.platform.pagopa.it
Ocp-Apim-Subscription-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 633

{
  "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": "string",
      "isPartialPayment": true,
      "dueDate": "string",
      "retentionDate": "string",
      "fee": 0,
      "transfer": [
        {
          "idTransfer": "1",
          "amount": 0,
          "remittanceInformation": "string",
          "category": "string",
          "iban": "string",
          "postalIban": "string"
        }
      ]
    }
  ]
}
{
  "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": "string",
      "isPartialPayment": true,
      "dueDate": "string",
      "retentionDate": "string",
      "fee": 0,
      "transfer": [
        {
          "idTransfer": "1",
          "amount": 0,
          "remittanceInformation": "string",
          "category": "string",
          "iban": "string",
          "postalIban": "string"
        }
      ]
    }
  ]
}
DELETE /gpd/api/v1/organizations/{organizationfiscalcode}/debtpositions/{iupd} HTTP/1.1
Host: api.uat.platform.pagopa.it
Ocp-Apim-Subscription-Key: YOUR_API_KEY
Accept: */*
string
POST /gpd/api/v1/organizations/{organizationfiscalcode}/debtpositions/{iupd}/publish HTTP/1.1
Host: api.uat.platform.pagopa.it
Ocp-Apim-Subscription-Key: YOUR_API_KEY
Accept: */*
{
  "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": "string",
      "isPartialPayment": true,
      "dueDate": "string",
      "retentionDate": "string",
      "fee": 0,
      "transfer": [
        {
          "idTransfer": "1",
          "amount": 0,
          "remittanceInformation": "string",
          "category": "string",
          "iban": "string",
          "postalIban": "string"
        }
      ]
    }
  ]
}
POST /gpd/api/v1/organizations/{organizationfiscalcode}/debtpositions/{iupd}/invalidate HTTP/1.1
Host: api.uat.platform.pagopa.it
Ocp-Apim-Subscription-Key: YOUR_API_KEY
Accept: */*
{
  "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": "string",
      "isPartialPayment": true,
      "dueDate": "string",
      "retentionDate": "string",
      "fee": 0,
      "transfer": [
        {
          "idTransfer": "1",
          "amount": 0,
          "remittanceInformation": "string",
          "category": "string",
          "iban": "string",
          "postalIban": "string"
        }
      ]
    }
  ]
}