Class PaymentIntentCreateParams
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
static class
static enum
Add all map key/value pairs to `extraParams` map.static enum
static class
Add all map key/value pairs to `extraParams` map.static enum
static class
Required. 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.static class
State, county, province, or region.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()
Required. Amount intended to be collected by this PaymentIntent.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.When enabled, this PaymentIntent will accept payment methods that you have enabled in the Dashboard and are compatible with this PaymentIntent's other parameters.Controls when the funds will be captured from the customer's account.Set totrue
to attempt to confirm this PaymentIntent immediately.Required. Three-letter ISO currency code, in lowercase.ID of the Customer this PaymentIntent belongs to, if one exists.An arbitrary string attached to the object.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 to be used for this payment.This hash contains details about the Mandate to create.Set of key-value pairs that you can attach to an object.Set totrue
to indicate that the customer is not in your checkout flow during this payment attempt, and therefore is unable to authenticate.The Stripe account ID for which these funds are intended.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.The list of payment method types (e.g.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.For non-card charges, you can use this value as the complete description that appears on your customers’ statements.Provides information about a card payment that customers see on their statements.The parameters used to automatically create a Transfer when the payment succeeds.A string that identifies the resulting payment as part of a group.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
toMap
-
Method Details
-
builder
-
getAmount
Required. Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or equivalent in charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). -
getApplicationFeeAmount
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. -
getAutomaticPaymentMethods
When enabled, this PaymentIntent will accept payment methods that you have enabled in the Dashboard and are compatible with this PaymentIntent's other parameters. -
getCaptureMethod
Controls when the funds will be captured from the customer's account. -
getConfirm
-
getConfirmationMethod
-
getCurrency
Required. Three-letter ISO currency code, in lowercase. Must be a supported currency. -
getCustomer
ID of the Customer this PaymentIntent belongs to, if one exists.Payment methods attached to other Customers cannot be used with this PaymentIntent.
If present in combination with setup_future_usage, this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete.
-
getDescription
An arbitrary string attached to the object. Often useful for displaying to users. -
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. This parameter can only be used withconfirm=true
. -
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 to be used for this payment. This parameter can only be used withconfirm=true
. -
getMandateData
This hash contains details about the Mandate to create. This parameter can only be used withconfirm=true
. -
getMetadata
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value tometadata
. -
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. This parameter can only be used withconfirm=true
. -
getOnBehalfOf
The Stripe account ID for which these funds are intended. For details, see the PaymentIntents use case for connected accounts. -
getPaymentMethod
ID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent.If neither the
payment_method
parameter nor thesource
parameter are provided withconfirm=true
,source
will be automatically populated withcustomer.default_source
to improve the migration experience for users of the Charges API. We recommend that you explicitly provide thepayment_method
going forward. -
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. -
getPaymentMethodTypes
The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. If this is not provided, defaults to ["card"]. Use automatic_payment_methods to manage payment methods from the Stripe Dashboard. -
getRadarOptions
Options to configure Radar. See Radar Session for more information. -
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 can only be used withconfirm=true
. -
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. -
getShipping
Shipping information for this PaymentIntent. -
getStatementDescriptor
For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters. -
getStatementDescriptorSuffix
Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. -
getTransferData
The parameters used to automatically create a Transfer when the payment succeeds. For more information, see the PaymentIntents use case for connected accounts. -
getTransferGroup
A string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected accounts for details. -
getUseStripeSdk
Set totrue
when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.
-