/v1/payment_intents/{intent}/captureCapture 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.
| Name | Description |
|---|---|
| intent* |
| Field | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| amount_details | object | Provides industry-specific information about the amount. 5 nested fields
| ||||||||||||||||||
| amount_to_capture | integer | The amount to capture from the PaymentIntent, which must be less than or equal to the original amount. Defaults to the full | ||||||||||||||||||
| application_fee_amount | integer | 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. | ||||||||||||||||||
| expand | array<string> | Specifies which fields in the response should be expanded. | ||||||||||||||||||
| final_capture | boolean | Defaults to | ||||||||||||||||||
| hooks | object | Automations to be run during the PaymentIntent lifecycle 1 nested field
| ||||||||||||||||||
| metadata | object | string | 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 | ||||||||||||||||||
| payment_details | object | string | Provides industry-specific information about the charge. | ||||||||||||||||||
| statement_descriptor | string | 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_suffix | string | 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_data | object | 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. 1 nested field
|
| Field | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| amount | integer | 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). | |||||||||
| amount_capturable | integer | Amount that can be captured from this PaymentIntent. | |||||||||
| amount_details | payment_flows_amount_details | payment_flows_amount_details_client | ||||||||||
| amount_received | integer | Amount that this PaymentIntent collects. | |||||||||
| application | string | application | ID of the Connect application that created the PaymentIntent. | |||||||||
| application_fee_amount | integer | 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. | |||||||||
| automatic_payment_methods | payment_flows_automatic_payment_methods_payment_intent | Settings to configure compatible payment methods from the Stripe Dashboard | |||||||||
| canceled_at | integer (unix-time) | Populated when | |||||||||
| cancellation_reason | string | Reason for cancellation of this PaymentIntent, either user-provided ( | |||||||||
| capture_method | string | Controls when the funds will be captured from the customer's account. | |||||||||
| client_secret | string | The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key.
The client secret can be used to complete a payment from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.
Refer to our docs to accept a payment and learn about how | |||||||||
| confirmation_method | string | Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment. | |||||||||
| created* | integer (unix-time) | Time at which the object was created. Measured in seconds since the Unix epoch. | |||||||||
| currency | string (currency) | Three-letter ISO currency code, in lowercase. Must be a supported currency. | |||||||||
| customer | string | customer | deleted_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 setup_future_usage is set and this PaymentIntent's payment method is not | |||||||||
| customer_account | string | ID of the Account representing the customer that this PaymentIntent belongs to, if one exists.
Payment methods attached to other Accounts cannot be used with this PaymentIntent.
If setup_future_usage is set and this PaymentIntent's payment method is not | |||||||||
| description | string | An arbitrary string attached to the object. Often useful for displaying to users. | |||||||||
| excluded_payment_method_types | array<string> | The list of payment method types to exclude from use with this payment. | |||||||||
| hooks | payment_flows_payment_intent_async_workflows | 1 nested field
| |||||||||
| id* | string | Unique identifier for the object. | |||||||||
| last_payment_error | api_errors | The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason. | |||||||||
| latest_charge | string | charge | ID of the latest Charge object created by this PaymentIntent. This property is | |||||||||
| livemode* | boolean | If the object exists in live mode, the value is | |||||||||
| managed_payments | smor_resource_managed_payments | Settings for Managed Payments. | |||||||||
| metadata | object | 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. Learn more about storing information in metadata. | |||||||||
| next_action | payment_intent_next_action | If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source. | |||||||||
| object* | string | String representing the object's type. Objects of the same type share the same value. | |||||||||
| on_behalf_of | string | account | You can specify the settlement merchant as the
connected account using the | |||||||||
| payment_details | payment_flows_payment_details | 2 nested fields
| |||||||||
| payment_method | string | payment_method | ID of the payment method used in this PaymentIntent. |