Documenti

Il path parameter token è l'identificativo univoco risultante dalla creazione di una Payment Request

Preview di un documento

Permette di ricevere la preview di uno specifico documento contenuto in una payment request precedentemente configurata

[GET] /public/paymentRequest/{token}/documents/{documentId}/preview
[GET] /paymentRequest/{token}/documents/{documentId}/preview ?

Possibili parametri:

• type: tipologia di visualizzazione voluta

Nella response l'API ritorna:

XML del documento, HTML o PDF in base alla preview richiesta

Formati disponibili per tipologia di file

	ASSOSW	ADE	ASSOSWPDF	ADEPDF	RAW	BASE64
AGYO_INVOICE	✅ Fallback	✅	✅	✅	✅	❌
DOC_STORE_DOCUMENT	❌	❌	❌	❌	✅ Fallback	✅

Se si richiede un formato non valido per la tipologia di documento richiesta, verrà applicato il formato di fallback

Nel caso di Formato BASE64, ritorna esattamente la stessa struttura del Doc Store ovvero con anteposta la stringa data:application/pdf;base64,

L'api public segue il comportamento del flag allowDownloadBeforePayment. Se impostato a false in fase di creazione richiesta, il documento non può essere mostrato prima che il pagamento sia completato. L'api autenticata, invece, permette di visionare in qualunque momento il documento in oggetto.

Download di un documento

Permette di ricevere la preview di uno specifico documento contenuto in una payment request precedentemente configurata

[GET] /public/paymentRequest/{token}/documents/{documentId}/download
[GET] /paymentRequest/{token}/documents/{documentId}/download ?

Possibili parametri:

• format: tipologia di visualizzazione voluta

Nella response l'API ritorna:

XML del documento, PDF o stringa base64 in base al formato richiesto

Formati disponibili per tipologia di file

	XML	PDF	ASSOSW	BASE64	RAW
AGYO_INVOICE	✅	✅	✅ Fallback	❌	❌
DOC_STORE_DOCUMENT	❌	❌	❌	✅	✅ Fallback

Se si richiede un formato non valido per la tipologia di documento richiesta, verrà applicato il formato di fallback

Nel caso di Formato BASE64, ritorna esattamente la stessa struttura del Doc Store ovvero in formato DataURI con anteposta la stringa data:application/pdf;base64, 

L'api public segue il comportamento del flag allowDownloadBeforePayment. Se impostato a false in fase di creazione richiesta, il documento non può essere scaricato prima che il pagamento sia completato. L'api autenticata, invece, permette di scaricare in qualunque momento il documento in oggetto.

Upload documento Payment Container tramite TS Document Store

Proxy che permette di caricare un documento su TS Document Store, senza preoccuparsi di possedere un token tecnico dedicato

[POST] /documentStore ?

Request Body (multipart/form-data):

• ownerId: ownerId con identificativo TS Digital del creditore
• transmitterId: transmitterId con identificativo TS Digital
• file: binary del file da caricare (max 10mb)

Upload documento Payment Container tramite TS Document Store (Base64)

Proxy che permette di caricare un documento su TS Document Store, senza la necessità di possedere un token tecnico dedicato.

[POST] /documentStore/base64 ?

Nella request abbiamo:

• ownerId: ownerId con identificativo TS Digital del creditore
• transmitterId: transmitterId con identificativo TS Digital
• file: base64 con formato DataURI ---> data:application/pdf;base64,file_content_in_base_64