Package com.stripe.param
Class SetupIntentCreateParams.Builder
java.lang.Object
com.stripe.param.SetupIntentCreateParams.Builder
- Enclosing class:
- SetupIntentCreateParams
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddAllExpand
(List<String> elements) Add all elements to `expand` list.Add all elements to `flowDirections` list.addAllPaymentMethodType
(List<String> elements) Add all elements to `paymentMethodTypes` list.Add an element to `expand` list.Add an element to `flowDirections` list.addPaymentMethodType
(String element) Add an element to `paymentMethodTypes` list.build()
Finalize and obtain parameter instance from this builder.putAllExtraParam
(Map<String, Object> map) Add all map key/value pairs to `extraParams` map.putAllMetadata
(Map<String, String> map) Add all map key/value pairs to `metadata` map.putExtraParam
(String key, Object value) Add a key/value pair to `extraParams` map.putMetadata
(String key, String value) Add a key/value pair to `metadata` map.setAttachToSelf
(Boolean attachToSelf) If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.setAutomaticPaymentMethods
(SetupIntentCreateParams.AutomaticPaymentMethods automaticPaymentMethods) When enabled, this SetupIntent will accept payment methods that you have enabled in the Dashboard and are compatible with this SetupIntent's other parameters.setConfirm
(Boolean confirm) Set totrue
to attempt to confirm this SetupIntent immediately.setCustomer
(String customer) ID of the Customer this SetupIntent belongs to, if one exists.setDescription
(String description) An arbitrary string attached to the object.setMandateData
(EmptyParam mandateData) This hash contains details about the Mandate to create.setMandateData
(SetupIntentCreateParams.MandateData mandateData) This hash contains details about the Mandate to create.setOnBehalfOf
(String onBehalfOf) The Stripe account ID for which this SetupIntent is created.setPaymentMethod
(String paymentMethod) ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent.setPaymentMethodConfiguration
(String paymentMethodConfiguration) The ID of the payment method configuration to use with this Setup Intent.setPaymentMethodData
(SetupIntentCreateParams.PaymentMethodData paymentMethodData) When included, this hash creates a PaymentMethod that is set as thepayment_method
value in the SetupIntent.setPaymentMethodOptions
(SetupIntentCreateParams.PaymentMethodOptions paymentMethodOptions) Payment-method-specific configuration for this SetupIntent.setReturnUrl
(String returnUrl) The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site.setSingleUse
(SetupIntentCreateParams.SingleUse singleUse) If this hash is populated, this SetupIntent will generate a single_use Mandate on success.Indicates how the payment method is intended to be used in the future.setUseStripeSdk
(Boolean useStripeSdk) Set totrue
when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
build
Finalize and obtain parameter instance from this builder. -
setAttachToSelf
If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.It can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.
-
setAutomaticPaymentMethods
public SetupIntentCreateParams.Builder setAutomaticPaymentMethods(SetupIntentCreateParams.AutomaticPaymentMethods automaticPaymentMethods) When enabled, this SetupIntent will accept payment methods that you have enabled in the Dashboard and are compatible with this SetupIntent's other parameters. -
setConfirm
Set totrue
to attempt to confirm this SetupIntent immediately. This parameter defaults tofalse
. If the payment method attached is a card, a return_url may be provided in case additional authentication is required. -
setCustomer
ID of the Customer this SetupIntent belongs to, if one exists.If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.
-
setDescription
An arbitrary string attached to the object. Often useful for displaying to users. -
addExpand
Add an element to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. SeeSetupIntentCreateParams.expand
for the field documentation. -
addAllExpand
Add all elements to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. SeeSetupIntentCreateParams.expand
for the field documentation. -
putExtraParam
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. SeeSetupIntentCreateParams.extraParams
for the field documentation. -
putAllExtraParam
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. SeeSetupIntentCreateParams.extraParams
for the field documentation. -
addFlowDirection
public SetupIntentCreateParams.Builder addFlowDirection(SetupIntentCreateParams.FlowDirection element) Add an element to `flowDirections` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. SeeSetupIntentCreateParams.flowDirections
for the field documentation. -
addAllFlowDirection
public SetupIntentCreateParams.Builder addAllFlowDirection(List<SetupIntentCreateParams.FlowDirection> elements) Add all elements to `flowDirections` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. SeeSetupIntentCreateParams.flowDirections
for the field documentation. -
setMandateData
public SetupIntentCreateParams.Builder setMandateData(SetupIntentCreateParams.MandateData mandateData) This hash contains details about the Mandate to create. This parameter can only be used withconfirm=true
. -
setMandateData
This hash contains details about the Mandate to create. This parameter can only be used withconfirm=true
. -
putMetadata
Add a key/value pair to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. SeeSetupIntentCreateParams.metadata
for the field documentation. -
putAllMetadata
Add all map key/value pairs to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. SeeSetupIntentCreateParams.metadata
for the field documentation. -
setOnBehalfOf
The Stripe account ID for which this SetupIntent is created. -
setPaymentMethod
ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. -
setPaymentMethodConfiguration
public SetupIntentCreateParams.Builder setPaymentMethodConfiguration(String paymentMethodConfiguration) The ID of the payment method configuration to use with this Setup Intent. -
setPaymentMethodData
public SetupIntentCreateParams.Builder setPaymentMethodData(SetupIntentCreateParams.PaymentMethodData paymentMethodData) When included, this hash creates a PaymentMethod that is set as thepayment_method
value in the SetupIntent. -
setPaymentMethodOptions
public SetupIntentCreateParams.Builder setPaymentMethodOptions(SetupIntentCreateParams.PaymentMethodOptions paymentMethodOptions) Payment-method-specific configuration for this SetupIntent. -
addPaymentMethodType
Add an element to `paymentMethodTypes` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. SeeSetupIntentCreateParams.paymentMethodTypes
for the field documentation. -
addAllPaymentMethodType
Add all elements to `paymentMethodTypes` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. SeeSetupIntentCreateParams.paymentMethodTypes
for the field documentation. -
setReturnUrl
The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used withconfirm=true
. -
setSingleUse
If this hash is populated, this SetupIntent will generate a single_use Mandate on success. -
setUsage
Indicates how the payment method is intended to be used in the future. If not provided, this value defaults tooff_session
. -
setUseStripeSdk
Set totrue
when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.
-