Package com.stripe.param

Class PaymentIntentCaptureParams.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • build

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

    • setAmountToCapture

      public PaymentIntentCaptureParams.Builder setAmountToCapture(Long amountToCapture)
      The amount to capture from the PaymentIntent, which must be less than or equal to the original amount. Any additional amount is automatically refunded. Defaults to the full amount_capturable if it's not provided.

    • setApplicationFeeAmount

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

    • addExpand

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

    • addAllExpand

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

    • putExtraParam

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

    • putAllExtraParam

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

    • setFinalCapture

      public PaymentIntentCaptureParams.Builder setFinalCapture(Boolean finalCapture)
      Defaults to true. When capturing a PaymentIntent, setting final_capture to false notifies Stripe to not release the remaining uncaptured funds to make sure that they're captured in future requests. You can only use this setting when multicapture is available for PaymentIntents.

    • putMetadata

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

    • putAllMetadata

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

    • setMetadata

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

    • setStatementDescriptor

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

    • setStatementDescriptorSuffix

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

    • setTransferData

      public PaymentIntentCaptureParams.Builder setTransferData(PaymentIntentCaptureParams.TransferData transferData)
      The parameters that you can use to automatically create a transfer after the payment is captured. Learn more about the use case for connected accounts.