com.stripe.param

Class SourceUpdateParams.Mandate.Builder

java.lang.Object

com.stripe.param.SourceUpdateParams.Mandate.Builder

Enclosing class:

SourceUpdateParams.Mandate

public static class SourceUpdateParams.Mandate.Builder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SourceUpdateParams.Mandate	build() Finalize and obtain parameter instance from this builder.
SourceUpdateParams.Mandate.Builder	putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map) Add all map key/value pairs to `extraParams` map.
SourceUpdateParams.Mandate.Builder	putExtraParam(java.lang.String key, java.lang.Object value) Add a key/value pair to `extraParams` map.
SourceUpdateParams.Mandate.Builder	setAcceptance(SourceUpdateParams.Mandate.Acceptance acceptance) The parameters required to notify Stripe of a mandate acceptance or refusal by the customer.
SourceUpdateParams.Mandate.Builder	setAmount(EmptyParam amount) The amount specified by the mandate.
SourceUpdateParams.Mandate.Builder	setAmount(java.lang.Long amount) The amount specified by the mandate.
SourceUpdateParams.Mandate.Builder	setCurrency(java.lang.String currency) The currency specified by the mandate.
SourceUpdateParams.Mandate.Builder	setInterval(SourceUpdateParams.Mandate.Interval interval) The interval of debits permitted by the mandate.
SourceUpdateParams.Mandate.Builder	setNotificationMethod(SourceUpdateParams.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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

build

public SourceUpdateParams.Mandate build()

Finalize and obtain parameter instance from this builder.

setAcceptance

public SourceUpdateParams.Mandate.Builder setAcceptance(SourceUpdateParams.Mandate.Acceptance acceptance)

The parameters required to notify Stripe of a mandate acceptance or refusal by the customer.

setAmount

public SourceUpdateParams.Mandate.Builder setAmount(EmptyParam amount)

The amount specified by the mandate. (Leave null for a mandate covering all amounts)

setAmount

public SourceUpdateParams.Mandate.Builder setAmount(java.lang.Long amount)

The amount specified by the mandate. (Leave null for a mandate covering all amounts)

setCurrency

public SourceUpdateParams.Mandate.Builder setCurrency(java.lang.String currency)

The currency specified by the mandate. (Must match `currency` of the source)

putExtraParam

public SourceUpdateParams.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. See SourceUpdateParams.Mandate.extraParams for the field documentation.

putAllExtraParam

public SourceUpdateParams.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. See SourceUpdateParams.Mandate.extraParams for the field documentation.

setInterval

public SourceUpdateParams.Mandate.Builder setInterval(SourceUpdateParams.Mandate.Interval interval)

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)

setNotificationMethod

public SourceUpdateParams.Mandate.Builder setNotificationMethod(SourceUpdateParams.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. 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).