Input

Nome

Descrizione

Tipo

Opzionale

serverAddress

Indirizzo server da un Dominio esterno (per il Dominio della sessione corrente, utilizzare nullo o vuoto).

String

Y

token

Token di sessione (per la sessione corrente nel dominio corrente potrebbe essere null o vuoto).

String

Y

recipientReference

Collegamento all'identità o elemento organizzativo che riceve i pagamenti.

Reference

invoiceId

Identificativo dell'Invoice da aggiornare.

String

invoiceData

Dato strutturato contenente i dati dell'Invoice.

L'elenco dei parametri che possono essere inseriti è consultabile qui. Tra questi è disponibile default_payment_method ricavato, in ordine di priorità, in automatico:

•dal valore del paymentMethodReference;

•dal valore del default_payment_method dato in input con il dato strutturato del parametro invoiceData.

•non valorizzato se non specificato nè nel paymentMethodReference, nè nel dato strutturato del parametro invoiceData.

Nel caso il parametro default_payment_method è valorizzatoi sia in invoiceData che nel parametro paymentMethodReference, esso viene sostituito con il valore specificato in paymentMethodReference.

Dataset

Y

invoiceMetadata

Dato strutturato contenente dati aggiuntivi utili a valorizzare i metadati dell'Invoice. Non può contenere dati annidati o liste.

Può contenere massimo 50 campi, con nomi di campo lunghi fino a 40 caratteri e valori di tipo stringa lunghi fino a 500 caratteri.

Dataset

Y

paymentMethodReference

Collegamento al PaymentMethod. Esso deve essere attivo per la recipientReference.

Il parametro non è obbligatorio, in quanto può essere specificato nel parametro invoiceData, nel campo default_payment_method. Nel caso siano entrambi valorizzati, esso viene sostituito con il valore specificato in questo parametro.

Reference

Y

testMode

True se è richiesta l'esecuzione del metodo in modalità test di Stripe. Se non specificato, viene effettuata l'esecuzione del metodo in modalità live di Stripe.

La modalità testMode indicata deve essere ammessa dalla configurazione.

Boolean

Y

Output

Nome

Descrizione

Tipo

returnValue

Dato strutturato contenente le informazioni dell’Invoice aggiornata.

Dataset

Restituisce

Condizione

Errore

Se testMode è valorizzato e non è presente, per l'identità o l'elemento organizzativo a cui fa riferimento RecipientReference, una configurazione che permette la chiamata nella modalità TestMode indicata.

Errore

Se tutti i parametri invoiceData, invoiceMetadata e paymentMethodReference non sono specificati.

Errore

Se l’Invoice che si vuole aggiornare non esiste in Stripe.

Errore

Se il parametro invoiceData contiene il campo default_payment_method, ma non viene valorizzato o PaymentMethod non è presente nel Recipient.

Errore

Se il parametro paymentMethodReference riporta un collegamento ad un PaymentMethod non attivo nel Recipient.

Errore

Se l'aggiornamento richiesto non è coerente con lo stato in cui si trova l'Invoice in Stripe.