Package com.stripe.param
Class PaymentIntentConfirmParams
java.lang.Object
com.stripe.net.ApiRequestParams
com.stripe.param.PaymentIntentConfirmParams
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
static enum
State, county, province, or region.static class
static enum
static class
The user agent of the browser from which the Mandate was accepted by the customer.static class
static class
Indicates that you intend to make future payments with this PaymentIntent's payment method.static enum
static class
A Radar Session is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.Nested classes/interfaces inherited from class com.stripe.net.ApiRequestParams
ApiRequestParams.EnumParam
-
Field Summary
Fields inherited from class com.stripe.net.ApiRequestParams
EXTRA_PARAMS_KEY
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Controls when the funds will be captured from the customer's account.Set totrue
to fail the payment attempt if the PaymentIntent transitions intorequires_action
.Specifies which fields in the response should be expanded.Map of extra parameters for custom features not available in this client library.ID of the mandate that's used for this payment.Set totrue
to indicate that the customer isn't in your checkout flow during this payment attempt and can't authenticate.ID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent.If provided, this hash will be used to create a PaymentMethod.Payment method-specific configuration for this PaymentIntent.Options to configure Radar.Email address that the receipt for the resulting payment will be sent to.The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site.Indicates that you intend to make future payments with this PaymentIntent's payment method.Shipping information for this PaymentIntent.Set totrue
when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.Methods inherited from class com.stripe.net.ApiRequestParams
paramsToMap, toMap
-
Method Details
-
builder
-
getCaptureMethod
Controls when the funds will be captured from the customer's account. -
getErrorOnRequiresAction
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. -
getExpand
Specifies which fields in the response should be expanded. -
getExtraParams
Map of extra parameters for custom features not available in this client library. The content in this map is not serialized under this field's@SerializedName
value. Instead, each key/value pair is serialized as if the key is a root-level field (serialized) name in this param object. Effectively, this map is flattened to its parent instance. -
getMandate
ID of the mandate that's used for this payment. -
getMandateData
-
getOffSession
Set totrue
to indicate that the customer isn't in your checkout flow during this payment attempt and can't authenticate. Use this parameter in scenarios where you collect card details and charge them later. -
getPaymentMethod
ID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent. -
getPaymentMethodData
If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear in the payment_method property on the PaymentIntent. -
getPaymentMethodOptions
Payment method-specific configuration for this PaymentIntent. -
getRadarOptions
Options to configure Radar. Learn more about Radar Sessions. -
getReceiptEmail
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. -
getReturnUrl
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. -
getSetupFutureUsage
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
. -
getShipping
Shipping information for this PaymentIntent. -
getUseStripeSdk
Set totrue
when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.
-