Class PaymentIntentCreateParams


public class PaymentIntentCreateParams extends ApiRequestParams
  • Method Details

    • builder

      public static PaymentIntentCreateParams.Builder builder()
    • getAmount

      public Long 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

      public Long 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

      public PaymentIntentCreateParams.AutomaticPaymentMethods getAutomaticPaymentMethods()
      When you enable this parameter, this PaymentIntent accepts payment methods that you enable in the Dashboard and that are compatible with this PaymentIntent's other parameters.
    • getCaptureMethod

      public PaymentIntentCreateParams.CaptureMethod getCaptureMethod()
      Controls when the funds will be captured from the customer's account.
    • getConfirm

      public Boolean getConfirm()
      Set to true to attempt to confirm this PaymentIntent immediately. This parameter defaults to false. When creating and confirming a PaymentIntent at the same time, you can also provide the parameters available in the Confirm API.
    • getConfirmationMethod

      public PaymentIntentCreateParams.ConfirmationMethod getConfirmationMethod()
      Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment.
    • getConfirmationToken

      public String getConfirmationToken()
      ID of the ConfirmationToken used to confirm this PaymentIntent.

      If the provided ConfirmationToken contains properties that are also being provided in this request, such as payment_method, then the values in this request will take precedence.

    • getCurrency

      public String getCurrency()
      Required. Three-letter ISO currency code, in lowercase. Must be a supported currency.
    • getCustomer

      public String 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

      public String getDescription()
      An arbitrary string attached to the object. Often useful for displaying to users.
    • getErrorOnRequiresAction

      public Boolean getErrorOnRequiresAction()
      Set to true to fail the payment attempt if the PaymentIntent transitions into requires_action. Use this parameter for simpler integrations that don't handle customer actions, such as saving cards without authentication. This parameter can only be used with confirm=true.
    • getExpand

      public List<String> getExpand()
      Specifies which fields in the response should be expanded.
    • getExtraParams

      public Map<String,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 String getMandate()
      ID of the mandate that's used for this payment. This parameter can only be used with confirm=true.
    • getMandateData

      public Object getMandateData()
      This hash contains details about the Mandate to create. This parameter can only be used with confirm=true.
    • getMetadata

      public Map<String,String> 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 to metadata.
    • getOffSession

      public Object getOffSession()
      Set to true 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. This parameter can only be used with confirm=true.
    • getOnBehalfOf

      public String getOnBehalfOf()
      The Stripe account ID that these funds are intended for. Learn more about the use case for connected accounts.
    • getPaymentMethod

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

      If you don't provide the payment_method parameter or the source parameter with confirm=true, source automatically populates with customer.default_source to improve migration for users of the Charges API. We recommend that you explicitly provide the payment_method moving forward.

    • getPaymentMethodConfiguration

      public String getPaymentMethodConfiguration()
      The ID of the payment method configuration to use with this PaymentIntent.
    • getPaymentMethodData

      public PaymentIntentCreateParams.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 PaymentIntentCreateParams.PaymentMethodOptions getPaymentMethodOptions()
      Payment method-specific configuration for this PaymentIntent.
    • getPaymentMethodTypes

      public List<String> getPaymentMethodTypes()
      The list of payment method types (for example, a card) that this PaymentIntent can use. If you don't provide this, it defaults to ["card"]. Use automatic_payment_methods to manage payment methods from the Stripe Dashboard.
    • getRadarOptions

      public PaymentIntentCreateParams.RadarOptions getRadarOptions()
      Options to configure Radar. Learn more about Radar Sessions.
    • getReceiptEmail

      public String getReceiptEmail()
      Email address to send the receipt to. If you specify receipt_email for a payment in live mode, you send a receipt regardless of your email settings.
    • getReturnUrl

      public 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 can only be used with confirm=true.
    • getSetupFutureUsage

      public PaymentIntentCreateParams.SetupFutureUsage 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

      public PaymentIntentCreateParams.Shipping getShipping()
      Shipping information for this PaymentIntent.
    • getStatementDescriptor

      public String getStatementDescriptor()
      For card charges, use statement_descriptor_suffix. Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long.
    • getStatementDescriptorSuffix

      public String 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. The concatenated descriptor must contain 1-22 characters.
    • getTransferData

      public PaymentIntentCreateParams.TransferData getTransferData()
      The parameters that you can use to automatically create a Transfer. Learn more about the use case for connected accounts.
    • getTransferGroup

      public String getTransferGroup()
      A string that identifies the resulting payment as part of a group. Learn more about the use case for connected accounts.
    • getUseStripeSdk

      public Boolean getUseStripeSdk()
      Set to true when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.