Table of contents
Available operations
Debt position management
In the following sequence diagrams, the acronym GPD is used to identify the Debt position management service and APD is used for Debt position management (database).
For details see https://github.com/pagopa/pagopa-api/tree/SANP3.7.1/openapi
Creating a debt position
.png)
When creating the debt position, the service will check the input data and check for duplicates.
The input data checks include:
- compulsoriness of the data
- coherence of the dates (for example due_date ≥ validity_date)
- coherence of the amounts (for example the sum of the payment amounts must be equal to the total amount)
- validity of the taxonomy
- IBAN validity (must be recorded on the pagoPA platform)
The check for duplicates is based on the payment identifiers (IUPD, IUV and fiscalCode)
The query parameter toPublish makes it possible to automatically publish a debt position when it is created, by setting this parameter to true and also entering null in the validityDate field, the debt position will be automatically set to the VALID state and be ready to be paid.
Reading a list of debt positions and a single debt position
.png)
Reading a list of debt positions always requires pagination. It is also possible to filter by due_date to limit the results.
.png)
Reading a debt position is based on the input identifier (IUPD). If the IUPD does not exist, an error is output.
Updating a debt position
.png)
During the update phase, in addition to the already mentioned checks during creation, a check is made that the position exists and can be updated.
In particular, the updatability of the debt position depends on the state of the position itself (for example, if a position was already paid it cannot be updated)
Canceling a debt position
.png)
Canceling a debt position requires checking both its existence (IUPD) and state (for example, a debt position cannot be canceled if it was already paid)
Publishing a debt position
post
Parameters
.png)
Publishing a debt position makes it possible to switch from the DRAFT state to the PUBLISHED. state.
The DRAFT state does not in fact permit normal operations with the pagoPA platform. Only when the creditor publishes the position, and in coherence with the validity and expiration date, can it be paid on the platform.
Invalidating a debt position
post
Parameters
The invalidation of a debt position consists of a logical cancellation. It is possible only starting from the PUBLISHED and VALID states.
The function is useful if you want to indicate to the user, during the payment phase, that the debt position was invalidated.
Payment receipts
Two APIs are available for recovering the payment receipts:
- payment receipt list
- single receipt details
get
get
Reporting flows
Functions for reading the reporting flows are made available.
- List of reporting flows for a Creditor
- Details of the reporting flow
get
Parameters
get
Parameters
Tell us what you think
For clarifications on implementation specifications, such as SACI and SANP, you can open an issue on GitHub