<< Fare clic per visualizzazione il sommario >> Percorso: API di piattaforma > JamioPlug > JamioPlug StripeConnect > PaymentMethod > DetachPaymentMethodById |
Elimina la possibilità di utilizzare un PaymentMethod tra una customerReference e una recipientReference, dato il suo identificativo.
Metodo
PlugStripeConnect/DetachPaymentMethodById
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 |
customerReference |
Collegamento all'identità che effettua il pagamento. |
Reference |
|
recipientReference |
Collegamento all'identità o elemento organizzativo che riceve i pagamenti. |
Reference |
|
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 |
paymentMethodId |
Identificativo Stripe del PaymentMethod che si vuole disabilitare. |
String |
|
Output |
|
||
Nome |
Descrizione |
Tipo |
|
returnValue |
Dato strutturato che contiene il PaymentMethod rimosso. |
Dataset |
|
Commenti
Il Customer, cui fa riferimento il parametro customerReference, deve essere associato al Recipient, cui fa riferimento il parametro recipientReference, nella modalità test prevista.
Per poter utilizzare il metodo, il paymentMethodId deve riferirsi ad un metodo di pagamento attivo tra la customerReference e la recipientReference. Una volta rimosso, il metodo di pagamento non può essere nuovamente utilizzato o riattivato tra la customerReference e la recipientReference e dovrà essere inserito un nuovo metodo di pagamento.
La customerReference deve essere associata ad un Recipient nella modalità test prevista..
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 il parametro paymentMethodId contiene l'identificativo di un metodo di pagamento non attivo tra la customerReference e la recipientReference. |
Errore |
Se customerReference non è associata al Recipient cui fa riferimento il parametro recipientReference. |
Errore |
Se customerReference è associata al Recipient cui fa riferimento il parametro recipientReference. ma il Customer non è presente in Stripe. |
Autorizzazioni
Per eseguire il metodo è necessario possedere il permesso di Utilizzo sulla configurazione del Plug Stripe Connect.