Package com.stripe.param

Class SourceCreateParams.Mandate

java.lang.Object

com.stripe.param.SourceCreateParams.Mandate

Enclosing class:

SourceCreateParams

public static class SourceCreateParams.Mandate
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SourceCreateParams.Mandate.Acceptance
static class	SourceCreateParams.Mandate.Builder
static enum	SourceCreateParams.Mandate.Interval
static enum	SourceCreateParams.Mandate.NotificationMethod

Method Summary

Modifier and Type	Method	Description
static SourceCreateParams.Mandate.Builder	builder()
SourceCreateParams.Mandate.Acceptance	getAcceptance()	The parameters required to notify Stripe of a mandate acceptance or refusal by the customer.
Object	getAmount()	The amount specified by the mandate.
String	getCurrency()	The currency specified by the mandate.
Map<String,Object>	getExtraParams()	Map of extra parameters for custom features not available in this client library.
SourceCreateParams.Mandate.Interval	getInterval()	The interval of debits permitted by the mandate.
SourceCreateParams.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.

Methods inherited from class java.lang.Object

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

Method Details

builder

public static SourceCreateParams.Mandate.Builder builder()

getAcceptance

public SourceCreateParams.Mandate.Acceptance getAcceptance()

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

getAmount

public Object getAmount()

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

getCurrency

public String getCurrency()

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

getExtraParams

public Map<String,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

public SourceCreateParams.Mandate.Interval 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

public SourceCreateParams.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. 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).