Package com.stripe.param

Class PaymentIntentConfirmParams.Builder

java.lang.Object

com.stripe.param.PaymentIntentConfirmParams.Builder

Enclosing class:

PaymentIntentConfirmParams

public static class PaymentIntentConfirmParams.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PaymentIntentConfirmParams.Builder	addAllExpand(List<String> elements)	Add all elements to `expand` list.
PaymentIntentConfirmParams.Builder	addExpand(String element)	Add an element to `expand` list.
PaymentIntentConfirmParams	build()	Finalize and obtain parameter instance from this builder.
PaymentIntentConfirmParams.Builder	putAllExtraParam(Map<String,Object> map)	Add all map key/value pairs to `extraParams` map.
PaymentIntentConfirmParams.Builder	putExtraParam(String key, Object value)	Add a key/value pair to `extraParams` map.
PaymentIntentConfirmParams.Builder	setApplicationFeeAmount(EmptyParam applicationFeeAmount)	The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account.
PaymentIntentConfirmParams.Builder	setApplicationFeeAmount(Long applicationFeeAmount)	The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account.
PaymentIntentConfirmParams.Builder	setCaptureMethod(PaymentIntentConfirmParams.CaptureMethod captureMethod)	Controls when the funds will be captured from the customer's account.
PaymentIntentConfirmParams.Builder	setErrorOnRequiresAction(Boolean errorOnRequiresAction)	Set to true to fail the payment attempt if the PaymentIntent transitions into requires_action.
PaymentIntentConfirmParams.Builder	setMandate(String mandate)	ID of the mandate to be used for this payment.
PaymentIntentConfirmParams.Builder	setMandateData(PaymentIntentConfirmParams.MandateData mandateData)	This hash contains details about the Mandate to create.
PaymentIntentConfirmParams.Builder	setOffSession(PaymentIntentConfirmParams.OffSession offSession)	Set to true to indicate that the customer is not in your checkout flow during this payment attempt, and therefore is unable to authenticate.
PaymentIntentConfirmParams.Builder	setOffSession(Boolean offSession)	Set to true to indicate that the customer is not in your checkout flow during this payment attempt, and therefore is unable to authenticate.
PaymentIntentConfirmParams.Builder	setPaymentDetails(EmptyParam paymentDetails)	Provides industry-specific information about the charge.
PaymentIntentConfirmParams.Builder	setPaymentDetails(PaymentIntentConfirmParams.PaymentDetails paymentDetails)	Provides industry-specific information about the charge.
PaymentIntentConfirmParams.Builder	setPaymentMethod(String paymentMethod)	ID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent.
PaymentIntentConfirmParams.Builder	setPaymentMethodData(PaymentIntentConfirmParams.PaymentMethodData paymentMethodData)	If provided, this hash will be used to create a PaymentMethod.
PaymentIntentConfirmParams.Builder	setPaymentMethodOptions(PaymentIntentConfirmParams.PaymentMethodOptions paymentMethodOptions)	Payment-method-specific configuration for this PaymentIntent.
PaymentIntentConfirmParams.Builder	setRadarOptions(PaymentIntentConfirmParams.RadarOptions radarOptions)	Options to configure Radar.
PaymentIntentConfirmParams.Builder	setReceiptEmail(EmptyParam receiptEmail)	Email address that the receipt for the resulting payment will be sent to.
PaymentIntentConfirmParams.Builder	setReceiptEmail(String receiptEmail)	Email address that the receipt for the resulting payment will be sent to.
PaymentIntentConfirmParams.Builder	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.
PaymentIntentConfirmParams.Builder	setSetupFutureUsage(EmptyParam setupFutureUsage)	Indicates that you intend to make future payments with this PaymentIntent's payment method.
PaymentIntentConfirmParams.Builder	setSetupFutureUsage(PaymentIntentConfirmParams.SetupFutureUsage setupFutureUsage)	Indicates that you intend to make future payments with this PaymentIntent's payment method.
PaymentIntentConfirmParams.Builder	setShipping(EmptyParam shipping)	Shipping information for this PaymentIntent.
PaymentIntentConfirmParams.Builder	setShipping(PaymentIntentConfirmParams.Shipping shipping)	Shipping information for this PaymentIntent.
PaymentIntentConfirmParams.Builder	setUseStripeSdk(Boolean useStripeSdk)	Set to true when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.

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 PaymentIntentConfirmParams build()

