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.OffSession Add all map key/value pairs to `extraParams` map.
static class	PaymentIntentConfirmParams.PaymentMethodOptions
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.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.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, BankAccount, or saved 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.
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()

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.

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](https://stripe.com/docs/payments/cards/charging-saved-cards).

getPaymentMethod

public java.lang.String getPaymentMethod()

ID of the payment method (a PaymentMethod, Card, BankAccount, or saved 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. Defaults to `false`.

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

getSetupFutureUsage

public ApiRequestParams.EnumParam getSetupFutureUsage()

Indicates that you intend to make future payments with this PaymentIntent's payment method.

If present, the payment method used with this PaymentIntent can be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer, even after the transaction completes.

Use `on_session` if you intend to only reuse the payment method when your customer is present in your checkout flow. Use `off_session` if your customer may or may not be in your checkout flow.

Stripe uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules. For example, if your customer is impacted by [SCA](https://stripe.com/docs/strong-customer-authentication), using `off_session` will ensure that they are authenticated while processing this PaymentIntent. You will then be able to collect [off-session payments](https://stripe.com/docs/payments/cards/charging-saved-cards#off-session-payments-with-saved-cards) for this customer.

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 Source, Card, and BankAccount 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.