Package com.stripe.param
Class SetupIntentConfirmParams.PaymentMethodOptions.Card.MandateOptions.Builder
java.lang.Object
com.stripe.param.SetupIntentConfirmParams.PaymentMethodOptions.Card.MandateOptions.Builder
- Enclosing class:
- SetupIntentConfirmParams.PaymentMethodOptions.Card.MandateOptions
public static class SetupIntentConfirmParams.PaymentMethodOptions.Card.MandateOptions.Builder
extends Object
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddAllSupportedType
(List<SetupIntentConfirmParams.PaymentMethodOptions.Card.MandateOptions.SupportedType> elements) Add all elements to `supportedTypes` list.addSupportedType
(SetupIntentConfirmParams.PaymentMethodOptions.Card.MandateOptions.SupportedType element) Add an element to `supportedTypes` list.build()
Finalize and obtain parameter instance from this builder.putAllExtraParam
(Map<String, Object> map) Add all map key/value pairs to `extraParams` map.putExtraParam
(String key, Object value) Add a key/value pair to `extraParams` map.Required. Amount to be charged for future payments.setAmountType
(SetupIntentConfirmParams.PaymentMethodOptions.Card.MandateOptions.AmountType amountType) Required. One offixed
ormaximum
.setCurrency
(String currency) Required. Currency in which future payments will be charged.setDescription
(String description) A description of the mandate or subscription that is meant to be displayed to the customer.setEndDate
(Long endDate) End date of the mandate or subscription.Required. Specifies payment frequency.setIntervalCount
(Long intervalCount) The number of intervals between payments.setReference
(String reference) Required. Unique identifier for the mandate or subscription.setStartDate
(Long startDate) Required. Start date of the mandate or subscription.
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
build
Finalize and obtain parameter instance from this builder. -
setAmount
public SetupIntentConfirmParams.PaymentMethodOptions.Card.MandateOptions.Builder setAmount(Long amount) Required. Amount to be charged for future payments. -
setAmountType
public SetupIntentConfirmParams.PaymentMethodOptions.Card.MandateOptions.Builder setAmountType(SetupIntentConfirmParams.PaymentMethodOptions.Card.MandateOptions.AmountType amountType) Required. One offixed
ormaximum
. Iffixed
, theamount
param refers to the exact amount to be charged in future payments. Ifmaximum
, the amount charged can be up to the value passed for theamount
param. -
setCurrency
public SetupIntentConfirmParams.PaymentMethodOptions.Card.MandateOptions.Builder setCurrency(String currency) Required. Currency in which future payments will be charged. Three-letter ISO currency code, in lowercase. Must be a supported currency. -
setDescription
public SetupIntentConfirmParams.PaymentMethodOptions.Card.MandateOptions.Builder setDescription(String description) A description of the mandate or subscription that is meant to be displayed to the customer. -
setEndDate
public SetupIntentConfirmParams.PaymentMethodOptions.Card.MandateOptions.Builder setEndDate(Long endDate) End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date. -
putExtraParam
public SetupIntentConfirmParams.PaymentMethodOptions.Card.MandateOptions.Builder putExtraParam(String key, 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. SeeSetupIntentConfirmParams.PaymentMethodOptions.Card.MandateOptions.extraParams
for the field documentation. -
putAllExtraParam
public SetupIntentConfirmParams.PaymentMethodOptions.Card.MandateOptions.Builder putAllExtraParam(Map<String, 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. SeeSetupIntentConfirmParams.PaymentMethodOptions.Card.MandateOptions.extraParams
for the field documentation. -
setInterval
public SetupIntentConfirmParams.PaymentMethodOptions.Card.MandateOptions.Builder setInterval(SetupIntentConfirmParams.PaymentMethodOptions.Card.MandateOptions.Interval interval) Required. Specifies payment frequency. One ofday
,week
,month
,year
, orsporadic
. -
setIntervalCount
public SetupIntentConfirmParams.PaymentMethodOptions.Card.MandateOptions.Builder setIntervalCount(Long intervalCount) The number of intervals between payments. For example,interval=month
andinterval_count=3
indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional wheninterval=sporadic
. -
setReference
public SetupIntentConfirmParams.PaymentMethodOptions.Card.MandateOptions.Builder setReference(String reference) Required. Unique identifier for the mandate or subscription. -
setStartDate
public SetupIntentConfirmParams.PaymentMethodOptions.Card.MandateOptions.Builder setStartDate(Long startDate) Required. Start date of the mandate or subscription. Start date should not be lesser than yesterday. -
addSupportedType
public SetupIntentConfirmParams.PaymentMethodOptions.Card.MandateOptions.Builder addSupportedType(SetupIntentConfirmParams.PaymentMethodOptions.Card.MandateOptions.SupportedType element) Add an element to `supportedTypes` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. SeeSetupIntentConfirmParams.PaymentMethodOptions.Card.MandateOptions.supportedTypes
for the field documentation. -
addAllSupportedType
public SetupIntentConfirmParams.PaymentMethodOptions.Card.MandateOptions.Builder addAllSupportedType(List<SetupIntentConfirmParams.PaymentMethodOptions.Card.MandateOptions.SupportedType> elements) Add all elements to `supportedTypes` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. SeeSetupIntentConfirmParams.PaymentMethodOptions.Card.MandateOptions.supportedTypes
for the field documentation.
-