Capture a PaymentIntent 

Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.

Uncaptured PaymentIntents are cancelled a set number of days (7 by default) after their creation.

Learn more about separate authorization and capture.

Parameters

• amount_to_captureinteger

  The amount to capture from the PaymentIntent, which must be less than or equal to the original amount. Defaults to the full amount_capturable if it’s not provided.

• metadatamap

  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.

More parameters

Collapse all

• application_fee_amountintegerConnect only

  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 amount captured. For more information, see the PaymentIntents use case for connected accounts.

• final_captureboolean

  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.

• statement_descriptorstring

  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.

• statement_descriptor_suffixstring

  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.

• transfer_datamapConnect only

  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.

  Hide child parameters

  • transfer_data.amountinteger

    The amount that will be transferred automatically when a charge succeeds.