CapturePaymentIntent
To capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.
Stored Procedure Specific Information
Stripe allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison.
For example:
EXECUTE CapturePaymentIntent PaymentIntentId = 'pi_3Oe4fu2eZvKYlo2C1AtF19xU', AmountToCapture = 150, StatementDescriptor = 'test', Metadata = '{\"name\":\"test1\", \"age\":20}'
Input
| Name | Type | Description |
| PaymentIntentId | String | The PaymentIntent Id. |
| AmountToCapture | String | The amount to capture from the PaymentIntent, which must be less than or equal to the original amount. |
| Metadata | String | Set of key-value pairs that you can attach to an object. |
| ApplicationFeeAmount | String | 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. |
| FinalCapture | String | 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. |
| StatementDescriptor | String | For card charges, use statement_descriptor_suffix. |
| StatementDescriptorSuffix | String | Provides information about a card payment that customers see on their statements. |
| TransferData | String | The parameters that you can use to automatically create a transfer after the payment is captured. |
Result Set Columns
| Name | Type | Description |
| Success | String | Execution status of the stored procedure |