Package com.stripe.param
Class SourceCreateParams.Mandate.Builder
- java.lang.Object
-
- com.stripe.param.SourceCreateParams.Mandate.Builder
-
- Enclosing class:
- SourceCreateParams.Mandate
public static class SourceCreateParams.Mandate.Builder extends java.lang.Object
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SourceCreateParams.Mandate
build()
Finalize and obtain parameter instance from this builder.SourceCreateParams.Mandate.Builder
putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map)
Add all map key/value pairs to `extraParams` map.SourceCreateParams.Mandate.Builder
putExtraParam(java.lang.String key, java.lang.Object value)
Add a key/value pair to `extraParams` map.SourceCreateParams.Mandate.Builder
setAcceptance(SourceCreateParams.Mandate.Acceptance acceptance)
The parameters required to notify Stripe of a mandate acceptance or refusal by the customer.SourceCreateParams.Mandate.Builder
setAmount(EmptyParam amount)
The amount specified by the mandate.SourceCreateParams.Mandate.Builder
setAmount(java.lang.Long amount)
The amount specified by the mandate.SourceCreateParams.Mandate.Builder
setCurrency(java.lang.String currency)
The currency specified by the mandate.SourceCreateParams.Mandate.Builder
setInterval(SourceCreateParams.Mandate.Interval interval)
The interval of debits permitted by the mandate.SourceCreateParams.Mandate.Builder
setNotificationMethod(SourceCreateParams.Mandate.NotificationMethod notificationMethod)
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 Detail
-
build
public SourceCreateParams.Mandate build()
Finalize and obtain parameter instance from this builder.
-
setAcceptance
public SourceCreateParams.Mandate.Builder setAcceptance(SourceCreateParams.Mandate.Acceptance acceptance)
The parameters required to notify Stripe of a mandate acceptance or refusal by the customer.
-
setAmount
public SourceCreateParams.Mandate.Builder setAmount(java.lang.Long amount)
The amount specified by the mandate. (Leave null for a mandate covering all amounts)
-
setAmount
public SourceCreateParams.Mandate.Builder setAmount(EmptyParam amount)
The amount specified by the mandate. (Leave null for a mandate covering all amounts)
-
setCurrency
public SourceCreateParams.Mandate.Builder setCurrency(java.lang.String currency)
The currency specified by the mandate. (Must matchcurrency
of the source)
-
putExtraParam
public SourceCreateParams.Mandate.Builder putExtraParam(java.lang.String key, java.lang.Object value)
Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. SeeSourceCreateParams.Mandate.extraParams
for the field documentation.
-
putAllExtraParam
public SourceCreateParams.Mandate.Builder putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map)
Add all map key/value pairs to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. SeeSourceCreateParams.Mandate.extraParams
for the field documentation.
-
setInterval
public SourceCreateParams.Mandate.Builder setInterval(SourceCreateParams.Mandate.Interval interval)
The interval of debits permitted by the mandate. Eitherone_time
(just permitting a single debit),scheduled
(with debits on an agreed schedule or for clearly-defined events), orvariable
(for debits with any frequency)
-
setNotificationMethod
public SourceCreateParams.Mandate.Builder setNotificationMethod(SourceCreateParams.Mandate.NotificationMethod notificationMethod)
The method Stripe should use to notify the customer of upcoming debit instructions and/or mandate confirmation as required by the underlying debit network. Eitheremail
(an email is sent directly to the customer),manual
(asource.mandate_notification
event is sent to your webhooks endpoint and you should handle the notification) ornone
(the underlying debit network does not require any notification).
-
-