Package com.stripe.param
Class SourceUpdateParams.Mandate
java.lang.Object
com.stripe.param.SourceUpdateParams.Mandate
- Enclosing class:
- SourceUpdateParams
public static class SourceUpdateParams.Mandate
extends java.lang.Object
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SourceUpdateParams.Mandate.Acceptance
static class
SourceUpdateParams.Mandate.Builder
static class
SourceUpdateParams.Mandate.Interval
static class
SourceUpdateParams.Mandate.NotificationMethod
-
Method Summary
Modifier and Type Method Description static SourceUpdateParams.Mandate.Builder
builder()
SourceUpdateParams.Mandate.Acceptance
getAcceptance()
The parameters required to notify Stripe of a mandate acceptance or refusal by the customer.java.lang.Object
getAmount()
The amount specified by the mandate.java.lang.Object
getCurrency()
The currency specified by the mandate.java.util.Map<java.lang.String,java.lang.Object>
getExtraParams()
Map of extra parameters for custom features not available in this client library.SourceUpdateParams.Mandate.Interval
getInterval()
The interval of debits permitted by the mandate.SourceUpdateParams.Mandate.NotificationMethod
getNotificationMethod()
The method Stripe should use to notify the customer of upcoming debit instructions and/or mandate confirmation as required by the underlying debit network.
-
Method Details
-
builder
-
getAcceptance
The parameters required to notify Stripe of a mandate acceptance or refusal by the customer. -
getAmount
public java.lang.Object getAmount()The amount specified by the mandate. (Leave null for a mandate covering all amounts) -
getCurrency
public java.lang.Object getCurrency()The currency specified by the mandate. (Must match `currency` of the source) -
getExtraParams
public java.util.Map<java.lang.String,java.lang.Object> getExtraParams()Map of extra parameters for custom features not available in this client library. The content in this map is not serialized under this field's@SerializedName
value. Instead, each key/value pair is serialized as if the key is a root-level field (serialized) name in this param object. Effectively, this map is flattened to its parent instance. -
getInterval
The interval of debits permitted by the mandate. Either `one_time` (just permitting a single debit), `scheduled` (with debits on an agreed schedule or for clearly-defined events), or `variable`(for debits with any frequency) -
getNotificationMethod
The method Stripe should use to notify the customer of upcoming debit instructions and/or mandate confirmation as required by the underlying debit network. Either `email` (an email is sent directly to the customer), `manual` (a `source.mandate_notification` event is sent to your webhooks endpoint and you should handle the notification) or `none` (the underlying debit network does not require any notification).
-