Package com.stripe.param
Class PaymentIntentUpdateParams.PaymentMethodOptions.Pix.MandateOptions.Builder
java.lang.Object
com.stripe.param.PaymentIntentUpdateParams.PaymentMethodOptions.Pix.MandateOptions.Builder
- Enclosing class:
- PaymentIntentUpdateParams.PaymentMethodOptions.Pix.MandateOptions
public static class PaymentIntentUpdateParams.PaymentMethodOptions.Pix.MandateOptions.Builder
extends Object
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()
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.Amount to be charged for future payments.setAmountIncludesIof
(PaymentIntentUpdateParams.PaymentMethodOptions.Pix.MandateOptions.AmountIncludesIof amountIncludesIof) Determines if the amount includes the IOF tax.setAmountType
(PaymentIntentUpdateParams.PaymentMethodOptions.Pix.MandateOptions.AmountType amountType) Type of amount.setCurrency
(EmptyParam currency) Three-letter ISO currency code, in lowercase.setCurrency
(String currency) Three-letter ISO currency code, in lowercase.setEndDate
(EmptyParam endDate) Date when the mandate expires and no further payments will be charged, inYYYY-MM-DD
.setEndDate
(String endDate) Date when the mandate expires and no further payments will be charged, inYYYY-MM-DD
.setPaymentSchedule
(PaymentIntentUpdateParams.PaymentMethodOptions.Pix.MandateOptions.PaymentSchedule paymentSchedule) Schedule at which the future payments will be charged.setReference
(EmptyParam reference) Subscription name displayed to buyers in their bank app.setReference
(String reference) Subscription name displayed to buyers in their bank app.setStartDate
(EmptyParam startDate) Start date of the mandate, inYYYY-MM-DD
.setStartDate
(String startDate) Start date of the mandate, inYYYY-MM-DD
.
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
build
Finalize and obtain parameter instance from this builder. -
setAmount
public PaymentIntentUpdateParams.PaymentMethodOptions.Pix.MandateOptions.Builder setAmount(Long amount) Amount to be charged for future payments. Required whenamount_type=fixed
. If not provided foramount_type=maximum
, defaults to 40000. -
setAmountIncludesIof
public PaymentIntentUpdateParams.PaymentMethodOptions.Pix.MandateOptions.Builder setAmountIncludesIof(PaymentIntentUpdateParams.PaymentMethodOptions.Pix.MandateOptions.AmountIncludesIof amountIncludesIof) Determines if the amount includes the IOF tax. Defaults tonever
. -
setAmountType
public PaymentIntentUpdateParams.PaymentMethodOptions.Pix.MandateOptions.Builder setAmountType(PaymentIntentUpdateParams.PaymentMethodOptions.Pix.MandateOptions.AmountType amountType) Type of amount. Defaults tomaximum
. -
setCurrency
public PaymentIntentUpdateParams.PaymentMethodOptions.Pix.MandateOptions.Builder setCurrency(String currency) Three-letter ISO currency code, in lowercase. Onlybrl
is supported currently. -
setCurrency
public PaymentIntentUpdateParams.PaymentMethodOptions.Pix.MandateOptions.Builder setCurrency(EmptyParam currency) Three-letter ISO currency code, in lowercase. Onlybrl
is supported currently. -
setEndDate
public PaymentIntentUpdateParams.PaymentMethodOptions.Pix.MandateOptions.Builder setEndDate(String endDate) Date when the mandate expires and no further payments will be charged, inYYYY-MM-DD
. If not provided, the mandate will be active until canceled. If provided, end date should be after start date. -
setEndDate
public PaymentIntentUpdateParams.PaymentMethodOptions.Pix.MandateOptions.Builder setEndDate(EmptyParam endDate) Date when the mandate expires and no further payments will be charged, inYYYY-MM-DD
. If not provided, the mandate will be active until canceled. If provided, end date should be after start date. -
putExtraParam
public PaymentIntentUpdateParams.PaymentMethodOptions.Pix.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. SeePaymentIntentUpdateParams.PaymentMethodOptions.Pix.MandateOptions.extraParams
for the field documentation. -
putAllExtraParam
public PaymentIntentUpdateParams.PaymentMethodOptions.Pix.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. SeePaymentIntentUpdateParams.PaymentMethodOptions.Pix.MandateOptions.extraParams
for the field documentation. -
setPaymentSchedule
public PaymentIntentUpdateParams.PaymentMethodOptions.Pix.MandateOptions.Builder setPaymentSchedule(PaymentIntentUpdateParams.PaymentMethodOptions.Pix.MandateOptions.PaymentSchedule paymentSchedule) Schedule at which the future payments will be charged. Defaults toweekly
. -
setReference
public PaymentIntentUpdateParams.PaymentMethodOptions.Pix.MandateOptions.Builder setReference(String reference) Subscription name displayed to buyers in their bank app. Defaults to the displayable business name. -
setReference
public PaymentIntentUpdateParams.PaymentMethodOptions.Pix.MandateOptions.Builder setReference(EmptyParam reference) Subscription name displayed to buyers in their bank app. Defaults to the displayable business name. -
setStartDate
public PaymentIntentUpdateParams.PaymentMethodOptions.Pix.MandateOptions.Builder setStartDate(String startDate) Start date of the mandate, inYYYY-MM-DD
. Start date should be at least 3 days in the future. Defaults to 3 days after the current date. -
setStartDate
public PaymentIntentUpdateParams.PaymentMethodOptions.Pix.MandateOptions.Builder setStartDate(EmptyParam startDate) Start date of the mandate, inYYYY-MM-DD
. Start date should be at least 3 days in the future. Defaults to 3 days after the current date.
-