Come sapere se l'avviso di un Messaggio è stato pagato (Funzionalità Premium)

Una volta che ti sarai assicurato che il tuo utente possa ricevere le tue comunicazioni e avrai spedito un messaggio Premium su IO con avviso di pagamento, grazie alla tua sottoscrizione potrai sapere quando il destinatario avrà saldato.

Questa informazione è accessibile tramite la stessa API che usi per conoscere lo stato di processamento del messaggio, che richiamerai utilizzando il suo identificativo univoco generato dall'API di invio.

1. Aggiungi l'header Ocp-Apim-Subscription-Key e valorizzalo con la chiave (primaria o secondaria) del tuo Servizio IO: puoi recuperarla accedendo all'Area Riservata e cercando la scheda del tuo Servizio nella pagina "Servizi"

   
2. Componi la URL di invocazione per l'API come nell'esempio: https://api.io.pagopa.it/api/v1/messages/RSRNOU70S54S000L/01GS8744E24EZDG3XD5ECXB9RG

   1. il parametro in blu è il Codice Fiscale del destinatario del messaggio

   2. il parametro in verde è l'identificativo univoco del messaggio ritornato in fase di invio

3. IO risponderà con lo stato aggiornato del messaggio:

{
"message": {
  "content": {
    "subject": "Partecipazione Evento",
    "markdown": "Gentile Mario Rossi,\n\r\n\rabbiamo accettato la tua richiesta di partecipazione all'\''evento e ti inviamo in allegato la fattura per il pagamento della tua quota (ricorda di saldarla entro il 31 marzo 2023) e la brochure con tutte le informazioni utili.\n\rA Ti aspettiamo!\n\rL'\''Amministrazione Comunale di Ipazia."
    },
    "created_at": "2023-03-16T08:17:01.775Z",
    "fiscal_code": "RSRNOU70S54S000L",
    "id": "01GS8744E24EZDG3XD5ECXB9RG",
    "sender_service_id": "01EYNQ0864HKYR1Q9PXPJ18W7G"
  },
  "notification": {
    "email": "SENT",
    "webhook": "SENT"
  },
  "status": "PROCESSED",
  "read_status": "READ",
  "paid_status": "PAID"
}

• il campo paid_status riporta lo stato di pagamento dell'avviso veicolato dal messaggio secondo quanto dettagliato nella specifica tecnica

Per il significato degli altri campi, fai riferimento al tutorial sul recupero dello stato di un messaggio

Lo stato di pagamento assumerà il valore PAID nel momento in cui il destinatario avrà saldato l'avviso utilizzando uno qualsiasi dei canali di pagamento supportati dal circuito pagoPA.