Operazioni disponibili

Tutte le operazioni indicate sono segregate per codice fiscale dell'ente creditore (organizationfiscalcode).

In caso di intermediazione, è possibile associare alla subscription key dell'intermediario da 1 ad n codici fiscali di enti intermediati, ciò consente agli intermediari di utilizzare una sola subscription key per l'invocazione delle API per conto di tutti gli enti intermediati. Tali abilitazioni devono essere richieste a PagoPA contestualmente alla creazione della subscription key o in momenti successivi.

Le subscription key e le relative abilitazioni sono segregate per ambiente UAT/PROD.

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/blob/SANP3.7.0/openapi

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, IUV e fiscalCode)

Il query parameter toPublish consente di pubblicare automaticamente una posizione debitoria in fase di creazione, impostando questo parametro a true e valorizzando contestualmente a null il campo validityDate, la posizione debitoria andrà direttamente nello stato VALID pronta per essere pagata.

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)

E' importante porre particolare attenzione al campo notificationFee che contiene le spese di notifica della posizione debitoria. Questo campo viene gestito in modo esclusivo da Piattaforma Notifiche e l'eventuale importo viene aggiunto automaticamente dal sistema GPD all'importo delle posizioni debitorie. L'EC pertanto in fase di aggiornamento dell'importo amount di uno dei transfer presenti all'interno di una paymentOption, non dovrà tenere conto del valore presente all'interno del campo notificationFee.

Cancellazione di una Posizione Debitoria

The Organization deletes a debt position

delete

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

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: */*

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

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.

Ricevute di pagamento

Sono messe a disposizione due API per il recupero delle ricevute di pagamento:

lista ricevute di pagamento
dettaglio singola ricevuta

Return the list of the organization receipts.

get

Authorizations

Path parameters

organizationfiscalcodestringRequired

Organization fiscal code, the fiscal code of the Organization.

Query parameters

pageNuminteger · int32Required

Page number

pageSizeinteger · int32 · max: 100Optional

Number of elements per page. Default = 50

Default: 50

debtorstringOptional

Filter by debtor

servicestringOptional

Filter by service

fromstringOptional

Filter by date, from this date

tostringOptional

Filter by date, to this date

segregationCodesstringOptional

Segregation codes for which broker is authorized

Pattern: \d{2}(,\d{2})*

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

401

Wrong or missing function key.

404

No receipts found.

application/json

500

Service unavailable.

application/json

get

GET /gpd/debt-positions-service/v1/payments/{organizationfiscalcode}/receipts HTTP/1.1
Host: api.uat.platform.pagopa.it
Ocp-Apim-Subscription-Key: YOUR_API_KEY
Accept: */*

{
  "receipts_list": [
    {
      "organizationFiscalCode": "text",
      "iuv": "text",
      "debtor": "text",
      "paymentDateTime": "text",
      "status": "text"
    }
  ]
}

Return the details of a specific receipt.

get

Authorizations

Path parameters

organizationfiscalcodestringRequired

Organization fiscal code, the fiscal code of the Organization.

Example: 12345

iuvstringRequired

IUV (Unique Payment Identification). Alphanumeric code that uniquely associates and identifies three key elements of a payment: reason, payer, amount

Example: ABC123

Query parameters

segregationCodesstringOptional

Segregation codes for which broker is authorized

Pattern: \d{2}(,\d{2})*

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 receipt details.

application/xml

Responsestring

401

Wrong or missing function key.

404

No receipt found.

422

Unable to process the request.

500

Service unavailable.

application/json

get

