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.
This means:
- The balance _ transaction field on the Charge object might be null immediately after confirmation.
- If you expand balance _ transaction or latest _ charge. balance _ transaction , it might not be available in the response.
- You can listen for the charge. updated event to know when the balance transaction becomes available.
Your integration must handle the possibility that the balance transaction might not be immediately available.
Opt in to asynchronous capture
To upgrade your existing integration and add support for asynchronous capture, use automatic_async as the capture method when creating a PaymentIntent.
Specifying the capture_method=automatic_async parameter is optional because Stripe enables its functionality by default in the latest version of the API.
Command Line
Select a language
curl
Stripe CLI
Ruby
Python
PHP
Node.js
Java
Go
.NET
No results
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)
Select a language
API version 2022-11-15 or later
API version 2022-08-01 or earlier
No results
# PaymentIntent Object
{
"id": "pi_123",
"object": "payment_intent",
"capture_method": "automatic_async",
"status": "succeeded",
"latest_charge": "ch_**" # if expanded, this is the Modified Charge object above
}
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,
...
}
}
