<< Fare clic per visualizzazione il sommario >> Percorso: API di piattaforma > JamioPlug > JamioPlug StripeConnect > Invoice > PayInvoice |
Riscuote un'Invoice nella piattaforma di pagamento Stripe.
Metodo
PlugStripeConnect/FinalizeInvoice
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 riscuotere. |
String |
|
invoiceData |
Dato strutturato contenente i dati dell'Invoice. L'elenco dei parametri che possono essere inseriti è consultabile qui. |
Dataset |
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. |
Dataset |
|
Commenti
Per poter eseguire la riscossione dell'Invoice, il metodo di pagamento specificato nell'Invoice non deve richiedere ulteriori azioni da parte dell'utente interattivo per poter essere effettuato. Ad esempio i metodi di pagamento con autenticazione 3D Secure richiedono all'utente un livello aggiuntivo di autenticazione. Se tali metodi sono specificati nel default_payment_metodh dell'Invoice, il metodo PayInvoice non eseguirà la riscossione fino a che l'utente interattivo non avrà effettuato l'autenticazione richiesta.
Il metodo si comporta come segue:
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 l’Invoice che si vuole riscuotere non esiste in Stripe. |
Autorizzazioni
Per eseguire il metodo è necessario possedere il permesso di Utilizzo sulla configurazione del Plug Stripe Connect.