Package com.stripe.param

Class PaymentIntentConfirmParams.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • setErrorOnRequiresAction

        public PaymentIntentConfirmParams.Builder setErrorOnRequiresAction​(java.lang.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.

      • addAllExpand

        public PaymentIntentConfirmParams.Builder addAllExpand​(java.util.List<java.lang.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​(java.lang.String key,
                                                        java.lang.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​(java.util.Map<java.lang.String,​java.lang.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.

      • setOffSession

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

      • setReceiptEmail

        public PaymentIntentConfirmParams.Builder setReceiptEmail​(java.lang.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​(java.lang.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.

        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.

        If setup_future_usage is already set and you are performing a request using a publishable key, you may 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.

        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.

        If setup_future_usage is already set and you are performing a request using a publishable key, you may only update the value from on_session to off_session.

      • setUseStripeSdk

        public PaymentIntentConfirmParams.Builder setUseStripeSdk​(java.lang.Boolean useStripeSdk)
        Set to true only when using manual confirmation and the iOS or Android SDKs to handle additional authentication steps.