Package com.stripe.param.checkout

Class SessionCreateParams.PaymentMethodOptions.Payto.MandateOptions.Builder

java.lang.Object

com.stripe.param.checkout.SessionCreateParams.PaymentMethodOptions.Payto.MandateOptions.Builder

Enclosing class:

SessionCreateParams.PaymentMethodOptions.Payto.MandateOptions

public static class SessionCreateParams.PaymentMethodOptions.Payto.MandateOptions.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SessionCreateParams.PaymentMethodOptions.Payto.MandateOptions	build()	Finalize and obtain parameter instance from this builder.
SessionCreateParams.PaymentMethodOptions.Payto.MandateOptions.Builder	putAllExtraParam(Map<String,Object> map)	Add all map key/value pairs to `extraParams` map.
SessionCreateParams.PaymentMethodOptions.Payto.MandateOptions.Builder	putExtraParam(String key, Object value)	Add a key/value pair to `extraParams` map.
SessionCreateParams.PaymentMethodOptions.Payto.MandateOptions.Builder	setAmount(Long amount)	Amount that will be collected.
SessionCreateParams.PaymentMethodOptions.Payto.MandateOptions.Builder	setAmountType(SessionCreateParams.PaymentMethodOptions.Payto.MandateOptions.AmountType amountType)	The type of amount that will be collected.
SessionCreateParams.PaymentMethodOptions.Payto.MandateOptions.Builder	setEndDate(String endDate)	Date, in YYYY-MM-DD format, after which payments will not be collected.
SessionCreateParams.PaymentMethodOptions.Payto.MandateOptions.Builder	setPaymentSchedule(SessionCreateParams.PaymentMethodOptions.Payto.MandateOptions.PaymentSchedule paymentSchedule)	The periodicity at which payments will be collected.
SessionCreateParams.PaymentMethodOptions.Payto.MandateOptions.Builder	setPaymentsPerPeriod(Long paymentsPerPeriod)	The number of payments that will be made during a payment period.
SessionCreateParams.PaymentMethodOptions.Payto.MandateOptions.Builder	setPurpose(SessionCreateParams.PaymentMethodOptions.Payto.MandateOptions.Purpose purpose)	The purpose for which payments are made.
SessionCreateParams.PaymentMethodOptions.Payto.MandateOptions.Builder	setStartDate(String startDate)	Date, in YYYY-MM-DD format, from which payments will be collected.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

build

public SessionCreateParams.PaymentMethodOptions.Payto.MandateOptions build()

Finalize and obtain parameter instance from this builder.

setAmount

public SessionCreateParams.PaymentMethodOptions.Payto.MandateOptions.Builder setAmount(Long amount)

Amount that will be collected. It is required when amount_type is fixed.

setAmountType

public SessionCreateParams.PaymentMethodOptions.Payto.MandateOptions.Builder setAmountType(SessionCreateParams.PaymentMethodOptions.Payto.MandateOptions.AmountType amountType)

The type of amount that will be collected. The amount charged must be exact or up to the value of amount param for fixed or maximum type respectively.

setEndDate

public SessionCreateParams.PaymentMethodOptions.Payto.MandateOptions.Builder setEndDate(String endDate)

Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.

putExtraParam

public SessionCreateParams.PaymentMethodOptions.Payto.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. See SessionCreateParams.PaymentMethodOptions.Payto.MandateOptions.extraParams for the field documentation.

putAllExtraParam

public SessionCreateParams.PaymentMethodOptions.Payto.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. See SessionCreateParams.PaymentMethodOptions.Payto.MandateOptions.extraParams for the field documentation.

setPaymentSchedule

public SessionCreateParams.PaymentMethodOptions.Payto.MandateOptions.Builder setPaymentSchedule(SessionCreateParams.PaymentMethodOptions.Payto.MandateOptions.PaymentSchedule paymentSchedule)

The periodicity at which payments will be collected.

setPaymentsPerPeriod

public SessionCreateParams.PaymentMethodOptions.Payto.MandateOptions.Builder setPaymentsPerPeriod(Long paymentsPerPeriod)

The number of payments that will be made during a payment period. Defaults to 1 except for when payment_schedule is adhoc. In that case, it defaults to no limit.

setPurpose

public SessionCreateParams.PaymentMethodOptions.Payto.MandateOptions.Builder setPurpose(SessionCreateParams.PaymentMethodOptions.Payto.MandateOptions.Purpose purpose)

The purpose for which payments are made. Defaults to retail.

setStartDate

public SessionCreateParams.PaymentMethodOptions.Payto.MandateOptions.Builder setStartDate(String startDate)

Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.