# PagoPA Purposes API

**Canonical:** https://apis.io/apis/pagopa/pagopa-purposes-api/  
**Provider:** PagoPA — https://apis.io/providers/pagopa/  
**Base URL:** https://api.platform.pagopa.it/bizevents/service/v1  
**Documentation:** https://developer.pagopa.it/it/pago-pa/api/recupero-receipt

PagoPA Purposes API is one of 83 APIs that [PagoPA](https://apis.io/providers/pagopa/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 96 JSON Schema definitions. Tagged areas include purposes. The published artifact set on APIs.io includes an OpenAPI specification and 96 JSON Schemas.

Purposes routes

## Operations (20)

| Method | Path | Summary |
|---|---|---|
| POST | `/purposes` | Create a new Purpose |
| GET | `/purposes` | List Purposes |
| GET | `/purposes/{purposeId}` | Retrieve a Purpose |
| DELETE | `/purposes/{purposeId}` | Delete Purpose |
| PATCH | `/purposes/{purposeId}` | Update a Draft Purpose |
| GET | `/purposes/{purposeId}/versions` | List Purpose Versions |
| POST | `/purposes/{purposeId}/versions` | Create a new Purpose Version |
| GET | `/purposes/{purposeId}/versions/{versionId}` | Retrieve a Purpose Version |
| DELETE | `/purposes/{purposeId}/versions/{versionId}` | Delete a Purpose Version |
| POST | `/purposes/{purposeId}/activate` | Activate a Purpose in Draft state |
| POST | `/purposes/{purposeId}/archive` | Archive a Purpose in Active or Suspended state |
| POST | `/purposes/{purposeId}/approve` | Approve a Purpose in Waiting for Approval state |
| POST | `/purposes/{purposeId}/suspend` | Suspend a Purpose in Active or Suspended state |
| POST | `/purposes/{purposeId}/unsuspend` | Unsuspend a Purpose in Suspended state |
| POST | `/reversePurposes` | Create a new reverse Purpose |
| PATCH | `/reversePurposes/{purposeId}` | Update a Draft reverse Purpose |
| GET | `/purposes/{purposeId}/versions/{versionId}/riskAnalysisDocument` | Download a Purpose Risk Analysis Document |
| GET | `/purposes/{purposeId}/agreement` | Retrieve a Purpose Agreement |
| GET | `/purposes/{purposeId}/remainingDailyCalls` | Retrieve remaining dailyCalls for a purpose |
| POST | `/purposeTemplates/{purposeTemplateId}/purposes` | Create a new Purpose from a Purpose Template |

## Machine-readable artifacts (97)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/openapi/pagopa-purposes-api-openapi.yml
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-ct-receipt-model-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-cart-request-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-get-cart-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-get-mbd-request-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-get-mdb-receipt-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-create-mbd-request-v2-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-single-flow-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-paginated-payments-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-paginated-flows-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-create-flow-request-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-single-flow-created-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-paginated-flows-published-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-paginated-flows-created-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-payment-position-model-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-payments-model-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-payment-position-model-base-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-payment-positions-info-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-app-info-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-already-paid-payment-option-model-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-file-id-list-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-upload-report-dto-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-upload-status-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-update-transfer-iban-massive-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-payment-position-model-v3-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-payment-position-model-response-v3-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-payment-positions-info-v3-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-flow-list-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-upload-report-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-receipts-info-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-broker-institutions-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-ciibans-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-payment-options-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-new-debt-position-request-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-debt-position-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-get-generation-request-status-resource-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-template-resource-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-notice-generation-request-item-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-notice-generation-massive-request-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-notice-generation-massive-resource-schema.json
- …and 57 more, listed in full on the page.

## Other PagoPA APIs (12)

- [pagoPA - Nodo dei Pagamenti SOAP interfaces](https://apis.io/apis/pagopa/pagopa-nodo-dei-pagamenti-soap-interfaces/)
- [PagoPA ACA API](https://apis.io/apis/pagopa/pagopa-aca-api/)
- [PagoPA Activations API](https://apis.io/apis/pagopa/pagopa-activations-api/)
- [PagoPA Agreements API](https://apis.io/apis/pagopa/pagopa-agreements-api/)
- [PagoPA Attributes API](https://apis.io/apis/pagopa/pagopa-attributes-api/)
- [PagoPA b2b - pagoPA side API](https://apis.io/apis/pagopa/pagopa-b2b-pagopa-side-api/)
- [PagoPA Callback API](https://apis.io/apis/pagopa/pagopa-callback-api/)
- [PagoPA Callback Cancel API](https://apis.io/apis/pagopa/pagopa-callback-cancel-api/)
- [PagoPA Carts API](https://apis.io/apis/pagopa/pagopa-carts-api/)
- [PagoPA Check API](https://apis.io/apis/pagopa/pagopa-check-api/)
- [PagoPA Citizen operation API](https://apis.io/apis/pagopa/pagopa-citizen-operation-api/)
- [PagoPA Clients API](https://apis.io/apis/pagopa/pagopa-clients-api/)

## Tags

purposes

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/pagopa/pagopa-purposes-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/pagopa/.