Package com.stripe.param

Class PaymentIntentConfirmParams.Builder

java.lang.Object
com.stripe.param.PaymentIntentConfirmParams.Builder
Enclosing class:
PaymentIntentConfirmParams
public static class PaymentIntentConfirmParams.Builder extends Object

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • build

      public PaymentIntentConfirmParams build()
      Finalize and obtain parameter instance from this builder.

    • setCaptureMethod

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

    • setConfirmationToken

      public PaymentIntentConfirmParams.Builder setConfirmationToken(String confirmationToken)
      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.

    • setErrorOnRequiresAction

      public PaymentIntentConfirmParams.Builder setErrorOnRequiresAction(Boolean errorOnRequiresAction)
      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.

    • addExpand

      public PaymentIntentConfirmParams.Builder addExpand(String element)
      Add an element to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See PaymentIntentConfirmParams.expand for the field documentation.

    • addAllExpand

      public PaymentIntentConfirmParams.Builder addAllExpand(List<String> elements)
      Add all elements to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See PaymentIntentConfirmParams.expand for the field documentation.

    • putExtraParam

      public PaymentIntentConfirmParams.Builder putExtraParam(String key, Object value)
      Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See PaymentIntentConfirmParams.extraParams for the field documentation.

    • putAllExtraParam

      public PaymentIntentConfirmParams.Builder putAllExtraParam(Map<String,Object> map)
      Add all map key/value pairs to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See PaymentIntentConfirmParams.extraParams for the field documentation.

    • setMandate

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

    • setMandateData

      public PaymentIntentConfirmParams.Builder setMandateData(PaymentIntentConfirmParams.MandateData mandateData)

    • setMandateData

      public PaymentIntentConfirmParams.Builder setMandateData(EmptyParam mandateData)

    • setOffSession

      public PaymentIntentConfirmParams.Builder setOffSession(Boolean offSession)
      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.

    • setOffSession

      public PaymentIntentConfirmParams.Builder setOffSession(PaymentIntentConfirmParams.OffSession offSession)
      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.

    • setPaymentMethod

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

    • setPaymentMethodData

      public PaymentIntentConfirmParams.Builder setPaymentMethodData(PaymentIntentConfirmParams.PaymentMethodData paymentMethodData)
      If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear in the payment_method property on the PaymentIntent.

    • setPaymentMethodOptions

      public PaymentIntentConfirmParams.Builder setPaymentMethodOptions(PaymentIntentConfirmParams.PaymentMethodOptions paymentMethodOptions)
      Payment method-specific configuration for this PaymentIntent.

    • addPaymentMethodType

      public PaymentIntentConfirmParams.Builder addPaymentMethodType(String element)
      Add an element to `paymentMethodTypes` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See PaymentIntentConfirmParams.paymentMethodTypes for the field documentation.

    • addAllPaymentMethodType

      public PaymentIntentConfirmParams.Builder addAllPaymentMethodType(List<String> elements)
      Add all elements to `paymentMethodTypes` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See PaymentIntentConfirmParams.paymentMethodTypes for the field documentation.

    • setRadarOptions

      public PaymentIntentConfirmParams.Builder setRadarOptions(PaymentIntentConfirmParams.RadarOptions radarOptions)
      Options to configure Radar. Learn more about Radar Sessions.

    • setReceiptEmail

      public PaymentIntentConfirmParams.Builder setReceiptEmail(String receiptEmail)
      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.

    • setReceiptEmail

      public PaymentIntentConfirmParams.Builder setReceiptEmail(EmptyParam receiptEmail)
      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.

    • setReturnUrl

      public PaymentIntentConfirmParams.Builder setReturnUrl(String returnUrl)
      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.

    • setSetupFutureUsage

      public PaymentIntentConfirmParams.Builder setSetupFutureUsage(PaymentIntentConfirmParams.SetupFutureUsage setupFutureUsage)
      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.

    • setSetupFutureUsage

      public PaymentIntentConfirmParams.Builder setSetupFutureUsage(EmptyParam setupFutureUsage)
      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.

    • setShipping

      public PaymentIntentConfirmParams.Builder setShipping(PaymentIntentConfirmParams.Shipping shipping)
      Shipping information for this PaymentIntent.

    • setShipping

      public PaymentIntentConfirmParams.Builder setShipping(EmptyParam shipping)
      Shipping information for this PaymentIntent.

    • setUseStripeSdk

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