Class PaymentIntentConfirmParams.Builder
- Enclosing class:
- PaymentIntentConfirmParams
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddAllExpand
(List<String> elements) Add all elements to `expand` list.Add an element to `expand` 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.setCaptureMethod
(PaymentIntentConfirmParams.CaptureMethod captureMethod) Controls when the funds will be captured from the customer's account.setErrorOnRequiresAction
(Boolean errorOnRequiresAction) Set totrue
to fail the payment attempt if the PaymentIntent transitions intorequires_action
.setMandate
(String mandate) ID of the mandate to be used for this payment.setMandateData
(PaymentIntentConfirmParams.MandateData mandateData) This hash contains details about the Mandate to create.setOffSession
(PaymentIntentConfirmParams.OffSession offSession) Set totrue
to indicate that the customer is not in your checkout flow during this payment attempt, and therefore is unable to authenticate.setOffSession
(Boolean offSession) Set totrue
to indicate that the customer is not in your checkout flow during this payment attempt, and therefore is unable to authenticate.setPaymentMethod
(String paymentMethod) ID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent.setPaymentMethodData
(PaymentIntentConfirmParams.PaymentMethodData paymentMethodData) If provided, this hash will be used to create a PaymentMethod.setPaymentMethodOptions
(PaymentIntentConfirmParams.PaymentMethodOptions paymentMethodOptions) Payment-method-specific configuration for this PaymentIntent.setRadarOptions
(PaymentIntentConfirmParams.RadarOptions radarOptions) Options to configure Radar.setReceiptEmail
(EmptyParam receiptEmail) Email address that the receipt for the resulting payment will be sent to.setReceiptEmail
(String receiptEmail) Email address that the receipt for the resulting payment will be sent to.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.setSetupFutureUsage
(EmptyParam setupFutureUsage) Indicates that you intend to make future payments with this PaymentIntent's payment method.setSetupFutureUsage
(PaymentIntentConfirmParams.SetupFutureUsage setupFutureUsage) Indicates that you intend to make future payments with this PaymentIntent's payment method.setShipping
(EmptyParam shipping) Shipping information for this PaymentIntent.Shipping information for this PaymentIntent.setUseStripeSdk
(Boolean useStripeSdk) Set totrue
only when using manual confirmation and the iOS or Android SDKs to handle additional authentication steps.
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
build
Finalize and obtain parameter instance from this builder. -
setCaptureMethod
public PaymentIntentConfirmParams.Builder setCaptureMethod(PaymentIntentConfirmParams.CaptureMethod captureMethod) Controls when the funds will be captured from the customer's account. -
setErrorOnRequiresAction
Set totrue
to fail the payment attempt if the PaymentIntent transitions intorequires_action
. This parameter is intended for simpler integrations that do not handle customer actions, like saving cards without authentication. -
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. SeePaymentIntentConfirmParams.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. SeePaymentIntentConfirmParams.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. SeePaymentIntentConfirmParams.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. SeePaymentIntentConfirmParams.extraParams
for the field documentation. -
setMandate
ID of the mandate to be used for this payment. -
setMandateData
public PaymentIntentConfirmParams.Builder setMandateData(PaymentIntentConfirmParams.MandateData mandateData) This hash contains details about the Mandate to create. -
setOffSession
Set totrue
to indicate that the customer is not in your checkout flow during this payment attempt, and therefore is unable to authenticate. This parameter is intended for scenarios where you collect card details and charge them later. -
setOffSession
public PaymentIntentConfirmParams.Builder setOffSession(PaymentIntentConfirmParams.OffSession offSession) Set totrue
to indicate that the customer is not in your checkout flow during this payment attempt, and therefore is unable to authenticate. This parameter is intended for scenarios where you collect card details and charge them later. -
setPaymentMethod
ID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent. -
setPaymentMethodData
public PaymentIntentConfirmParams.Builder setPaymentMethodData(PaymentIntentConfirmParams.PaymentMethodData paymentMethodData) If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear in the payment_method property on the PaymentIntent. -
setPaymentMethodOptions
public PaymentIntentConfirmParams.Builder setPaymentMethodOptions(PaymentIntentConfirmParams.PaymentMethodOptions paymentMethodOptions) Payment-method-specific configuration for this PaymentIntent. -
setRadarOptions
public PaymentIntentConfirmParams.Builder setRadarOptions(PaymentIntentConfirmParams.RadarOptions radarOptions) Options to configure Radar. See Radar Session for more information. -
setReceiptEmail
Email address that the receipt for the resulting payment will be sent to. Ifreceipt_email
is specified for a payment in live mode, a receipt will be sent regardless of your email settings. -
setReceiptEmail
Email address that the receipt for the resulting payment will be sent to. Ifreceipt_email
is specified for a payment in live mode, a receipt will be sent regardless of your email settings. -
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 is only used for cards and other redirect-based payment methods. -
setSetupFutureUsage
public PaymentIntentConfirmParams.Builder setSetupFutureUsage(PaymentIntentConfirmParams.SetupFutureUsage setupFutureUsage) Indicates that you intend to make future payments with this PaymentIntent's payment method.Providing this parameter will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.
When processing card payments, Stripe also uses
setup_future_usage
to dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.If
setup_future_usage
is already set and you are performing a request using a publishable key, you may only update the value fromon_session
tooff_session
. -
setSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent's payment method.Providing this parameter will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.
When processing card payments, Stripe also uses
setup_future_usage
to dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.If
setup_future_usage
is already set and you are performing a request using a publishable key, you may only update the value fromon_session
tooff_session
. -
setShipping
Shipping information for this PaymentIntent. -
setShipping
Shipping information for this PaymentIntent. -
setUseStripeSdk
Set totrue
only when using manual confirmation and the iOS or Android SDKs to handle additional authentication steps.
-