Package com.stripe.param

Class PaymentIntentUpdateParams.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • build

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

    • setAmount

      public PaymentIntentUpdateParams.Builder setAmount(Long amount)
      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).

    • setApplicationFeeAmount

      public PaymentIntentUpdateParams.Builder setApplicationFeeAmount(Long applicationFeeAmount)
      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.

    • setApplicationFeeAmount

      public PaymentIntentUpdateParams.Builder setApplicationFeeAmount(EmptyParam applicationFeeAmount)
      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.

    • setCaptureMethod

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

    • setCurrency

      public PaymentIntentUpdateParams.Builder setCurrency(String currency)
      Three-letter ISO currency code, in lowercase. Must be a supported currency.

    • setCurrency

      public PaymentIntentUpdateParams.Builder setCurrency(EmptyParam currency)
      Three-letter ISO currency code, in lowercase. Must be a supported currency.

    • setCustomer

      public PaymentIntentUpdateParams.Builder setCustomer(String customer)
      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.

    • setCustomer

      public PaymentIntentUpdateParams.Builder setCustomer(EmptyParam customer)
      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.

    • setDescription

      public PaymentIntentUpdateParams.Builder setDescription(String description)
      An arbitrary string attached to the object. Often useful for displaying to users.

    • setDescription

      public PaymentIntentUpdateParams.Builder setDescription(EmptyParam description)
      An arbitrary string attached to the object. Often useful for displaying to users.

    • addExpand

      public PaymentIntentUpdateParams.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 PaymentIntentUpdateParams.expand for the field documentation.

    • addAllExpand

      public PaymentIntentUpdateParams.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 PaymentIntentUpdateParams.expand for the field documentation.

    • putExtraParam

      public PaymentIntentUpdateParams.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 PaymentIntentUpdateParams.extraParams for the field documentation.

    • putAllExtraParam

      public PaymentIntentUpdateParams.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 PaymentIntentUpdateParams.extraParams for the field documentation.

    • setMandateData

      public PaymentIntentUpdateParams.Builder setMandateData(PaymentIntentUpdateParams.MandateDataPublishableKey mandateData)
      This hash contains details about the Mandate to create.

    • putMetadata

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

    • putAllMetadata

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

    • setMetadata

      public PaymentIntentUpdateParams.Builder setMetadata(EmptyParam metadata)
      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.

    • setMetadata

      public PaymentIntentUpdateParams.Builder setMetadata(Map<String,String> metadata)
      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.

    • setPaymentDetails

      public PaymentIntentUpdateParams.Builder setPaymentDetails(PaymentIntentUpdateParams.PaymentDetails paymentDetails)
      Provides industry-specific information about the charge.

    • setPaymentDetails

      public PaymentIntentUpdateParams.Builder setPaymentDetails(EmptyParam paymentDetails)
      Provides industry-specific information about the charge.

    • setPaymentMethod

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

    • setPaymentMethod

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

    • setPaymentMethodConfiguration

      public PaymentIntentUpdateParams.Builder setPaymentMethodConfiguration(String paymentMethodConfiguration)
      The ID of the payment method configuration to use with this PaymentIntent.

    • setPaymentMethodConfiguration

      public PaymentIntentUpdateParams.Builder setPaymentMethodConfiguration(EmptyParam paymentMethodConfiguration)
      The ID of the payment method configuration to use with this PaymentIntent.

    • setPaymentMethodData

      public PaymentIntentUpdateParams.Builder setPaymentMethodData(PaymentIntentUpdateParams.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 PaymentIntentUpdateParams.Builder setPaymentMethodOptions(PaymentIntentUpdateParams.PaymentMethodOptions paymentMethodOptions)
      Payment-method-specific configuration for this PaymentIntent.

    • addPaymentMethodType

      public PaymentIntentUpdateParams.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 PaymentIntentUpdateParams.paymentMethodTypes for the field documentation.

    • addAllPaymentMethodType

      public PaymentIntentUpdateParams.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 PaymentIntentUpdateParams.paymentMethodTypes for the field documentation.

    • setReceiptEmail

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

    • setSetupFutureUsage

      public PaymentIntentUpdateParams.Builder setSetupFutureUsage(PaymentIntentUpdateParams.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 PaymentIntentUpdateParams.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.

    • setShipping

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

    • setShipping

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

    • setStatementDescriptor

      public PaymentIntentUpdateParams.Builder setStatementDescriptor(String statementDescriptor)
      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.

    • setStatementDescriptor

      public PaymentIntentUpdateParams.Builder setStatementDescriptor(EmptyParam statementDescriptor)
      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.

    • setStatementDescriptorSuffix

      public PaymentIntentUpdateParams.Builder setStatementDescriptorSuffix(String statementDescriptorSuffix)
      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.

    • setStatementDescriptorSuffix

      public PaymentIntentUpdateParams.Builder setStatementDescriptorSuffix(EmptyParam statementDescriptorSuffix)
      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.

    • setTransferData

      public PaymentIntentUpdateParams.Builder setTransferData(PaymentIntentUpdateParams.TransferData transferData)
      The parameters used to automatically create a Transfer when the payment succeeds. For more information, see the PaymentIntents use case for connected accounts.

    • setTransferGroup

      public PaymentIntentUpdateParams.Builder setTransferGroup(String transferGroup)
      A string that identifies the resulting payment as part of a group. transfer_group may only be provided if it has not been set. See the PaymentIntents use case for connected accounts for details.

    • setTransferGroup

      public PaymentIntentUpdateParams.Builder setTransferGroup(EmptyParam transferGroup)
      A string that identifies the resulting payment as part of a group. transfer_group may only be provided if it has not been set. See the PaymentIntents use case for connected accounts for details.