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 enabled, this PaymentIntent will accept payment methods that you have enabled in the Dashboard and 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, parameters available in the confirm API may also be provided.
    • getConfirmationMethod

      public PaymentIntentCreateParams.ConfirmationMethod getConfirmationMethod()
    • 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. This parameter is intended for simpler integrations that do not handle customer actions, like 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 to be used for this payment. This parameter can only be used with confirm=true.
    • getMandateData

      public PaymentIntentCreateParams.MandateData 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 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 with confirm=true.
    • getOnBehalfOf

      public String getOnBehalfOf()
      The Stripe account ID for which these funds are intended. For details, see the PaymentIntents 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 neither the payment_method parameter nor the source parameter are provided with confirm=true, source will be automatically populated with customer.default_source to improve the migration experience for users of the Charges API. We recommend that you explicitly provide the payment_method going forward.

    • 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 (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

      public PaymentIntentCreateParams.RadarOptions getRadarOptions()
      Options to configure Radar. See Radar Session for more information.
    • getReceiptEmail

      public String getReceiptEmail()
      Email address that the receipt for the resulting payment will be sent to. If receipt_email is specified for a payment in live mode, a receipt will be sent 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 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

      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. Maximum 22 characters for the concatenated descriptor.
    • getTransferData

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

      public String getTransferGroup()
      A string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected accounts for details.
    • 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.