Finalize and obtain parameter instance from this builder.

setApplicationFeeAmount

public PaymentIntentConfirmParams.Builder setApplicationFeeAmount(Long applicationFeeAmount)

The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents use case for connected accounts.

setApplicationFeeAmount

public PaymentIntentConfirmParams.Builder setApplicationFeeAmount(EmptyParam applicationFeeAmount)

The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents use case for connected accounts.

setCaptureMethod

public PaymentIntentConfirmParams.Builder setCaptureMethod(PaymentIntentConfirmParams.CaptureMethod captureMethod)

Controls when the funds will be captured from the customer's account.

setErrorOnRequiresAction

public PaymentIntentConfirmParams.Builder setErrorOnRequiresAction(Boolean errorOnRequiresAction)

Set to true to fail the payment attempt if the PaymentIntent transitions into requires_action. This parameter is intended for simpler integrations that do not handle customer actions, like saving cards without authentication.

addExpand

public PaymentIntentConfirmParams.Builder addExpand(String element)

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. See PaymentIntentConfirmParams.expand for the field documentation.

addAllExpand

public PaymentIntentConfirmParams.Builder addAllExpand(List<String> elements)

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. See PaymentIntentConfirmParams.expand for the field documentation.

putExtraParam

public PaymentIntentConfirmParams.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 PaymentIntentConfirmParams.extraParams for the field documentation.

putAllExtraParam

public PaymentIntentConfirmParams.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 PaymentIntentConfirmParams.extraParams for the field documentation.

setMandate

public PaymentIntentConfirmParams.Builder setMandate(String mandate)

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

public PaymentIntentConfirmParams.Builder setOffSession(Boolean offSession)

Set to true 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 to true 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.

setPaymentDetails

public PaymentIntentConfirmParams.Builder setPaymentDetails(PaymentIntentConfirmParams.PaymentDetails paymentDetails)

Provides industry-specific information about the charge.

setPaymentDetails

public PaymentIntentConfirmParams.Builder setPaymentDetails(EmptyParam paymentDetails)

Provides industry-specific information about the charge.

setPaymentMethod

public PaymentIntentConfirmParams.Builder setPaymentMethod(String paymentMethod)

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

public PaymentIntentConfirmParams.Builder setReceiptEmail(String receiptEmail)

Email address that the receipt for the resulting payment will be sent to. If receipt_email is specified for a payment in live mode, a receipt will be sent regardless of your email settings.

setReceiptEmail

public PaymentIntentConfirmParams.Builder setReceiptEmail(EmptyParam receiptEmail)

Email address that the receipt for the resulting payment will be sent to. If receipt_email is specified for a payment in live mode, a receipt will be sent regardless of your email settings.

setReturnUrl

public PaymentIntentConfirmParams.Builder 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. 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 from on_session to off_session.

setSetupFutureUsage

public PaymentIntentConfirmParams.Builder setSetupFutureUsage(EmptyParam 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 from on_session to off_session.

setShipping

public PaymentIntentConfirmParams.Builder setShipping(PaymentIntentConfirmParams.Shipping shipping)

Shipping information for this PaymentIntent.

setShipping

public PaymentIntentConfirmParams.Builder setShipping(EmptyParam shipping)

Shipping information for this PaymentIntent.

setUseStripeSdk

public PaymentIntentConfirmParams.Builder setUseStripeSdk(Boolean useStripeSdk)

Set to true when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.