Asynchronous capture
Use Asynchronous Capture to enable faster PaymentIntent confirmations.
Asynchronous capture reduces the latency of PaymentIntent confirmations by making the capture operation take place in the background. After making the capture request, your integration receives a successful response, and Stripe completes payment capture in the backend. To use these faster PaymentIntent captures, set the capture_
parameter when confirming a PaymentIntent.
Opt in to asynchronous capture
To upgrade your existing integration and add support for asynchronous capture, use automatic_
as the capture method when creating a PaymentIntent. Specifying the capture_
parameter is optional because Stripe enables its functionality by default in the latest version of the API.
You might need to make additional changes when you opt into asynchronous capture since the API response and some webhooks have different behavior than with other capture methods.
For all payments, the balance_transaction is null
on the following objects. For Connect payments, the transfer and application_fee are also null
on the following objects:
- attached Charge object of the API response
- charge.succeeded webhook
- payment_intent.succeeded webhook
Modified Charge object on the charge.succeeded webhook:
# Charge Object { "id": "ch_123", "object": "charge", "amount_captured": 1000, # the capture has happened "application_fee_amount": 100, "captured": true, "balance_transaction": "txn_123", # applicable to all charges. "transfer": "tr_123", # applicable to destination charge only. "application_fee": "fee_123", # applicable to destination charge only. "balance_transaction": null, # object might not be created yet, might be shown as nil. "transfer": null, # object might not be created yet, might be shown as nil. "application_fee": null, # object might not be created yet, might be shown as nil. ... }
Modified API response and payment_intent.succeeded webhook: (different based on API version)
Listen to webhooks to get notified when additional data is available
Warning
Our SLA for the charge.updated webhook is 1 hour after the successful PaymentIntent confirmation.
You can listen to webhooks to check the status of objects that are initially null
when using asynchronous capture.
- To get the balance_transaction, subscribe to the charge.updated webhook event.
- To get the application_fee, subscribe to the application_fee.created webhook event.
- To get the transfer, subscribe to the transfer.created webhook events.
Webhooks for Asynchronous Capture
# charge.updated events { "data": { "id": "ch_123", "object": "charge", "amount": 100, "balance_transaction": "txn_123", # applicable to all charges. "transfer": "tr_123", # applicable to destination charge only. "application_fee": "fee_123", # applicable to destination charge only. ... }, previous_attributes: { "balance_transaction": null, # applicable to all charges. "transfer": null, # applicable to destination charge only. "application_fee": null, # applicable to destination charge only. } }
# transfer.created events { "data": { "id": "tr_123", "object": "transfer", "amount": 1000, ... } }
# application_fee.created events { "data": { "id": "fee_123", "object": "application_fee", "amount": 100, ... } }