Package com.stripe.param

Class PaymentIntentConfirmParams

java.lang.Object
com.stripe.net.ApiRequestParams
com.stripe.param.PaymentIntentConfirmParams
public class PaymentIntentConfirmParams extends ApiRequestParams

  • Method Details

    • builder

      public static PaymentIntentConfirmParams.Builder builder()

    • getAmountDetails

      public Object getAmountDetails()
      Provides industry-specific information about the amount.

    • getApplicationFeeAmount

      public Object 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 amount captured. For more information, see the PaymentIntents use case for connected accounts.

    • getCaptureMethod

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

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

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

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

    • getFxQuote

      public String getFxQuote()
      The FX rate in the quote is validated and used to convert the presentment amount to the settlement amount.

    • getHooks

      public PaymentIntentConfirmParams.Hooks getHooks()
      Automations to be run during the PaymentIntent lifecycle.

    • getMandate

      public String getMandate()
      ID of the mandate that's used for this payment.

    • getMandateData

      public Object getMandateData()

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

    • getPaymentDetails

      public Object getPaymentDetails()
      Provides industry-specific information about the charge.

    • getPaymentMethod

      public String getPaymentMethod()
      ID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent. If the payment method is attached to a Customer, it must match the customer that is set on 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.

    • getPaymentMethodTypes

      public List<String> getPaymentMethodTypes()
      The list of payment method types (for example, a card) that this PaymentIntent can use. Use automatic_payment_methods to manage payment methods from the Stripe Dashboard. A list of valid payment method types can be found here.

    • getRadarOptions

      public PaymentIntentConfirmParams.RadarOptions getRadarOptions()
      Options to configure Radar. Learn more about Radar Sessions.

    • getReceiptEmail

      public Object 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 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.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn't a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

      If you've already set setup_future_usage and you're performing a request using a publishable key, you can only update the value from on_session to off_session.

    • getShipping

      public Object getShipping()
      Shipping information for this PaymentIntent.

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

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object