GET /gpd/debt-positions-service/v1/payments/{organizationfiscalcode}/receipts/{iuv} HTTP/1.1
Host: api.uat.platform.pagopa.it
Ocp-Apim-Subscription-Key: YOUR_API_KEY
Accept: */*

<?xml version="1.0"?>
<object>text</object>

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

L'abilitazione al servizio per la gestione dei flussi di rendicontazione su GPD non è automatico e va richiesto esplicitamente al momento dell'on-boarding dell'EC

PreviousCaricamento massivo NextPOS Fisici

Last updated 1 year ago

{ "payment_position_list": [ { "iupd": "text", "organizationFiscalCode": "text", "type": "F", "companyName": "text", "officeName": "text", "insertedDate": "2025-05-29T21:15:28.326Z", "publishDate": "2025-05-29T21:15:28.326Z", "validityDate": "2025-05-29T21:15:28.326Z", "paymentDate": "2025-05-29T21:15:28.326Z", "status": "DRAFT", "lastUpdatedDate": "2025-05-29T21:15:28.326Z", "paymentOption": [ { "nav": "text", "iuv": "text", "organizationFiscalCode": "text", "amount": 1, "description": "text", "isPartialPayment": true, "dueDate": "2025-05-29T21:15:28.326Z", "retentionDate": "2025-05-29T21:15:28.326Z", "paymentDate": "2025-05-29T21:15:28.326Z", "reportingDate": "2025-05-29T21:15:28.326Z", "insertedDate": "2025-05-29T21:15:28.326Z", "paymentMethod": "text", "fee": 1, "notificationFee": 1, "pspCompany": "text", "idReceipt": "text", "idFlowReporting": "text", "status": "PO_UNPAID", "lastUpdatedDate": "2025-05-29T21:15:28.326Z", "transfer": [ { "organizationFiscalCode": "text", "idTransfer": "text", "amount": 1, "remittanceInformation": "text", "category": "text", "iban": "text", "postalIban": "text", "stamp": { "hashDocument": "text", "stampType": "text", "provincialResidence": "RM" }, "insertedDate": "2025-05-29T21:15:28.326Z", "status": "T_UNREPORTED", "lastUpdatedDate": "2025-05-29T21:15:28.326Z" } ] } ] } ], "page_info": { "page": 1, "limit": 1, "items_found": 1, "total_pages": 1 } }

{ "iupd": "text", "organizationFiscalCode": "text", "type": "F", "companyName": "text", "officeName": "text", "insertedDate": "2025-05-29T21:15:28.326Z", "publishDate": "2025-05-29T21:15:28.326Z", "validityDate": "2025-05-29T21:15:28.326Z", "paymentDate": "2025-05-29T21:15:28.326Z", "status": "DRAFT", "lastUpdatedDate": "2025-05-29T21:15:28.326Z", "paymentOption": [ { "nav": "text", "iuv": "text", "organizationFiscalCode": "text", "amount": 1, "description": "text", "isPartialPayment": true, "dueDate": "2025-05-29T21:15:28.326Z", "retentionDate": "2025-05-29T21:15:28.326Z", "paymentDate": "2025-05-29T21:15:28.326Z", "reportingDate": "2025-05-29T21:15:28.326Z", "insertedDate": "2025-05-29T21:15:28.326Z", "paymentMethod": "text", "fee": 1, "notificationFee": 1, "pspCompany": "text", "idReceipt": "text", "idFlowReporting": "text", "status": "PO_UNPAID", "lastUpdatedDate": "2025-05-29T21:15:28.326Z", "transfer": [ { "organizationFiscalCode": "text", "idTransfer": "text", "amount": 1, "remittanceInformation": "text", "category": "text", "iban": "text", "postalIban": "text", "stamp": { "hashDocument": "text", "stampType": "text", "provincialResidence": "RM" }, "insertedDate": "2025-05-29T21:15:28.326Z", "status": "T_UNREPORTED", "lastUpdatedDate": "2025-05-29T21:15:28.326Z" } ] } ] }

{ "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": "2025-05-29T21:15:28.326Z", "paymentDate": "2025-05-29T21:15:28.326Z", "status": "DRAFT", "paymentOption": [ { "nav": "text", "iuv": "text", "amount": 1, "description": "text", "isPartialPayment": true, "dueDate": "2025-05-29T21:15:28.326Z", "retentionDate": "2025-05-29T21:15:28.326Z", "fee": 1, "notificationFee": 1, "transfer": [ { "idTransfer": "1", "amount": 1, "organizationFiscalCode": "00000000000", "remittanceInformation": "text", "category": "text", "iban": "IT0000000000000000000000000", "postalIban": "IT0000000000000000000000000", "stamp": { "hashDocument": "text", "stampType": "text", "provincialResidence": "RM" } } ] } ] }

POST /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: 793 { "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": "2025-05-29T21:15:28.326Z", "paymentOption": [ { "iuv": "text", "amount": 1, "description": "text", "isPartialPayment": true, "dueDate": "2025-05-29T21:15:28.326Z", "retentionDate": "2025-05-29T21:15:28.326Z", "fee": 1, "transfer": [ { "idTransfer": "1", "amount": 1, "organizationFiscalCode": "00000000000", "remittanceInformation": "text", "category": "text", "iban": "IT0000000000000000000000000", "postalIban": "IT0000000000000000000000000", "stamp": { "hashDocument": "text", "stampType": "text", "provincialResidence": "RM" } } ] } ] }

PUT /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: 793 { "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": "2025-05-29T21:15:28.326Z", "paymentOption": [ { "iuv": "text", "amount": 1, "description": "text", "isPartialPayment": true, "dueDate": "2025-05-29T21:15:28.326Z", "retentionDate": "2025-05-29T21:15:28.326Z", "fee": 1, "transfer": [ { "idTransfer": "1", "amount": 1, "organizationFiscalCode": "00000000000", "remittanceInformation": "text", "category": "text", "iban": "IT0000000000000000000000000", "postalIban": "IT0000000000000000000000000", "stamp": { "hashDocument": "text", "stampType": "text", "provincialResidence": "RM" } } ] } ] }