com.stripe.param

Class PaymentIntentConfirmParams

java.lang.Object

com.stripe.net.ApiRequestParams

com.stripe.param.PaymentIntentConfirmParams

public class PaymentIntentConfirmParams
extends ApiRequestParams

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PaymentIntentConfirmParams.Builder
static class	PaymentIntentConfirmParams.MandateData
static class	PaymentIntentConfirmParams.OffSession State, county, province, or region.
static class	PaymentIntentConfirmParams.PaymentMethodOptions The user agent of the browser from which the Mandate was accepted by the customer.
static class	PaymentIntentConfirmParams.SetupFutureUsage
static class	PaymentIntentConfirmParams.Shipping Type of installment plan, one of fixed_count.

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 Type	Method and Description
static PaymentIntentConfirmParams.Builder	builder()
java.lang.Boolean	getErrorOnRequiresAction() Set to true to fail the payment attempt if the PaymentIntent transitions into requires_action.
java.util.List<java.lang.String>	getExpand() Specifies which fields in the response should be expanded.
java.util.Map<java.lang.String,java.lang.Object>	getExtraParams() Map of extra parameters for custom features not available in this client library.
java.lang.String	getMandate() ID of the mandate to be used for this payment.
java.lang.Object	getMandateData() This hash contains details about the Mandate to create.
java.lang.Object	getOffSession() Set to true to indicate that the customer is not in your checkout flow during this payment attempt, and therefore is unable to authenticate.
java.lang.String	getPaymentMethod() ID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent.
PaymentIntentConfirmParams.PaymentMethodOptions	getPaymentMethodOptions() Payment-method-specific configuration for this PaymentIntent.
java.lang.Object	getReceiptEmail() Email address that the receipt for the resulting payment will be sent to.
java.lang.String	getReturnUrl() The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site.
java.lang.Boolean	getSavePaymentMethod() If the PaymentIntent has a payment_method and a customer or if you're attaching a payment method to the PaymentIntent in this request, you can pass save_payment_method=true to save the payment method to the customer immediately.
ApiRequestParams.EnumParam	getSetupFutureUsage() Indicates that you intend to make future payments with this PaymentIntent's payment method.
java.lang.Object	getShipping() Shipping information for this PaymentIntent.
java.lang.String	getSource() This is a legacy field that will be removed in the future.
java.lang.Boolean	getUseStripeSdk() Set to true only when using manual confirmation and the iOS or Android SDKs to handle additional authentication steps.

Methods inherited from class com.stripe.net.ApiRequestParams

toMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static PaymentIntentConfirmParams.Builder builder()

getErrorOnRequiresAction

public java.lang.Boolean getErrorOnRequiresAction()

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.

getExpand

public java.util.List<java.lang.String> getExpand()

Specifies which fields in the response should be expanded.

getExtraParams

public java.util.Map<java.lang.String,java.lang.Object> 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

public java.lang.String getMandate()

ID of the mandate to be used for this payment.

getMandateData

public java.lang.Object getMandateData()

This hash contains details about the Mandate to create.

getOffSession

public java.lang.Object getOffSession()

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.

getPaymentMethod

public java.lang.String getPaymentMethod()

ID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent.

getPaymentMethodOptions

public PaymentIntentConfirmParams.PaymentMethodOptions getPaymentMethodOptions()

Payment-method-specific configuration for this PaymentIntent.

getReceiptEmail

public java.lang.Object getReceiptEmail()

Email address that the receipt for the resulting payment will be sent to.

getReturnUrl

public java.lang.String 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.

getSavePaymentMethod

public java.lang.Boolean getSavePaymentMethod()

If the PaymentIntent has a payment_method and a customer or if you're attaching a payment method to the PaymentIntent in this request, you can pass save_payment_method=true to save the payment method to the customer immediately.

If the payment method is already saved to a customer, this parameter does nothing. If this type of payment method cannot be saved to a customer, the request will error.

Saving a payment method using this parameter is not recommended because it will save the payment method even if it cannot be charged (e.g. the user made a typo). To ensure that only payment methods which are likely to be chargeable are saved to a customer, use the (setup_future_usage)[#payment_intents/object#payment_intent_object-setup_future_usage] property, which saves the payment method after the PaymentIntent has been confirmed and all required actions by the customer are complete.

getSetupFutureUsage

public ApiRequestParams.EnumParam 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 from on_session to off_session.

getShipping

public java.lang.Object getShipping()

Shipping information for this PaymentIntent.

getSource

public java.lang.String getSource()

This is a legacy field that will be removed in the future. It is the ID of the Source object to attach to this PaymentIntent. Please use the payment_method field instead, which also supports Cards and compatible Source objects.

getUseStripeSdk

public java.lang.Boolean getUseStripeSdk()

Set to true only when using manual confirmation and the iOS or Android SDKs to handle additional authentication steps.