Package 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 Description static class
PaymentIntentConfirmParams.Builder
static class
PaymentIntentConfirmParams.MandateData
static class
PaymentIntentConfirmParams.OffSession
State, county, province, or region.static class
PaymentIntentConfirmParams.PaymentMethodData
The user agent of the browser from which the Mandate was accepted by the customer.static class
PaymentIntentConfirmParams.PaymentMethodOptions
static class
PaymentIntentConfirmParams.SetupFutureUsage
static class
PaymentIntentConfirmParams.Shipping
Add all map key/value pairs to `extraParams` map.-
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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static PaymentIntentConfirmParams.Builder
builder()
java.lang.Boolean
getErrorOnRequiresAction()
Set totrue
to fail the payment attempt if the PaymentIntent transitions intorequires_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 totrue
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.PaymentMethodData
getPaymentMethodData()
If provided, this hash will be used to create a PaymentMethod.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.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.Boolean
getUseStripeSdk()
Set totrue
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
-
-
-
-
Method Detail
-
builder
public static PaymentIntentConfirmParams.Builder builder()
-
getErrorOnRequiresAction
public java.lang.Boolean 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
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 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.
-
getPaymentMethod
public java.lang.String getPaymentMethod()
ID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent.
-
getPaymentMethodData
public PaymentIntentConfirmParams.PaymentMethodData 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
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. Ifreceipt_email
is specified for a payment in live mode, a receipt will be sent regardless of your email settings.
-
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.
-
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 fromon_session
tooff_session
.
-
getShipping
public java.lang.Object getShipping()
Shipping information for this PaymentIntent.
-
getUseStripeSdk
public java.lang.Boolean getUseStripeSdk()
Set totrue
only when using manual confirmation and the iOS or Android SDKs to handle additional authentication steps.
-
-