Package com.stripe.param

Class PaymentLinkUpdateParams.PaymentIntentData.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • build

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

    • setDescription

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

    • setDescription

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

    • putExtraParam

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

    • putAllExtraParam

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

    • putMetadata

      public PaymentLinkUpdateParams.PaymentIntentData.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 PaymentLinkUpdateParams.PaymentIntentData.metadata for the field documentation.

    • putAllMetadata

      public PaymentLinkUpdateParams.PaymentIntentData.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 PaymentLinkUpdateParams.PaymentIntentData.metadata for the field documentation.

    • setMetadata

      public PaymentLinkUpdateParams.PaymentIntentData.Builder setMetadata(EmptyParam metadata)
      Set of key-value pairs that will declaratively set metadata on Payment Intents generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values.

    • setMetadata

      public PaymentLinkUpdateParams.PaymentIntentData.Builder setMetadata(Map<String,String> metadata)
      Set of key-value pairs that will declaratively set metadata on Payment Intents generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values.

    • setSetupFutureUsage

      public PaymentLinkUpdateParams.PaymentIntentData.Builder setSetupFutureUsage(PaymentLinkUpdateParams.PaymentIntentData.SetupFutureUsage setupFutureUsage)
      Indicates that you intend to make future payments with the payment method collected by this Checkout Session.

      When setting this to on_session, Checkout will show a notice to the customer that their payment details will be saved.

      When setting this to off_session, Checkout will show a notice to the customer that their payment details will be saved and used for future payments.

      If a Customer has been provided or Checkout creates a new Customer,Checkout will attach the payment method to the Customer.

      If Checkout does not create a Customer, the payment method is not attached to a Customer. To reuse the payment method, you can retrieve it from the Checkout Session's PaymentIntent.

      When processing card payments, Checkout also uses setup_future_usage to dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.

    • setSetupFutureUsage

      public PaymentLinkUpdateParams.PaymentIntentData.Builder setSetupFutureUsage(EmptyParam setupFutureUsage)
      Indicates that you intend to make future payments with the payment method collected by this Checkout Session.

      When setting this to on_session, Checkout will show a notice to the customer that their payment details will be saved.

      When setting this to off_session, Checkout will show a notice to the customer that their payment details will be saved and used for future payments.

      If a Customer has been provided or Checkout creates a new Customer,Checkout will attach the payment method to the Customer.

      If Checkout does not create a Customer, the payment method is not attached to a Customer. To reuse the payment method, you can retrieve it from the Checkout Session's PaymentIntent.

      When processing card payments, Checkout also uses setup_future_usage to dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.

    • setStatementDescriptor

      public PaymentLinkUpdateParams.PaymentIntentData.Builder setStatementDescriptor(String statementDescriptor)
      Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see the Statement Descriptor docs.

      Setting this value for a card charge returns an error. For card charges, set the statement_descriptor_suffix instead.

    • setStatementDescriptor

      public PaymentLinkUpdateParams.PaymentIntentData.Builder setStatementDescriptor(EmptyParam statementDescriptor)
      Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see the Statement Descriptor docs.

      Setting this value for a card charge returns an error. For card charges, set the statement_descriptor_suffix instead.

    • setStatementDescriptorSuffix

      public PaymentLinkUpdateParams.PaymentIntentData.Builder setStatementDescriptorSuffix(String statementDescriptorSuffix)
      Provides information about a card charge. Concatenated to the account's statement descriptor prefix to form the complete statement descriptor that appears on the customer's statement.

    • setStatementDescriptorSuffix

      public PaymentLinkUpdateParams.PaymentIntentData.Builder setStatementDescriptorSuffix(EmptyParam statementDescriptorSuffix)
      Provides information about a card charge. Concatenated to the account's statement descriptor prefix to form the complete statement descriptor that appears on the customer's statement.

    • setTransferGroup

      public PaymentLinkUpdateParams.PaymentIntentData.Builder setTransferGroup(String transferGroup)
      A string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected accounts for details.

    • setTransferGroup

      public PaymentLinkUpdateParams.PaymentIntentData.Builder setTransferGroup(EmptyParam transferGroup)
      A string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected accounts for details.