Package com.stripe.param

Class PaymentIntentCaptureParams

java.lang.Object
com.stripe.net.ApiRequestParams
com.stripe.param.PaymentIntentCaptureParams
public class PaymentIntentCaptureParams extends ApiRequestParams

  • Method Details

    • builder

      public static PaymentIntentCaptureParams.Builder builder()

    • getAmountToCapture

      public Long getAmountToCapture()
      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.

    • getApplicationFeeAmount

      public Long getApplicationFeeAmount()
      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.

    • getExpand

      public List<String> getExpand()
      Specifies which fields in the response should be expanded.

    • getExtraParams

      public Map<String,Object> getExtraParams()
      Map of extra parameters for custom features not available in this client library. The content in this map is not serialized under this field's @SerializedName value. Instead, each key/value pair is serialized as if the key is a root-level field (serialized) name in this param object. Effectively, this map is flattened to its parent instance.

    • getFinalCapture

      public Boolean getFinalCapture()
      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.

    • getMetadata

      public Object getMetadata()
      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.

    • getStatementDescriptor

      public String getStatementDescriptor()
      For card charges, use statement_descriptor_suffix. Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long.

    • getStatementDescriptorSuffix

      public String getStatementDescriptorSuffix()
      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. The concatenated descriptor must be 1-22 characters long.

    • getTransferData

      public PaymentIntentCaptureParams.TransferData getTransferData()
      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.