LogoLogo
SANPSACITutto il resto
SANP 3.8.0
SANP 3.8.0
  • ⬅️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
      • Stand In
    • 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 asincrone
      • Integrazione tramite API sincrone
      • 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 touchpoints di PagoPA S.p.A.
      • Integrazione standard per gli strumenti di pagamento
      • Integrazione per strumento di pagamento PayPal
      • Integrazione per strumento di pagamento tramite Redirect
      • Best practice
    • Commissioni
    • Attestazione di pagamento
    • Processo di avvio in Esercizio
    • Quality Improvement
  • 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
    • Posizioni Debitorie
      • Modello Dati
      • Stati della posizione debitoria
      • Pagamenti presso frontend dell'EC in modalità asincrona
      • Gestione Massiva
        • 📄Specifiche tracciato di input
        • ⚙️Gestione massiva tramite API REST
        • 📥Gestione massiva tramite SFTP
      • Operazioni disponibili
    • POS Fisici
  • FAQ
    • Ente Creditore
    • PSP
    • Intermediario tecnologico
Powered by GitBook
On this page
  1. Appendici
  2. Posizioni Debitorie
  3. Gestione Massiva

Gestione massiva tramite API REST

Procedura per il caricamento, la modifica e l'eliminazione massiva delle posizioni debitorie su GPD

PreviousSpecifiche tracciato di inputNextGestione massiva tramite SFTP

Last updated 10 months ago

La gestione massiva può essere innescato tramite API le cui specifiche sono riportate di seguito nel documento. Mediante l'API /brokers/{broker-code}/organizations/{organization-fiscal-code}/debtpositions/file è possibile innescare il caricamento, la modifica e l'eliminazione massiva delle posizioni debitorie presenti all'interno di un file compresso come descritto in . Il metodo in caso positivo risponde subito con un codice HTTP 202, una volta ottenuta una risposta positiva è possibile verificare lo stato dell'operazione massiva mediante l'utilizzo dell'API /brokers/{broker-code}/organizations/{organization-fiscal-code}/debtpositions/file/{fileId}/status. Per ottenere un report completo, comprensivo degli esiti per ogni posizioni debitoria, è necessario interrogare l'API /brokers/{broker-code}/organizations/{organization-fiscal-code}/debtpositions/file/{fileId}/report

Le URI che consentono di consultare lo status ed il report dell'operazione effettuata tramite caricamento sono accessibili inserendo come path param il fileID contenuto nel Location header delle risposte alle seguentiAPI POST /organizations/{organization-fiscal-code}/debtpositions/file

PUT /organizations/{organization-fiscal-code}/debtpositions/file

DELETE /organizations/{organization-fiscal-code}/debtpositions/file

"Location" : "brokers/{broker-code}/organizations/{ec-code}/debtpositions/file/{fileID}/status"

Specifiche API

⚙️

Returns the debt positions upload report.

get
Path parameters
broker-codestring · min: 1Required

The broker code

organization-fiscal-codestring · min: 1Required

The organization fiscal code

file-idstring · min: 1Required

The unique identifier for file upload

Responses
200
Upload report found.
application/json
400
Malformed request.
application/json
401
Wrong or missing function key.
application/json
403
Forbidden
application/json
404
Upload report not found.
application/json
429
Too many requests.
text/json
500
Service unavailable.
application/json
get
GET /brokers/{broker-code}/organizations/{organization-fiscal-code}/debtpositions/file/{file-id}/report HTTP/1.1
Host: 
Accept: */*
{
  "uploadID": "text",
  "processedItem": 1,
  "submittedItem": 1,
  "responses": [
    {
      "statusCode": 400,
      "statusMessage": "Bad request caused by invalid email address",
      "requestIDs": [
        "text"
      ]
    }
  ],
  "startTime": "2024-10-08T14:55:16.302Z",
  "endTime": "2024-10-08T14:55:16.302Z"
}

Returns the debt positions upload status.

get
Path parameters
broker-codestring · min: 1Required

The broker code

organization-fiscal-codestring · min: 1Required

The organization fiscal code

file-idstring · min: 1Required

The unique identifier for file upload

Responses
200
Upload found.
application/json
400
Malformed request.
application/json
401
Wrong or missing function key.
application/json
403
Forbidden
application/json
404
Upload not found.
application/json
429
Too many requests.
text/json
500
Service unavailable.
application/json
get
GET /brokers/{broker-code}/organizations/{organization-fiscal-code}/debtpositions/file/{file-id}/status HTTP/1.1
Host: 
Accept: */*
{
  "uploadID": "text",
  "processedItem": 1,
  "submittedItem": 1,
  "startTime": "2024-10-08T14:55:16.302Z"
}
  • Specifiche API
  • POSTThe Organization creates the debt positions listed in the file.
  • PUTThe Organization updates the debt positions listed in the file.
  • DELETEThe Organization deletes the debt positions based on IUPD listed in the file.
  • GETReturns the debt positions upload report.
  • GETReturns the debt positions upload status.
Specifiche tracciato di input

The Organization creates the debt positions listed in the file.

post
Path parameters
broker-codestring · min: 1Required

The broker code

organization-fiscal-codestring · min: 1Required

The organization fiscal code

Body
filestring · binaryOptional

File to be uploaded

Responses
202
Request accepted.
400
Malformed request.
application/json
401
Wrong or missing function key.
application/json
403
Forbidden
application/json
409
Conflict: duplicate file found.
application/json
429
Too many requests.
text/json
500
Service unavailable.
application/json
post
POST /brokers/{broker-code}/organizations/{organization-fiscal-code}/debtpositions/file HTTP/1.1
Host: 
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "file": "binary"
}

No content

The Organization updates the debt positions listed in the file.

put
Path parameters
broker-codestring · min: 1Required

The broker code

organization-fiscal-codestring · min: 1Required

The organization fiscal code

Body
filestring · binaryOptional

File to be uploaded

Responses
202
Request accepted.
400
Malformed request.
application/json
401
Wrong or missing function key.
application/json
403
Forbidden
application/json
409
Conflict: duplicate file found.
application/json
429
Too many requests.
text/json
500
Service unavailable.
application/json
put
PUT /brokers/{broker-code}/organizations/{organization-fiscal-code}/debtpositions/file HTTP/1.1
Host: 
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "file": "binary"
}

No content

The Organization deletes the debt positions based on IUPD listed in the file.

delete
Path parameters
broker-codestring · min: 1Required

The broker code

organization-fiscal-codestring · min: 1Required

The organization fiscal code

Body
filestring · binaryOptional

File to be uploaded

Responses
202
Request accepted.
400
Malformed request.
application/json
401
Wrong or missing function key.
application/json
403
Forbidden
application/json
409
Conflict: duplicate file found.
application/json
429
Too many requests.
text/json
500
Service unavailable.
application/json
delete
DELETE /brokers/{broker-code}/organizations/{organization-fiscal-code}/debtpositions/file HTTP/1.1
Host: 
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "file": "binary"
}

No content